POST classroomAPI/Form/submitForm
Request Information
URI Parameters
None.
Body Parameters
FormClientResponseName | Description | Type | Additional information |
---|---|---|---|
FormResponseID | globally unique identifier |
None. |
|
FormID_FK | globally unique identifier |
None. |
|
FormSubmittedBy | FormUser |
None. |
|
FormValues | Collection of FormValue |
None. |
Request Formats
application/json, text/json
Sample:
{ "FormResponseID": "00000000-0000-0000-0000-000000000000", "FormID_FK": "cf75d0e0-2f4b-4d64-973f-eb23c4229a7c", "FormSubmittedBy": { "Title": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "Company": "sample string 4", "Email": "sample string 5", "TelephoneCountryCode": "sample string 6", "Telephone": "sample string 7" }, "FormValues": [ { "FormKey": "f79478f4-bd3c-4b05-9832-ad18efa145a2", "FormValue": "sample string 2" }, { "FormKey": "f79478f4-bd3c-4b05-9832-ad18efa145a2", "FormValue": "sample string 2" } ] }
application/xml, text/xml
Sample:
<FormClientResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL"> <FormID_FK>cf75d0e0-2f4b-4d64-973f-eb23c4229a7c</FormID_FK> <FormSubmittedBy> <Company>sample string 4</Company> <Email>sample string 5</Email> <FirstName>sample string 2</FirstName> <LastName>sample string 3</LastName> <Telephone>sample string 7</Telephone> <TelephoneCountryCode>sample string 6</TelephoneCountryCode> <Title>sample string 1</Title> </FormSubmittedBy> <FormValues> <FormValue> <FormKey>f79478f4-bd3c-4b05-9832-ad18efa145a2</FormKey> <FormValue>sample string 2</FormValue> </FormValue> <FormValue> <FormKey>f79478f4-bd3c-4b05-9832-ad18efa145a2</FormKey> <FormValue>sample string 2</FormValue> </FormValue> </FormValues> </FormClientResponse>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
FormSubmitConfirmationName | Description | Type | Additional information |
---|---|---|---|
success | boolean |
None. |
|
StatusCode | integer |
None. |
|
ErrorString | string |
None. |
|
ResponseString | string |
None. |
|
ClientResponse | FormClientResponse |
None. |
|
UsersSaved | integer |
None. |
|
FormResponsesSaved | integer |
None. |
|
AdditionalFormValuesSaved | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "success": true, "StatusCode": 2, "ErrorString": "sample string 3", "ResponseString": "sample string 4", "ClientResponse": { "FormResponseID": "00000000-0000-0000-0000-000000000000", "FormID_FK": "f478c739-3793-4428-a7a7-fe12c9ded796", "FormSubmittedBy": { "Title": "sample string 1", "FirstName": "sample string 2", "LastName": "sample string 3", "Company": "sample string 4", "Email": "sample string 5", "TelephoneCountryCode": "sample string 6", "Telephone": "sample string 7" }, "FormValues": [ { "FormKey": "1cb4ec66-3941-44d5-9152-5419a1baffd5", "FormValue": "sample string 2" }, { "FormKey": "1cb4ec66-3941-44d5-9152-5419a1baffd5", "FormValue": "sample string 2" } ] }, "UsersSaved": 5, "FormResponsesSaved": 6, "AdditionalFormValuesSaved": 7 }
application/xml, text/xml
Sample:
<FormSubmitConfirmation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL"> <AdditionalFormValuesSaved>7</AdditionalFormValuesSaved> <ClientResponse> <FormID_FK>f478c739-3793-4428-a7a7-fe12c9ded796</FormID_FK> <FormSubmittedBy> <Company>sample string 4</Company> <Email>sample string 5</Email> <FirstName>sample string 2</FirstName> <LastName>sample string 3</LastName> <Telephone>sample string 7</Telephone> <TelephoneCountryCode>sample string 6</TelephoneCountryCode> <Title>sample string 1</Title> </FormSubmittedBy> <FormValues> <FormValue> <FormKey>1cb4ec66-3941-44d5-9152-5419a1baffd5</FormKey> <FormValue>sample string 2</FormValue> </FormValue> <FormValue> <FormKey>1cb4ec66-3941-44d5-9152-5419a1baffd5</FormKey> <FormValue>sample string 2</FormValue> </FormValue> </FormValues> </ClientResponse> <ErrorString>sample string 3</ErrorString> <FormResponsesSaved>6</FormResponsesSaved> <ResponseString>sample string 4</ResponseString> <StatusCode>2</StatusCode> <UsersSaved>5</UsersSaved> <success>true</success> </FormSubmitConfirmation>