POST v1/Status
Request Information
URI Parameters
None.
Body Parameters
StatusInboundDTOName | Description | Type | Additional information |
---|---|---|---|
Status |
Target Status Should parse as StatusTypeCustomEnum |
string |
None. |
ToStatus |
Target Status Should parse as StatusTypeCustomEnum |
string |
None. |
Reason |
Reason for the Status change |
string |
String length: inclusive between 0 and 256 |
RefItemId |
RefItemId Referance ItemId of the Quote/Policy |
string |
Required |
RefItemType |
RefItemType identifies type of refItemId, currently Quote or Policy |
string |
Required |
RefNumber |
RefNumber, Quote/Policy Number Useful in debugging |
string |
None. |
RefTermNumber |
RefTermNumber Term Number of Policy, Quotes do not have Term number |
integer |
None. |
RefTransactionNumber |
RefTransactionNumber Transaction Number of Quote or Policy |
integer |
None. |
OnBehalfOf |
OnBehalfOf identfies the username of the person making the status change Attempt to lookup UserId from username will be made. If not found, username will be discarded |
string |
None. |
Request Formats
application/json, text/json
{ "Status": "sample string 1", "ToStatus": "sample string 2", "Reason": "sample string 3", "RefItemId": "sample string 4", "RefItemType": "sample string 5", "RefNumber": "sample string 6", "RefTermNumber": 7, "RefTransactionNumber": 8, "OnBehalfOf": "sample string 9" }
application/xml, text/xml
<StatusInboundDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Inbound"> <Expand xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models"></Expand> <Expansions xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models" /> <Id xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models">10</Id> <OnBehalfOf>sample string 9</OnBehalfOf> <Reason>sample string 3</Reason> <RefItemId>sample string 4</RefItemId> <RefItemType>sample string 5</RefItemType> <RefNumber>sample string 6</RefNumber> <RefTermNumber>7</RefTermNumber> <RefTransactionNumber>8</RefTransactionNumber> <Status>sample string 1</Status> <ToStatus>sample string 2</ToStatus> </StatusInboundDTO>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.