POST api/policies/addpolicy

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Policy		Policy	None.
Header		RequestHeader	None.

Request Formats

application/json, text/json

Sample:

{
  "Policy": {
    "PolicyID": 1,
    "FirmID": 2,
    "FirmName": "sample string 3",
    "PolicyIssuerID": 4,
    "PolicyIssuerName": "sample string 5",
    "PolicyNumber": "sample string 6",
    "InceptionDate": "2026-01-20T12:09:37.998118-08:00",
    "ExpiryDate": "2026-01-20T12:09:37.998118-08:00",
    "IsSEZ": true,
    "Rate": 10.0,
    "PolicyBasisOfValuationID": 11,
    "PolicyExcessID": 12,
    "PolicyFragileItemsExcessID": 13,
    "PolicyExcessCustomValue": 14.0,
    "PolicyFragileItemsExcessCustomValue": 15.0,
    "PerBottom": 16.0,
    "PerLocationLimit": 17.0,
    "CommodityInsured": "sample string 18",
    "CreatedBy": 19,
    "ModifiedBy": 20,
    "IsActive": true,
    "CreatedOn": "2026-01-20T12:09:37.998118-08:00",
    "ModifiedOn": "2026-01-20T12:09:37.998118-08:00",
    "CreatedByName": "sample string 24",
    "ModifiedByName": "sample string 25",
    "PolicyTypeID": 26,
    "PolicyTypeName": "sample string 27",
    "PolicyStatusID": 1,
    "PolicyStatusName": "sample string 28",
    "GST": 29.0,
    "PartnerID": 30,
    "PartnerName": "sample string 31",
    "PartnerEmailAddress": "sample string 32",
    "PartnerAddress": "sample string 33",
    "GrossPremium": 34.0,
    "PremiumRate": 35.0,
    "GrossPremiumWithGST": 36.0,
    "TermsOfSales": [
      {
        "TermID": 1,
        "TermTitle": "sample string 2",
        "IsActive": true,
        "PolicyID": 4,
        "RelationshipID": 5
      },
      {
        "TermID": 1,
        "TermTitle": "sample string 2",
        "IsActive": true,
        "PolicyID": 4,
        "RelationshipID": 5
      }
    ],
    "PolicyDeclarations": [
      {
        "PolicyID": 1,
        "PolicyDeclarationID": 2,
        "Import": 3.0,
        "Export": 4.0,
        "DomesticSales": 5.0,
        "JobWorkMovement": 6.0,
        "StockTransfer": 7.0,
        "DomesticPurchase": 8.0,
        "CapitalGoodsPurchase": 9.0,
        "DeclarationDate": "2026-01-20T12:09:37.998118-08:00",
        "DeclaredBy": 1,
        "ApprovalDate": "2026-01-20T12:09:37.998118-08:00",
        "ApprovedBy": 1,
        "ApprovedByName": "sample string 10",
        "DeclaredByName": "sample string 11",
        "SumInsured": 12.0,
        "GrossPremium": 13.0,
        "GrossPremiumWithGST": 14.0,
        "PremiumRate": 15.0,
        "CorrectionDoneBy": 1,
        "CorrectionDoneByName": "sample string 16",
        "CorrectionDoneOn": "2026-01-20T12:09:37.998118-08:00",
        "CorrectionRequestedBy": 1,
        "CorrectionRequestedByName": "sample string 17",
        "CorrectionRequestedOn": "2026-01-20T12:09:37.998118-08:00",
        "DeclarationStatusId": 1
      },
      {
        "PolicyID": 1,
        "PolicyDeclarationID": 2,
        "Import": 3.0,
        "Export": 4.0,
        "DomesticSales": 5.0,
        "JobWorkMovement": 6.0,
        "StockTransfer": 7.0,
        "DomesticPurchase": 8.0,
        "CapitalGoodsPurchase": 9.0,
        "DeclarationDate": "2026-01-20T12:09:37.998118-08:00",
        "DeclaredBy": 1,
        "ApprovalDate": "2026-01-20T12:09:37.998118-08:00",
        "ApprovedBy": 1,
        "ApprovedByName": "sample string 10",
        "DeclaredByName": "sample string 11",
        "SumInsured": 12.0,
        "GrossPremium": 13.0,
        "GrossPremiumWithGST": 14.0,
        "PremiumRate": 15.0,
        "CorrectionDoneBy": 1,
        "CorrectionDoneByName": "sample string 16",
        "CorrectionDoneOn": "2026-01-20T12:09:37.998118-08:00",
        "CorrectionRequestedBy": 1,
        "CorrectionRequestedByName": "sample string 17",
        "CorrectionRequestedOn": "2026-01-20T12:09:37.998118-08:00",
        "DeclarationStatusId": 1
      }
    ],
    "AdminID": 37,
    "PolicyDocuments": [
      {
        "PolicyID": 1,
        "PolicyDocumentID": 2,
        "PolicyDocumentTypeID": 3,
        "PolicyDocumentTypeName": "sample string 4",
        "DocumentPath": "sample string 5",
        "IsActive": true,
        "FileName": "sample string 7",
        "Extension": "sample string 8",
        "AddedOn": "2026-01-20T12:09:37.998118-08:00",
        "AddedBy": 1,
        "AddedByName": "sample string 9",
        "ModifiedBy": 10,
        "ModifiedOn": "2026-01-20T12:09:37.998118-08:00",
        "ModifiedByName": "sample string 12"
      },
      {
        "PolicyID": 1,
        "PolicyDocumentID": 2,
        "PolicyDocumentTypeID": 3,
        "PolicyDocumentTypeName": "sample string 4",
        "DocumentPath": "sample string 5",
        "IsActive": true,
        "FileName": "sample string 7",
        "Extension": "sample string 8",
        "AddedOn": "2026-01-20T12:09:37.998118-08:00",
        "AddedBy": 1,
        "AddedByName": "sample string 9",
        "ModifiedBy": 10,
        "ModifiedOn": "2026-01-20T12:09:37.998118-08:00",
        "ModifiedByName": "sample string 12"
      }
    ],
    "StatusHistory": [
      {
        "PolicyStatusID": 1,
        "PolicyStatusName": "sample string 2",
        "ModifiedBy": 3,
        "ModifiedOn": "2026-01-20T12:09:37.998118-08:00"
      },
      {
        "PolicyStatusID": 1,
        "PolicyStatusName": "sample string 2",
        "ModifiedBy": 3,
        "ModifiedOn": "2026-01-20T12:09:37.998118-08:00"
      }
    ]
  },
  "Header": {
    "Token": "sample string 1",
    "IPAddress": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<AddPolicyRequest 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>
  <Policy xmlns:d2p1="http://schemas.datacontract.org/2004/07/IMS.Entities.Policies">
    <d2p1:AdminID>37</d2p1:AdminID>
    <d2p1:CommodityInsured>sample string 18</d2p1:CommodityInsured>
    <d2p1:CreatedBy>19</d2p1:CreatedBy>
    <d2p1:CreatedByName>sample string 24</d2p1:CreatedByName>
    <d2p1:CreatedOn>2026-01-20T12:09:37.998118-08:00</d2p1:CreatedOn>
    <d2p1:ExpiryDate>2026-01-20T12:09:37.998118-08:00</d2p1:ExpiryDate>
    <d2p1:FirmID>2</d2p1:FirmID>
    <d2p1:FirmName>sample string 3</d2p1:FirmName>
    <d2p1:GST>29</d2p1:GST>
    <d2p1:GrossPremium>34</d2p1:GrossPremium>
    <d2p1:GrossPremiumWithGST>36</d2p1:GrossPremiumWithGST>
    <d2p1:InceptionDate>2026-01-20T12:09:37.998118-08:00</d2p1:InceptionDate>
    <d2p1:IsActive>true</d2p1:IsActive>
    <d2p1:IsSEZ>true</d2p1:IsSEZ>
    <d2p1:ModifiedBy>20</d2p1:ModifiedBy>
    <d2p1:ModifiedByName>sample string 25</d2p1:ModifiedByName>
    <d2p1:ModifiedOn>2026-01-20T12:09:37.998118-08:00</d2p1:ModifiedOn>
    <d2p1:PartnerAddress>sample string 33</d2p1:PartnerAddress>
    <d2p1:PartnerEmailAddress>sample string 32</d2p1:PartnerEmailAddress>
    <d2p1:PartnerID>30</d2p1:PartnerID>
    <d2p1:PartnerName>sample string 31</d2p1:PartnerName>
    <d2p1:PerBottom>16</d2p1:PerBottom>
    <d2p1:PerLocationLimit>17</d2p1:PerLocationLimit>
    <d2p1:PolicyBasisOfValuationID>11</d2p1:PolicyBasisOfValuationID>
    <d2p1:PolicyDeclarations>
      <d2p1:PolicyDeclarations>
        <d2p1:ApprovalDate>2026-01-20T12:09:37.998118-08:00</d2p1:ApprovalDate>
        <d2p1:ApprovedBy>1</d2p1:ApprovedBy>
        <d2p1:ApprovedByName>sample string 10</d2p1:ApprovedByName>
        <d2p1:CapitalGoodsPurchase>9</d2p1:CapitalGoodsPurchase>
        <d2p1:CorrectionDoneBy>1</d2p1:CorrectionDoneBy>
        <d2p1:CorrectionDoneByName>sample string 16</d2p1:CorrectionDoneByName>
        <d2p1:CorrectionDoneOn>2026-01-20T12:09:37.998118-08:00</d2p1:CorrectionDoneOn>
        <d2p1:CorrectionRequestedBy>1</d2p1:CorrectionRequestedBy>
        <d2p1:CorrectionRequestedByName>sample string 17</d2p1:CorrectionRequestedByName>
        <d2p1:CorrectionRequestedOn>2026-01-20T12:09:37.998118-08:00</d2p1:CorrectionRequestedOn>
        <d2p1:DeclarationDate>2026-01-20T12:09:37.998118-08:00</d2p1:DeclarationDate>
        <d2p1:DeclarationStatusId>1</d2p1:DeclarationStatusId>
        <d2p1:DeclaredBy>1</d2p1:DeclaredBy>
        <d2p1:DeclaredByName>sample string 11</d2p1:DeclaredByName>
        <d2p1:DomesticPurchase>8</d2p1:DomesticPurchase>
        <d2p1:DomesticSales>5</d2p1:DomesticSales>
        <d2p1:Export>4</d2p1:Export>
        <d2p1:GrossPremium>13</d2p1:GrossPremium>
        <d2p1:GrossPremiumWithGST>14</d2p1:GrossPremiumWithGST>
        <d2p1:Import>3</d2p1:Import>
        <d2p1:JobWorkMovement>6</d2p1:JobWorkMovement>
        <d2p1:PolicyDeclarationID>2</d2p1:PolicyDeclarationID>
        <d2p1:PolicyID>1</d2p1:PolicyID>
        <d2p1:PremiumRate>15</d2p1:PremiumRate>
        <d2p1:StockTransfer>7</d2p1:StockTransfer>
        <d2p1:SumInsured>12</d2p1:SumInsured>
      </d2p1:PolicyDeclarations>
      <d2p1:PolicyDeclarations>
        <d2p1:ApprovalDate>2026-01-20T12:09:37.998118-08:00</d2p1:ApprovalDate>
        <d2p1:ApprovedBy>1</d2p1:ApprovedBy>
        <d2p1:ApprovedByName>sample string 10</d2p1:ApprovedByName>
        <d2p1:CapitalGoodsPurchase>9</d2p1:CapitalGoodsPurchase>
        <d2p1:CorrectionDoneBy>1</d2p1:CorrectionDoneBy>
        <d2p1:CorrectionDoneByName>sample string 16</d2p1:CorrectionDoneByName>
        <d2p1:CorrectionDoneOn>2026-01-20T12:09:37.998118-08:00</d2p1:CorrectionDoneOn>
        <d2p1:CorrectionRequestedBy>1</d2p1:CorrectionRequestedBy>
        <d2p1:CorrectionRequestedByName>sample string 17</d2p1:CorrectionRequestedByName>
        <d2p1:CorrectionRequestedOn>2026-01-20T12:09:37.998118-08:00</d2p1:CorrectionRequestedOn>
        <d2p1:DeclarationDate>2026-01-20T12:09:37.998118-08:00</d2p1:DeclarationDate>
        <d2p1:DeclarationStatusId>1</d2p1:DeclarationStatusId>
        <d2p1:DeclaredBy>1</d2p1:DeclaredBy>
        <d2p1:DeclaredByName>sample string 11</d2p1:DeclaredByName>
        <d2p1:DomesticPurchase>8</d2p1:DomesticPurchase>
        <d2p1:DomesticSales>5</d2p1:DomesticSales>
        <d2p1:Export>4</d2p1:Export>
        <d2p1:GrossPremium>13</d2p1:GrossPremium>
        <d2p1:GrossPremiumWithGST>14</d2p1:GrossPremiumWithGST>
        <d2p1:Import>3</d2p1:Import>
        <d2p1:JobWorkMovement>6</d2p1:JobWorkMovement>
        <d2p1:PolicyDeclarationID>2</d2p1:PolicyDeclarationID>
        <d2p1:PolicyID>1</d2p1:PolicyID>
        <d2p1:PremiumRate>15</d2p1:PremiumRate>
        <d2p1:StockTransfer>7</d2p1:StockTransfer>
        <d2p1:SumInsured>12</d2p1:SumInsured>
      </d2p1:PolicyDeclarations>
    </d2p1:PolicyDeclarations>
    <d2p1:PolicyDocuments>
      <d2p1:PolicyDocument>
        <d2p1:AddedBy>1</d2p1:AddedBy>
        <d2p1:AddedByName>sample string 9</d2p1:AddedByName>
        <d2p1:AddedOn>2026-01-20T12:09:37.998118-08:00</d2p1:AddedOn>
        <d2p1:DocumentPath>sample string 5</d2p1:DocumentPath>
        <d2p1:Extension>sample string 8</d2p1:Extension>
        <d2p1:FileName>sample string 7</d2p1:FileName>
        <d2p1:IsActive>true</d2p1:IsActive>
        <d2p1:ModifiedBy>10</d2p1:ModifiedBy>
        <d2p1:ModifiedByName>sample string 12</d2p1:ModifiedByName>
        <d2p1:ModifiedOn>2026-01-20T12:09:37.998118-08:00</d2p1:ModifiedOn>
        <d2p1:PolicyDocumentID>2</d2p1:PolicyDocumentID>
        <d2p1:PolicyDocumentTypeID>3</d2p1:PolicyDocumentTypeID>
        <d2p1:PolicyDocumentTypeName>sample string 4</d2p1:PolicyDocumentTypeName>
        <d2p1:PolicyID>1</d2p1:PolicyID>
      </d2p1:PolicyDocument>
      <d2p1:PolicyDocument>
        <d2p1:AddedBy>1</d2p1:AddedBy>
        <d2p1:AddedByName>sample string 9</d2p1:AddedByName>
        <d2p1:AddedOn>2026-01-20T12:09:37.998118-08:00</d2p1:AddedOn>
        <d2p1:DocumentPath>sample string 5</d2p1:DocumentPath>
        <d2p1:Extension>sample string 8</d2p1:Extension>
        <d2p1:FileName>sample string 7</d2p1:FileName>
        <d2p1:IsActive>true</d2p1:IsActive>
        <d2p1:ModifiedBy>10</d2p1:ModifiedBy>
        <d2p1:ModifiedByName>sample string 12</d2p1:ModifiedByName>
        <d2p1:ModifiedOn>2026-01-20T12:09:37.998118-08:00</d2p1:ModifiedOn>
        <d2p1:PolicyDocumentID>2</d2p1:PolicyDocumentID>
        <d2p1:PolicyDocumentTypeID>3</d2p1:PolicyDocumentTypeID>
        <d2p1:PolicyDocumentTypeName>sample string 4</d2p1:PolicyDocumentTypeName>
        <d2p1:PolicyID>1</d2p1:PolicyID>
      </d2p1:PolicyDocument>
    </d2p1:PolicyDocuments>
    <d2p1:PolicyExcessCustomValue>14</d2p1:PolicyExcessCustomValue>
    <d2p1:PolicyExcessID>12</d2p1:PolicyExcessID>
    <d2p1:PolicyFragileItemsExcessCustomValue>15</d2p1:PolicyFragileItemsExcessCustomValue>
    <d2p1:PolicyFragileItemsExcessID>13</d2p1:PolicyFragileItemsExcessID>
    <d2p1:PolicyID>1</d2p1:PolicyID>
    <d2p1:PolicyIssuerID>4</d2p1:PolicyIssuerID>
    <d2p1:PolicyIssuerName>sample string 5</d2p1:PolicyIssuerName>
    <d2p1:PolicyNumber>sample string 6</d2p1:PolicyNumber>
    <d2p1:PolicyStatusID>1</d2p1:PolicyStatusID>
    <d2p1:PolicyStatusName>sample string 28</d2p1:PolicyStatusName>
    <d2p1:PolicyTypeID>26</d2p1:PolicyTypeID>
    <d2p1:PolicyTypeName>sample string 27</d2p1:PolicyTypeName>
    <d2p1:PremiumRate>35</d2p1:PremiumRate>
    <d2p1:Rate>10</d2p1:Rate>
    <d2p1:StatusHistory>
      <d2p1:PolicyStatus>
        <d2p1:ModifiedBy>3</d2p1:ModifiedBy>
        <d2p1:ModifiedOn>2026-01-20T12:09:37.998118-08:00</d2p1:ModifiedOn>
        <d2p1:PolicyStatusID>1</d2p1:PolicyStatusID>
        <d2p1:PolicyStatusName>sample string 2</d2p1:PolicyStatusName>
      </d2p1:PolicyStatus>
      <d2p1:PolicyStatus>
        <d2p1:ModifiedBy>3</d2p1:ModifiedBy>
        <d2p1:ModifiedOn>2026-01-20T12:09:37.998118-08:00</d2p1:ModifiedOn>
        <d2p1:PolicyStatusID>1</d2p1:PolicyStatusID>
        <d2p1:PolicyStatusName>sample string 2</d2p1:PolicyStatusName>
      </d2p1:PolicyStatus>
    </d2p1:StatusHistory>
    <d2p1:TermsOfSales>
      <d2p1:TermsOfSales>
        <d2p1:IsActive>true</d2p1:IsActive>
        <d2p1:PolicyID>4</d2p1:PolicyID>
        <d2p1:RelationshipID>5</d2p1:RelationshipID>
        <d2p1:TermID>1</d2p1:TermID>
        <d2p1:TermTitle>sample string 2</d2p1:TermTitle>
      </d2p1:TermsOfSales>
      <d2p1:TermsOfSales>
        <d2p1:IsActive>true</d2p1:IsActive>
        <d2p1:PolicyID>4</d2p1:PolicyID>
        <d2p1:RelationshipID>5</d2p1:RelationshipID>
        <d2p1:TermID>1</d2p1:TermID>
        <d2p1:TermTitle>sample string 2</d2p1:TermTitle>
      </d2p1:TermsOfSales>
    </d2p1:TermsOfSales>
  </Policy>
</AddPolicyRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddPolicyResponse

Name	Description	Type	Additional information
PolicyID		integer	None.
Result		Response	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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