POST api/policies/GetSparePolicyCardsList

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional 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:

<GetSparePolicyCardsListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Policies.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>
</GetSparePolicyCardsListRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetSparePolicyCardsListResponse

Name	Description	Type	Additional information
Cards		Collection of PolicyDocument	None.
Result		Response	None.

Response Formats

application/json, text/json

Sample:

{
  "Cards": [
    {
      "PolicyID": 1,
      "PolicyDocumentID": 2,
      "PolicyDocumentTypeID": 3,
      "PolicyDocumentTypeName": "sample string 4",
      "DocumentPath": "sample string 5",
      "IsActive": true,
      "FileName": "sample string 7",
      "Extension": "sample string 8",
      "AddedOn": "2025-12-05T20:25:54.005971-08:00",
      "AddedBy": 1,
      "AddedByName": "sample string 9"
    },
    {
      "PolicyID": 1,
      "PolicyDocumentID": 2,
      "PolicyDocumentTypeID": 3,
      "PolicyDocumentTypeName": "sample string 4",
      "DocumentPath": "sample string 5",
      "IsActive": true,
      "FileName": "sample string 7",
      "Extension": "sample string 8",
      "AddedOn": "2025-12-05T20:25:54.005971-08:00",
      "AddedBy": 1,
      "AddedByName": "sample string 9"
    }
  ],
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<GetSparePolicyCardsListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CFI.Entities.Policies.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>
  <Cards xmlns:d2p1="http://schemas.datacontract.org/2004/07/CFI.Entities.Policies">
    <d2p1:PolicyDocument>
      <d2p1:AddedBy>1</d2p1:AddedBy>
      <d2p1:AddedByName>sample string 9</d2p1:AddedByName>
      <d2p1:AddedOn>2025-12-05T20:25:54.005971-08:00</d2p1:AddedOn>
      <d2p1:DocumentPath>sample string 5</d2p1:DocumentPath>
      <d2p1:Extension>sample string 8</d2p1:Extension>
      <d2p1:FileName>sample string 7</d2p1:FileName>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:PolicyDocumentID>2</d2p1:PolicyDocumentID>
      <d2p1:PolicyDocumentTypeID>3</d2p1:PolicyDocumentTypeID>
      <d2p1:PolicyDocumentTypeName>sample string 4</d2p1:PolicyDocumentTypeName>
      <d2p1:PolicyID>1</d2p1:PolicyID>
    </d2p1:PolicyDocument>
    <d2p1:PolicyDocument>
      <d2p1:AddedBy>1</d2p1:AddedBy>
      <d2p1:AddedByName>sample string 9</d2p1:AddedByName>
      <d2p1:AddedOn>2025-12-05T20:25:54.005971-08:00</d2p1:AddedOn>
      <d2p1:DocumentPath>sample string 5</d2p1:DocumentPath>
      <d2p1:Extension>sample string 8</d2p1:Extension>
      <d2p1:FileName>sample string 7</d2p1:FileName>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:PolicyDocumentID>2</d2p1:PolicyDocumentID>
      <d2p1:PolicyDocumentTypeID>3</d2p1:PolicyDocumentTypeID>
      <d2p1:PolicyDocumentTypeName>sample string 4</d2p1:PolicyDocumentTypeName>
      <d2p1:PolicyID>1</d2p1:PolicyID>
    </d2p1:PolicyDocument>
  </Cards>
</GetSparePolicyCardsListResponse>