POST classroomAPI/Form/submitForm

Request Information

URI Parameters

None.

Body Parameters

Name	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": "6684f94f-dba5-4216-8f98-f07b9e65694e",
  "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": "fb48d84d-91b5-49b6-8aa2-0c0eca6141f0",
      "FormValue": "sample string 2"
    },
    {
      "FormKey": "fb48d84d-91b5-49b6-8aa2-0c0eca6141f0",
      "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>6684f94f-dba5-4216-8f98-f07b9e65694e</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>fb48d84d-91b5-49b6-8aa2-0c0eca6141f0</FormKey>
      <FormValue>sample string 2</FormValue>
    </FormValue>
    <FormValue>
      <FormKey>fb48d84d-91b5-49b6-8aa2-0c0eca6141f0</FormKey>
      <FormValue>sample string 2</FormValue>
    </FormValue>
  </FormValues>
</FormClientResponse>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

FormSubmitConfirmation

Name	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": "40043d8e-7b3d-43b0-9f82-49ea3a5593cc",
    "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": "162c5e0e-4ebb-4d55-9d3e-ace3ebfa8fc4",
        "FormValue": "sample string 2"
      },
      {
        "FormKey": "162c5e0e-4ebb-4d55-9d3e-ace3ebfa8fc4",
        "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>40043d8e-7b3d-43b0-9f82-49ea3a5593cc</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>162c5e0e-4ebb-4d55-9d3e-ace3ebfa8fc4</FormKey>
        <FormValue>sample string 2</FormValue>
      </FormValue>
      <FormValue>
        <FormKey>162c5e0e-4ebb-4d55-9d3e-ace3ebfa8fc4</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>