POST api/policies/getpolicystatuses

Request Information

URI Parameters

None.

Body Parameters

GetPolicyStatusesRequest
NameDescriptionTypeAdditional information
PolicyID

integer

None.

Header

RequestHeader

None.

Request Formats

application/json, text/json

Sample:
{
  "PolicyID": 1,
  "Header": {
    "Token": "sample string 1",
    "IPAddress": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<GetPolicyStatusesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Masters.Integration">
  <Header xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Integration">
    <IPAddress>sample string 2</IPAddress>
    <Token>sample string 1</Token>
  </Header>
  <PolicyID>1</PolicyID>
</GetPolicyStatusesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetPolicyStatusesResponse
NameDescriptionTypeAdditional information
PolicyStatuses

Collection of PolicyStatus

None.

Result

Response

None.

Response Formats

application/json, text/json

Sample:
{
  "PolicyStatuses": [
    {
      "PolicyStatusID": 1,
      "PolicyStatusName": "sample string 2",
      "IsActive": true
    },
    {
      "PolicyStatusID": 1,
      "PolicyStatusName": "sample string 2",
      "IsActive": true
    }
  ],
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:
<GetPolicyStatusesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Masters.Integration">
  <Result xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Integration">
    <Messages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Messages>
    <Result>1</Result>
    <TechnicalMessages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </TechnicalMessages>
  </Result>
  <PolicyStatuses xmlns:d2p1="http://schemas.datacontract.org/2004/07/CFI.Entities.Masters">
    <d2p1:PolicyStatus>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:PolicyStatusID>1</d2p1:PolicyStatusID>
      <d2p1:PolicyStatusName>sample string 2</d2p1:PolicyStatusName>
    </d2p1:PolicyStatus>
    <d2p1:PolicyStatus>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:PolicyStatusID>1</d2p1:PolicyStatusID>
      <d2p1:PolicyStatusName>sample string 2</d2p1:PolicyStatusName>
    </d2p1:PolicyStatus>
  </PolicyStatuses>
</GetPolicyStatusesResponse>