POST api/policies/Addpolicyopendeclarations

Request Information

URI Parameters

None.

Body Parameters

AddpolicyOpendeclarationRequest
NameDescriptionTypeAdditional information
OpenDeclarationID

integer

None.

PolicyID

integer

None.

VoyageType

string

None.

INVOICE_NO_L_R_NO

string

None.

INVOICE_DATE_L_R_DATE

date

None.

DeclarationEffectiveDate

date

None.

VoyageDetails

string

None.

CargoValue

decimal number

None.

Header

RequestHeader

None.

Request Formats

application/json, text/json

Sample:
{
  "OpenDeclarationID": 1,
  "PolicyID": 2,
  "VoyageType": "sample string 3",
  "INVOICE_NO_L_R_NO": "sample string 4",
  "INVOICE_DATE_L_R_DATE": "2026-01-20T12:09:44.8418598-08:00",
  "DeclarationEffectiveDate": "2026-01-20T12:09:44.8418598-08:00",
  "VoyageDetails": "sample string 7",
  "CargoValue": 8.0,
  "Header": {
    "Token": "sample string 1",
    "IPAddress": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<AddpolicyOpendeclarationRequest 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>
  <CargoValue>8</CargoValue>
  <DeclarationEffectiveDate>2026-01-20T12:09:44.8418598-08:00</DeclarationEffectiveDate>
  <INVOICE_DATE_L_R_DATE>2026-01-20T12:09:44.8418598-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>
</AddpolicyOpendeclarationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddpolicyOpendeclarationResponse
NameDescriptionTypeAdditional information
Result

Response

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:
<AddpolicyOpendeclarationResponse 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>
</AddpolicyOpendeclarationResponse>