POST api/policies/downloadpolicies
Request Information
URI Parameters
None.
Body Parameters
DownloadPoliciesRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| PolicyTypeID | integer |
None. |
|
| ExpiryFilter | integer |
None. |
|
| FirmID | integer |
None. |
|
| DocumentPath | string |
None. |
|
| Header | RequestHeader |
None. |
Request Formats
application/json, text/json
Sample:
{
"PolicyTypeID": 1,
"ExpiryFilter": 1,
"FirmID": 1,
"DocumentPath": "sample string 1",
"Header": {
"Token": "sample string 1",
"IPAddress": "sample string 2"
}
}
application/xml, text/xml
Sample:
<DownloadPoliciesRequest 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>
<DocumentPath>sample string 1</DocumentPath>
<ExpiryFilter>1</ExpiryFilter>
<FirmID>1</FirmID>
<PolicyTypeID>1</PolicyTypeID>
</DownloadPoliciesRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
DownloadPoliciesResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| DocumentPath | string |
None. |
|
| Result | Response |
None. |
Response Formats
application/json, text/json
Sample:
{
"DocumentPath": "sample string 1",
"Result": {
"Result": 1,
"Messages": [
"sample string 1",
"sample string 2"
],
"TechnicalMessages": [
"sample string 1",
"sample string 2"
]
}
}
application/xml, text/xml
Sample:
<DownloadPoliciesResponse 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>
<DocumentPath>sample string 1</DocumentPath>
</DownloadPoliciesResponse>