GET v1/Locations/{locationID}/Policies/IntentToCancelStatuses

Get the intent-to-cancel statuses available for a location. Every office is seeded with three defaults: "Cancelled", "Carrier Declined", and "Waiting on Customer"; agencies may configure additional statuses, and statuses the agency has hidden are not returned.

Request Information

URI Parameters

Name	Description	Type	Additional information
locationID	Id of the location	string	Required

Body Parameters

None.

Response Information

Resource Description

Action result carrying the list of intent-to-cancel statuses available for the location, or a faulted result when the locationID could not identify a location or the request failed unexpectedly. The response is always HTTP 200.

ActionResultDTOOfListOfIntentToCancelStatusDTO

Name	Description	Type	Additional information
Result		Collection of IntentToCancelStatusDTO	None.
CreatedBy		string	None.
EntityID		integer	None.
RowSource		string	None.
PolicyID		integer	None.
IsSuccess	Signifies whether action is successful	boolean	None.
ErrorCode	Error code	string	None.
ErrorMessage	Error message	string	None.
InfoMessage	Information message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": [
    {
      "Id": 1,
      "StatusMessage": "Cancelled"
    },
    {
      "Id": 1,
      "StatusMessage": "Cancelled"
    }
  ],
  "CreatedBy": "sample string 1",
  "EntityID": 2,
  "RowSource": "sample string 3",
  "PolicyID": 4,
  "IsSuccess": true,
  "ErrorCode": "sample string 6",
  "ErrorMessage": "sample string 7",
  "InfoMessage": "sample string 8"
}

application/xml, text/xml

Sample:

<ActionResultOfArrayOfIntentToCancelStatusDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 6</ErrorCode>
  <ErrorMessage>sample string 7</ErrorMessage>
  <InfoMessage>sample string 8</InfoMessage>
  <IsSuccess>true</IsSuccess>
  <CreatedBy>sample string 1</CreatedBy>
  <EntityID>2</EntityID>
  <PolicyID>4</PolicyID>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
    <d2p1:IntentToCancelStatusDTO>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:StatusMessage>Cancelled</d2p1:StatusMessage>
    </d2p1:IntentToCancelStatusDTO>
    <d2p1:IntentToCancelStatusDTO>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:StatusMessage>Cancelled</d2p1:StatusMessage>
    </d2p1:IntentToCancelStatusDTO>
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfArrayOfIntentToCancelStatusDTO>