POST api/policies/getpolicyStopDeclarations

Request Information

URI Parameters

None.

Body Parameters

GetPolicyStopdeclarationRequest
NameDescriptionTypeAdditional 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:
<GetPolicyStopdeclarationRequest 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>
</GetPolicyStopdeclarationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetPolicyStopdeclarationResponse
NameDescriptionTypeAdditional information
policyStopdeclarations

Collection of PolicyStopdeclaration

None.

Result

Response

None.

Response Formats

application/json, text/json

Sample:
{
  "policyStopdeclarations": [
    {
      "StopDeclartionID": 1,
      "PolicyID": 2,
      "DeclarationEffectiveDate": "2026-01-20T12:07:54.8178931-08:00",
      "Month": 4,
      "DomesticSales": 5.0,
      "Exports": 6.0,
      "CapitalGoods": 7.0,
      "Imports": 8.0,
      "DemesticPurchases": 9.0,
      "DeclaredBy": "sample string 10",
      "DeclaredOn": "2026-01-20T12:07:54.8178931-08:00",
      "ApprovedBy": "sample string 12",
      "ApprovedOn": "2026-01-20T12:07:54.8178931-08:00",
      "Year": 13
    },
    {
      "StopDeclartionID": 1,
      "PolicyID": 2,
      "DeclarationEffectiveDate": "2026-01-20T12:07:54.8178931-08:00",
      "Month": 4,
      "DomesticSales": 5.0,
      "Exports": 6.0,
      "CapitalGoods": 7.0,
      "Imports": 8.0,
      "DemesticPurchases": 9.0,
      "DeclaredBy": "sample string 10",
      "DeclaredOn": "2026-01-20T12:07:54.8178931-08:00",
      "ApprovedBy": "sample string 12",
      "ApprovedOn": "2026-01-20T12:07:54.8178931-08:00",
      "Year": 13
    }
  ],
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:
<GetPolicyStopdeclarationResponse 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>
  <policyStopdeclarations>
    <PolicyStopdeclaration>
      <ApprovedBy>sample string 12</ApprovedBy>
      <ApprovedOn>2026-01-20T12:07:54.8178931-08:00</ApprovedOn>
      <CapitalGoods>7</CapitalGoods>
      <DeclarationEffectiveDate>2026-01-20T12:07:54.8178931-08:00</DeclarationEffectiveDate>
      <DeclaredBy>sample string 10</DeclaredBy>
      <DeclaredOn>2026-01-20T12:07:54.8178931-08:00</DeclaredOn>
      <DemesticPurchases>9</DemesticPurchases>
      <DomesticSales>5</DomesticSales>
      <Exports>6</Exports>
      <Imports>8</Imports>
      <Month>4</Month>
      <PolicyID>2</PolicyID>
      <StopDeclartionID>1</StopDeclartionID>
      <Year>13</Year>
    </PolicyStopdeclaration>
    <PolicyStopdeclaration>
      <ApprovedBy>sample string 12</ApprovedBy>
      <ApprovedOn>2026-01-20T12:07:54.8178931-08:00</ApprovedOn>
      <CapitalGoods>7</CapitalGoods>
      <DeclarationEffectiveDate>2026-01-20T12:07:54.8178931-08:00</DeclarationEffectiveDate>
      <DeclaredBy>sample string 10</DeclaredBy>
      <DeclaredOn>2026-01-20T12:07:54.8178931-08:00</DeclaredOn>
      <DemesticPurchases>9</DemesticPurchases>
      <DomesticSales>5</DomesticSales>
      <Exports>6</Exports>
      <Imports>8</Imports>
      <Month>4</Month>
      <PolicyID>2</PolicyID>
      <StopDeclartionID>1</StopDeclartionID>
      <Year>13</Year>
    </PolicyStopdeclaration>
  </policyStopdeclarations>
</GetPolicyStopdeclarationResponse>