POST api/Locus/PlanStatusUpdate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
eventType	eventTypeData	None.
planId	planIdData	None.
status	string	None.
timestamp	string	None.

Request Formats

application/json, text/json

Sample:

{
  "eventType": {
    "type": "sample string 1"
  },
  "planId": {
    "clientId": "sample string 1",
    "batchId": "sample string 2",
    "planId": "sample string 3"
  },
  "status": "sample string 1",
  "timestamp": "sample string 2"
}

application/xml, text/xml

Sample:

<PlanStatusUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <eventType>
    <type>sample string 1</type>
  </eventType>
  <planId>
    <batchId>sample string 2</batchId>
    <clientId>sample string 1</clientId>
    <planId>sample string 3</planId>
  </planId>
  <status>sample string 1</status>
  <timestamp>sample string 2</timestamp>
</PlanStatusUpdate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2024/09/19 17:19:27",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>