FetchForm

Full path FetchForm?ClientID={ClientID}&FormID={FormID}&Language={Language}
HTTP Verb GET
Description This endpoint expects an HTTP GET request.
Requires authentication with an OAuth2 token

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ClientID

The unique client id

 string

Required
FormID

The form id

 string

Required
Language

The language

 string

Required

Body Parameters

None.

Response Information

Resource Description

a list of forms available for this ClientID

Formdefinition
NameDescriptionTypeAdditional information
Schema

The definition of the form

 Object

None.
Options

The options of the form

 Object

None.
Name

The name of the form

 string

None.
Language

The language of a form in ISO2 (e.g. EN, FR, NL)

 string

None.
Code

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Schema": {},
  "Options": {},
  "Name": "sample string 3",
  "Language": "sample string 4",
  "Code": "sample string 5"
}

application/xml, text/xml

Sample: 
<Formdefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DocFlowImportServiceInportal.Models">
  <Code>sample string 5</Code>
  <Language>sample string 4</Language>
  <Name>sample string 3</Name>
  <Options />
  <Schema />
</Formdefinition>