POST api/policies/getpolicyOpenDeclarations

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:

<GetPolicyOpendeclarationRequest 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>
  <PolicyID>1</PolicyID>
</GetPolicyOpendeclarationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetPolicyOpendeclarationResponse

Name	Description	Type	Additional information
policyOpendeclarations		Collection of PolicyOpendeclaration	None.
Result		Response	None.

Response Formats

application/json, text/json

Sample:

{
  "policyOpendeclarations": [
    {
      "OpenDeclarationID": 1,
      "PolicyID": 2,
      "VoyageType": "sample string 3",
      "INVOICE_NO_L_R_NO": "sample string 4",
      "INVOICE_DATE_L_R_DATE": "2026-01-20T12:07:12.7675689-08:00",
      "DeclarationEffectiveDate": "2026-01-20T12:07:12.7675689-08:00",
      "VoyageDetails": "sample string 7",
      "CargoValue": 8.0,
      "DeclaredBy": "sample string 9",
      "DeclaredOn": "2026-01-20T12:07:12.7675689-08:00",
      "ApprovedBy": "sample string 11",
      "ApprovedOn": "2026-01-20T12:07:12.7675689-08:00"
    },
    {
      "OpenDeclarationID": 1,
      "PolicyID": 2,
      "VoyageType": "sample string 3",
      "INVOICE_NO_L_R_NO": "sample string 4",
      "INVOICE_DATE_L_R_DATE": "2026-01-20T12:07:12.7675689-08:00",
      "DeclarationEffectiveDate": "2026-01-20T12:07:12.7675689-08:00",
      "VoyageDetails": "sample string 7",
      "CargoValue": 8.0,
      "DeclaredBy": "sample string 9",
      "DeclaredOn": "2026-01-20T12:07:12.7675689-08:00",
      "ApprovedBy": "sample string 11",
      "ApprovedOn": "2026-01-20T12:07:12.7675689-08:00"
    }
  ],
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<GetPolicyOpendeclarationResponse 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>
  <policyOpendeclarations>
    <PolicyOpendeclaration>
      <ApprovedBy>sample string 11</ApprovedBy>
      <ApprovedOn>2026-01-20T12:07:12.7675689-08:00</ApprovedOn>
      <CargoValue>8</CargoValue>
      <DeclarationEffectiveDate>2026-01-20T12:07:12.7675689-08:00</DeclarationEffectiveDate>
      <DeclaredBy>sample string 9</DeclaredBy>
      <DeclaredOn>2026-01-20T12:07:12.7675689-08:00</DeclaredOn>
      <INVOICE_DATE_L_R_DATE>2026-01-20T12:07:12.7675689-08:00</INVOICE_DATE_L_R_DATE>
      <INVOICE_NO_L_R_NO>sample string 4</INVOICE_NO_L_R_NO>
      <OpenDeclarationID>1</OpenDeclarationID>
      <PolicyID>2</PolicyID>
      <VoyageDetails>sample string 7</VoyageDetails>
      <VoyageType>sample string 3</VoyageType>
    </PolicyOpendeclaration>
    <PolicyOpendeclaration>
      <ApprovedBy>sample string 11</ApprovedBy>
      <ApprovedOn>2026-01-20T12:07:12.7675689-08:00</ApprovedOn>
      <CargoValue>8</CargoValue>
      <DeclarationEffectiveDate>2026-01-20T12:07:12.7675689-08:00</DeclarationEffectiveDate>
      <DeclaredBy>sample string 9</DeclaredBy>
      <DeclaredOn>2026-01-20T12:07:12.7675689-08:00</DeclaredOn>
      <INVOICE_DATE_L_R_DATE>2026-01-20T12:07:12.7675689-08:00</INVOICE_DATE_L_R_DATE>
      <INVOICE_NO_L_R_NO>sample string 4</INVOICE_NO_L_R_NO>
      <OpenDeclarationID>1</OpenDeclarationID>
      <PolicyID>2</PolicyID>
      <VoyageDetails>sample string 7</VoyageDetails>
      <VoyageType>sample string 3</VoyageType>
    </PolicyOpendeclaration>
  </policyOpendeclarations>
</GetPolicyOpendeclarationResponse>