Form
| Full path | Form |
| HTTP Verb | POST |
| Description | This endpoint expects an HTTP POST request with the relevant information in Json format. It creates a new webform with the given specifications. Requires authentication with an OAuth2 token |
Request Information
URI Parameters
None.
Body Parameters
FormImportModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Options |
Option parameters |
Collection of FormOptionsImportModel |
None. |
| Language |
Required field that contains the language is alpha 2 format (e.g. FR, EN, NL, DE) |
string |
None. |
| SurveyJsJson |
Required field that contains a Survey JS form in JSON format |
Collection of Object |
None. |
| FormId |
Required field with an ID that will be used in the /CreateDossier call |
string |
None. |
| ClientId |
Required field with the client ID |
string |
None. |
| custom_files | Collection of CustomFile |
None. |
Request Formats
application/json, text/json
Sample:
{
"Options": [
{
"Key": "sample string 1",
"Value": {}
},
{
"Key": "sample string 1",
"Value": {}
}
],
"Language": "sample string 1",
"SurveyJsJson": null,
"FormId": "sample string 2",
"ClientId": "sample string 3",
"custom_files": [
{
"type": "sample string 1",
"content_type": "sample string 2",
"content": "sample string 3"
},
{
"type": "sample string 1",
"content_type": "sample string 2",
"content": "sample string 3"
}
]
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
"success" or an error
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |