POST api/policies/GetPolicyOpenDeclarationFiles

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:

<GetPolicyOpenDeclarationFilesRequest 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>
</GetPolicyOpenDeclarationFilesRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetPolicyOpenDeclarationFilesResponse

Name	Description	Type	Additional information
PolicyOpenDeclarationFiles		Collection of PolicyOpenDeclarationFile	None.
Result		Response	None.

Response Formats

application/json, text/json

Sample:

{
  "PolicyOpenDeclarationFiles": [
    {
      "OpenDeclarationFileID": 1,
      "PolicyID": 2,
      "Year": 3,
      "Month": 4,
      "PolicyDocumentID": 5,
      "CreatedBy": "sample string 6",
      "CreatedOn": "2026-03-23T01:40:28.2717634-07:00",
      "DeclaredBy": "sample string 8",
      "DeclaredOn": "2026-03-23T01:40:28.2717634-07:00",
      "ApprovedBy": "sample string 9",
      "ApprovedOn": "2026-03-23T01:40:28.2717634-07:00",
      "CorrectionRequestedBy": "sample string 10",
      "CorrectionRequestedOn": "2026-03-23T01:40:28.2717634-07:00",
      "CorrectionDoneBy": "sample string 11",
      "CorrectionDoneOn": "2026-03-23T01:40:28.2717634-07:00",
      "Status": "sample string 12",
      "DeclarationStatusID": 13,
      "PolicyDocumentName": "sample string 14",
      "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-23T01:40:28.287304-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-23T01:40:28.287304-07:00",
          "VoyageDetails": "sample string 7",
          "CargoValue": 8.0
        }
      ]
    },
    {
      "OpenDeclarationFileID": 1,
      "PolicyID": 2,
      "Year": 3,
      "Month": 4,
      "PolicyDocumentID": 5,
      "CreatedBy": "sample string 6",
      "CreatedOn": "2026-03-23T01:40:28.2717634-07:00",
      "DeclaredBy": "sample string 8",
      "DeclaredOn": "2026-03-23T01:40:28.2717634-07:00",
      "ApprovedBy": "sample string 9",
      "ApprovedOn": "2026-03-23T01:40:28.2717634-07:00",
      "CorrectionRequestedBy": "sample string 10",
      "CorrectionRequestedOn": "2026-03-23T01:40:28.2717634-07:00",
      "CorrectionDoneBy": "sample string 11",
      "CorrectionDoneOn": "2026-03-23T01:40:28.2717634-07:00",
      "Status": "sample string 12",
      "DeclarationStatusID": 13,
      "PolicyDocumentName": "sample string 14",
      "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-23T01:40:28.287304-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-23T01:40:28.287304-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:

<GetPolicyOpenDeclarationFilesResponse 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>
  <PolicyOpenDeclarationFiles xmlns:d2p1="http://schemas.datacontract.org/2004/07/IMS.Entities.Policies">
    <d2p1:PolicyOpenDeclarationFile>
      <d2p1:ApprovedBy>sample string 9</d2p1:ApprovedBy>
      <d2p1:ApprovedOn>2026-03-23T01:40:28.2717634-07:00</d2p1:ApprovedOn>
      <d2p1:CorrectionDoneBy>sample string 11</d2p1:CorrectionDoneBy>
      <d2p1:CorrectionDoneOn>2026-03-23T01:40:28.2717634-07:00</d2p1:CorrectionDoneOn>
      <d2p1:CorrectionRequestedBy>sample string 10</d2p1:CorrectionRequestedBy>
      <d2p1:CorrectionRequestedOn>2026-03-23T01:40:28.2717634-07:00</d2p1:CorrectionRequestedOn>
      <d2p1:CreatedBy>sample string 6</d2p1:CreatedBy>
      <d2p1:CreatedOn>2026-03-23T01:40:28.2717634-07:00</d2p1:CreatedOn>
      <d2p1:DeclarationStatusID>13</d2p1:DeclarationStatusID>
      <d2p1:Declarations>
        <d2p1:PolicyOpenDeclarations>
          <d2p1:CargoValue>8</d2p1:CargoValue>
          <d2p1:INVOICE_DATE_L_R_DATE>2026-03-23T01:40:28.287304-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-23T01:40:28.287304-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:Declarations>
      <d2p1:DeclaredBy>sample string 8</d2p1:DeclaredBy>
      <d2p1:DeclaredOn>2026-03-23T01:40:28.2717634-07:00</d2p1:DeclaredOn>
      <d2p1:Month>4</d2p1:Month>
      <d2p1:OpenDeclarationFileID>1</d2p1:OpenDeclarationFileID>
      <d2p1:PolicyDocumentID>5</d2p1:PolicyDocumentID>
      <d2p1:PolicyDocumentName>sample string 14</d2p1:PolicyDocumentName>
      <d2p1:PolicyID>2</d2p1:PolicyID>
      <d2p1:Status>sample string 12</d2p1:Status>
      <d2p1:Year>3</d2p1:Year>
    </d2p1:PolicyOpenDeclarationFile>
    <d2p1:PolicyOpenDeclarationFile>
      <d2p1:ApprovedBy>sample string 9</d2p1:ApprovedBy>
      <d2p1:ApprovedOn>2026-03-23T01:40:28.2717634-07:00</d2p1:ApprovedOn>
      <d2p1:CorrectionDoneBy>sample string 11</d2p1:CorrectionDoneBy>
      <d2p1:CorrectionDoneOn>2026-03-23T01:40:28.2717634-07:00</d2p1:CorrectionDoneOn>
      <d2p1:CorrectionRequestedBy>sample string 10</d2p1:CorrectionRequestedBy>
      <d2p1:CorrectionRequestedOn>2026-03-23T01:40:28.2717634-07:00</d2p1:CorrectionRequestedOn>
      <d2p1:CreatedBy>sample string 6</d2p1:CreatedBy>
      <d2p1:CreatedOn>2026-03-23T01:40:28.2717634-07:00</d2p1:CreatedOn>
      <d2p1:DeclarationStatusID>13</d2p1:DeclarationStatusID>
      <d2p1:Declarations>
        <d2p1:PolicyOpenDeclarations>
          <d2p1:CargoValue>8</d2p1:CargoValue>
          <d2p1:INVOICE_DATE_L_R_DATE>2026-03-23T01:40:28.287304-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-23T01:40:28.287304-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:Declarations>
      <d2p1:DeclaredBy>sample string 8</d2p1:DeclaredBy>
      <d2p1:DeclaredOn>2026-03-23T01:40:28.2717634-07:00</d2p1:DeclaredOn>
      <d2p1:Month>4</d2p1:Month>
      <d2p1:OpenDeclarationFileID>1</d2p1:OpenDeclarationFileID>
      <d2p1:PolicyDocumentID>5</d2p1:PolicyDocumentID>
      <d2p1:PolicyDocumentName>sample string 14</d2p1:PolicyDocumentName>
      <d2p1:PolicyID>2</d2p1:PolicyID>
      <d2p1:Status>sample string 12</d2p1:Status>
      <d2p1:Year>3</d2p1:Year>
    </d2p1:PolicyOpenDeclarationFile>
  </PolicyOpenDeclarationFiles>
</GetPolicyOpenDeclarationFilesResponse>