POST api/Sync/DeclareOnBoardCallState?sessionId={sessionId}

Documentation for 'DeclareOnBoardCallState'.

Request Information

Parameters

Name	Description	Additional information
sessionId	Documentation for 'sessionId'.	Define this parameter in the request URI.
callState	Documentation for 'callState'.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "Application": "sample string 1",
  "DeviceIdentifier": "sample string 2",
  "CallStateDeclarations": [
    {
      "CallId": 1,
      "Status": 0,
      "QuestionnaireId": 2
    },
    {
      "CallId": 1,
      "Status": 0,
      "QuestionnaireId": 2
    },
    {
      "CallId": 1,
      "Status": 0,
      "QuestionnaireId": 2
    }
  ]
}

application/xml, text/xml

Sample:

<OnBoardCallState xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fieldology.Platform.Api.DataCapture.Calls">
  <Application>sample string 1</Application>
  <CallStateDeclarations>
    <OnBoardCallStateDeclaration>
      <CallId>1</CallId>
      <QuestionnaireId>2</QuestionnaireId>
      <Status>NotSpecified</Status>
    </OnBoardCallStateDeclaration>
    <OnBoardCallStateDeclaration>
      <CallId>1</CallId>
      <QuestionnaireId>2</QuestionnaireId>
      <Status>NotSpecified</Status>
    </OnBoardCallStateDeclaration>
    <OnBoardCallStateDeclaration>
      <CallId>1</CallId>
      <QuestionnaireId>2</QuestionnaireId>
      <Status>NotSpecified</Status>
    </OnBoardCallStateDeclaration>
  </CallStateDeclarations>
  <DeviceIdentifier>sample string 2</DeviceIdentifier>
</OnBoardCallState>

application/x-www-form-urlencoded

Sample:

Sample not available.