POST api/policies/DeclarePolicyOpenDeclaration

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OpenDeclarationFileID	integer	None.
PolicyID	integer	None.
RootPath	string	None.
Header	RequestHeader	None.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<DeclarePolicyOpenDeclarationRequest 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>
  <RootPath>sample string 3</RootPath>
</DeclarePolicyOpenDeclarationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DeclarePolicyOpenDeclarationResponse

Name	Type	Additional information
TotalPolicyDeclarations	PolicyDeclarationDetails	None.
TotalDeclaredPolicyDeclarations	PolicyDeclarationDetails	None.
TotalNewPolicyDeclarations	PolicyDeclarationDetails	None.
Result	Response	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalPolicyDeclarations": {
    "Import": 1.0,
    "Export": 2.0,
    "DomesticSales": 3.0,
    "JobWorkMovement": 4.0,
    "StockTransfer": 5.0,
    "DomesticPurchase": 6.0,
    "CapitalGoodsPurchase": 7.0
  },
  "TotalDeclaredPolicyDeclarations": {
    "Import": 1.0,
    "Export": 2.0,
    "DomesticSales": 3.0,
    "JobWorkMovement": 4.0,
    "StockTransfer": 5.0,
    "DomesticPurchase": 6.0,
    "CapitalGoodsPurchase": 7.0
  },
  "TotalNewPolicyDeclarations": {
    "Import": 1.0,
    "Export": 2.0,
    "DomesticSales": 3.0,
    "JobWorkMovement": 4.0,
    "StockTransfer": 5.0,
    "DomesticPurchase": 6.0,
    "CapitalGoodsPurchase": 7.0
  },
  "Result": {
    "Result": 1,
    "Messages": [
      "sample string 1",
      "sample string 2"
    ],
    "TechnicalMessages": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<DeclarePolicyOpenDeclarationResponse 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>
  <TotalDeclaredPolicyDeclarations xmlns:d2p1="http://schemas.datacontract.org/2004/07/IMS.Entities.Policies">
    <d2p1:CapitalGoodsPurchase>7</d2p1:CapitalGoodsPurchase>
    <d2p1:DomesticPurchase>6</d2p1:DomesticPurchase>
    <d2p1:DomesticSales>3</d2p1:DomesticSales>
    <d2p1:Export>2</d2p1:Export>
    <d2p1:Import>1</d2p1:Import>
    <d2p1:JobWorkMovement>4</d2p1:JobWorkMovement>
    <d2p1:StockTransfer>5</d2p1:StockTransfer>
  </TotalDeclaredPolicyDeclarations>
  <TotalNewPolicyDeclarations xmlns:d2p1="http://schemas.datacontract.org/2004/07/IMS.Entities.Policies">
    <d2p1:CapitalGoodsPurchase>7</d2p1:CapitalGoodsPurchase>
    <d2p1:DomesticPurchase>6</d2p1:DomesticPurchase>
    <d2p1:DomesticSales>3</d2p1:DomesticSales>
    <d2p1:Export>2</d2p1:Export>
    <d2p1:Import>1</d2p1:Import>
    <d2p1:JobWorkMovement>4</d2p1:JobWorkMovement>
    <d2p1:StockTransfer>5</d2p1:StockTransfer>
  </TotalNewPolicyDeclarations>
  <TotalPolicyDeclarations xmlns:d2p1="http://schemas.datacontract.org/2004/07/IMS.Entities.Policies">
    <d2p1:CapitalGoodsPurchase>7</d2p1:CapitalGoodsPurchase>
    <d2p1:DomesticPurchase>6</d2p1:DomesticPurchase>
    <d2p1:DomesticSales>3</d2p1:DomesticSales>
    <d2p1:Export>2</d2p1:Export>
    <d2p1:Import>1</d2p1:Import>
    <d2p1:JobWorkMovement>4</d2p1:JobWorkMovement>
    <d2p1:StockTransfer>5</d2p1:StockTransfer>
  </TotalPolicyDeclarations>
</DeclarePolicyOpenDeclarationResponse>