POST api/policies/GetPolicyOpenDeclarationDetails

Request Information

URI Parameters

None.

Body Parameters

GetPolicyOpenDeclarationDetailsRequest
NameDescriptionTypeAdditional information
OpenDeclarationFileID

integer

None.

PolicyID

integer

None.

Header

RequestHeader

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetPolicyOpenDeclarationDetailsResponse
NameDescriptionTypeAdditional information
Declarations

Collection of PolicyOpenDeclarations

None.

Result

Response

None.

Response Formats

application/json, text/json

Sample:
{
  "Declarations": [
    {
      "OpenDeclarationID": 1,
      "OpenDeclarationFileID": 2,
      "VoyageTypeID": 3,
      "VoyageTypeName": "sample string 4",
      "INVOICE_NO_L_R_NO": "sample string 5",
      "INVOICE_DATE_L_R_DATE": "2026-03-21T10:39:08.9801373-07:00",
      "VoyageDetails": "sample string 7",
      "CargoValue": 8.0
    },
    {
      "OpenDeclarationID": 1,
      "OpenDeclarationFileID": 2,
      "VoyageTypeID": 3,
      "VoyageTypeName": "sample string 4",
      "INVOICE_NO_L_R_NO": "sample string 5",
      "INVOICE_DATE_L_R_DATE": "2026-03-21T10:39:08.9801373-07:00",
      "VoyageDetails": "sample string 7",
      "CargoValue": 8.0
    }
  ],
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:
<GetPolicyOpenDeclarationDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IMS.Entities.Policies.Integration">
  <Result xmlns="http://schemas.datacontract.org/2004/07/IMS.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>
  <Declarations xmlns:d2p1="http://schemas.datacontract.org/2004/07/IMS.Entities.Policies">
    <d2p1:PolicyOpenDeclarations>
      <d2p1:CargoValue>8</d2p1:CargoValue>
      <d2p1:INVOICE_DATE_L_R_DATE>2026-03-21T10:39:08.9801373-07:00</d2p1:INVOICE_DATE_L_R_DATE>
      <d2p1:INVOICE_NO_L_R_NO>sample string 5</d2p1:INVOICE_NO_L_R_NO>
      <d2p1:OpenDeclarationFileID>2</d2p1:OpenDeclarationFileID>
      <d2p1:OpenDeclarationID>1</d2p1:OpenDeclarationID>
      <d2p1:VoyageDetails>sample string 7</d2p1:VoyageDetails>
      <d2p1:VoyageTypeID>3</d2p1:VoyageTypeID>
      <d2p1:VoyageTypeName>sample string 4</d2p1:VoyageTypeName>
    </d2p1:PolicyOpenDeclarations>
    <d2p1:PolicyOpenDeclarations>
      <d2p1:CargoValue>8</d2p1:CargoValue>
      <d2p1:INVOICE_DATE_L_R_DATE>2026-03-21T10:39:08.9801373-07:00</d2p1:INVOICE_DATE_L_R_DATE>
      <d2p1:INVOICE_NO_L_R_NO>sample string 5</d2p1:INVOICE_NO_L_R_NO>
      <d2p1:OpenDeclarationFileID>2</d2p1:OpenDeclarationFileID>
      <d2p1:OpenDeclarationID>1</d2p1:OpenDeclarationID>
      <d2p1:VoyageDetails>sample string 7</d2p1:VoyageDetails>
      <d2p1:VoyageTypeID>3</d2p1:VoyageTypeID>
      <d2p1:VoyageTypeName>sample string 4</d2p1:VoyageTypeName>
    </d2p1:PolicyOpenDeclarations>
  </Declarations>
</GetPolicyOpenDeclarationDetailsResponse>