FetchForms
| Full path | FetchForms?ClientID={ClientID} |
| HTTP Verb | GET |
| Description | This endpoint expects an HTTP GET request with a ClientID. Requires authentication with an OAuth2 token |
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientID |
The unique client id |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
a list of forms available for this ClientID
Collection of Form| Name | Description | Type | Additional information |
|---|---|---|---|
| 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:
[
{
"Name": "sample string 1",
"Language": "sample string 2",
"Code": "sample string 3"
},
{
"Name": "sample string 1",
"Language": "sample string 2",
"Code": "sample string 3"
}
]
application/xml, text/xml
Sample:
<ArrayOfForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DocFlowImportServiceInportal.Models">
<Form>
<Code>sample string 3</Code>
<Language>sample string 2</Language>
<Name>sample string 1</Name>
</Form>
<Form>
<Code>sample string 3</Code>
<Language>sample string 2</Language>
<Name>sample string 1</Name>
</Form>
</ArrayOfForm>