GET v1/Policies/{policyID}/GeneralLocations?pageNumber={pageNumber}&pageSize={pageSize}
Get a list of locations for a policy
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| policyID |
Id of the policy |
integer |
Required |
| pageNumber |
Page number |
integer |
Default value is 1 |
| pageSize |
Page size |
integer |
Default value is 100 |
Body Parameters
None.
Response Information
Resource Description
A list of locations for a policy
PageOfOfPolicyDetailsGeneralLocationDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of PolicyDetailsGeneralLocationDTO |
None. |
|
| PageNumber | integer |
None. |
|
| PagesTotal | integer |
None. |
|
| TotalItems | integer |
None. |
|
| IsSuccess | boolean |
None. |
|
| ErrorCode | string |
None. |
|
| ErrorMessage | string |
None. |
|
| DisplayMessage | string |
None. |
|
| Links | Collection of PageLink |
None. |
|
| Href | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"LocationID": 1,
"PolicyQuoteID": 2,
"LocationNumber": 3,
"Street": "sample string 4",
"City": "sample string 5",
"County": "sample string 6",
"State": "sample string 7",
"Zip": "sample string 8",
"LocationType": "sample string 9",
"AptSuiteOther": "sample string 10",
"AddressLine3": "sample string 11",
"AddressLine4": "sample string 12",
"Country": "sample string 13",
"TaxCode": "sample string 14",
"CountyTownCode": "sample string 15",
"DescriptionofOperations": "sample string 16",
"TypeofBusiness": "sample string 17",
"BuildingInterest": "sample string 18",
"PolicyDetailsGeneralBuildings": [
{
"BuildingID": 1,
"LocationID": 2,
"BuildingNumber": "sample string 3",
"Description": "sample string 4",
"Street": "sample string 5",
"City": "sample string 6",
"County": "sample string 7",
"State": "sample string 8",
"Zip": "sample string 9",
"SQFT": "sample string 10",
"SublocationTypeCode": "sample string 11",
"AddressLine1": "sample string 12",
"AddressLine2": "sample string 13",
"AddressLine3": "sample string 14",
"AddressLine4": "sample string 15",
"Country": "sample string 16",
"PhoneNumber": "sample string 17",
"Latitude": "sample string 18",
"Longitude": "sample string 19",
"RangeValue": "sample string 20",
"HorizontalCoordinateReferenceSystemCode": "sample string 21",
"NumberofMortgagees": 22
},
{
"BuildingID": 1,
"LocationID": 2,
"BuildingNumber": "sample string 3",
"Description": "sample string 4",
"Street": "sample string 5",
"City": "sample string 6",
"County": "sample string 7",
"State": "sample string 8",
"Zip": "sample string 9",
"SQFT": "sample string 10",
"SublocationTypeCode": "sample string 11",
"AddressLine1": "sample string 12",
"AddressLine2": "sample string 13",
"AddressLine3": "sample string 14",
"AddressLine4": "sample string 15",
"Country": "sample string 16",
"PhoneNumber": "sample string 17",
"Latitude": "sample string 18",
"Longitude": "sample string 19",
"RangeValue": "sample string 20",
"HorizontalCoordinateReferenceSystemCode": "sample string 21",
"NumberofMortgagees": 22
}
]
},
{
"LocationID": 1,
"PolicyQuoteID": 2,
"LocationNumber": 3,
"Street": "sample string 4",
"City": "sample string 5",
"County": "sample string 6",
"State": "sample string 7",
"Zip": "sample string 8",
"LocationType": "sample string 9",
"AptSuiteOther": "sample string 10",
"AddressLine3": "sample string 11",
"AddressLine4": "sample string 12",
"Country": "sample string 13",
"TaxCode": "sample string 14",
"CountyTownCode": "sample string 15",
"DescriptionofOperations": "sample string 16",
"TypeofBusiness": "sample string 17",
"BuildingInterest": "sample string 18",
"PolicyDetailsGeneralBuildings": [
{
"BuildingID": 1,
"LocationID": 2,
"BuildingNumber": "sample string 3",
"Description": "sample string 4",
"Street": "sample string 5",
"City": "sample string 6",
"County": "sample string 7",
"State": "sample string 8",
"Zip": "sample string 9",
"SQFT": "sample string 10",
"SublocationTypeCode": "sample string 11",
"AddressLine1": "sample string 12",
"AddressLine2": "sample string 13",
"AddressLine3": "sample string 14",
"AddressLine4": "sample string 15",
"Country": "sample string 16",
"PhoneNumber": "sample string 17",
"Latitude": "sample string 18",
"Longitude": "sample string 19",
"RangeValue": "sample string 20",
"HorizontalCoordinateReferenceSystemCode": "sample string 21",
"NumberofMortgagees": 22
},
{
"BuildingID": 1,
"LocationID": 2,
"BuildingNumber": "sample string 3",
"Description": "sample string 4",
"Street": "sample string 5",
"City": "sample string 6",
"County": "sample string 7",
"State": "sample string 8",
"Zip": "sample string 9",
"SQFT": "sample string 10",
"SublocationTypeCode": "sample string 11",
"AddressLine1": "sample string 12",
"AddressLine2": "sample string 13",
"AddressLine3": "sample string 14",
"AddressLine4": "sample string 15",
"Country": "sample string 16",
"PhoneNumber": "sample string 17",
"Latitude": "sample string 18",
"Longitude": "sample string 19",
"RangeValue": "sample string 20",
"HorizontalCoordinateReferenceSystemCode": "sample string 21",
"NumberofMortgagees": 22
}
]
}
],
"PageNumber": 1,
"PagesTotal": 2,
"TotalItems": 3,
"IsSuccess": true,
"ErrorCode": "sample string 5",
"ErrorMessage": "sample string 6",
"DisplayMessage": "sample string 7",
"Links": [
{
"Rel": "sample string 1",
"Href": "sample string 2"
},
{
"Rel": "sample string 1",
"Href": "sample string 2"
}
],
"Href": "sample string 8"
}
application/xml, text/xml
Sample:
<PageOfPolicyDetailsGeneralLocationDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
<d2p1:PolicyDetailsGeneralLocationDTO>
<d2p1:AddressLine3>sample string 11</d2p1:AddressLine3>
<d2p1:AddressLine4>sample string 12</d2p1:AddressLine4>
<d2p1:AptSuiteOther>sample string 10</d2p1:AptSuiteOther>
<d2p1:BuildingInterest>sample string 18</d2p1:BuildingInterest>
<d2p1:City>sample string 5</d2p1:City>
<d2p1:Country>sample string 13</d2p1:Country>
<d2p1:County>sample string 6</d2p1:County>
<d2p1:CountyTownCode>sample string 15</d2p1:CountyTownCode>
<d2p1:DescriptionofOperations>sample string 16</d2p1:DescriptionofOperations>
<d2p1:LocationID>1</d2p1:LocationID>
<d2p1:LocationNumber>3</d2p1:LocationNumber>
<d2p1:LocationType>sample string 9</d2p1:LocationType>
<d2p1:PolicyDetailsGeneralBuildings>
<d2p1:PolicyDetailsGeneralBuildingDTO>
<d2p1:AddressLine1>sample string 12</d2p1:AddressLine1>
<d2p1:AddressLine2>sample string 13</d2p1:AddressLine2>
<d2p1:AddressLine3>sample string 14</d2p1:AddressLine3>
<d2p1:AddressLine4>sample string 15</d2p1:AddressLine4>
<d2p1:BuildingID>1</d2p1:BuildingID>
<d2p1:BuildingNumber>sample string 3</d2p1:BuildingNumber>
<d2p1:City>sample string 6</d2p1:City>
<d2p1:Country>sample string 16</d2p1:Country>
<d2p1:County>sample string 7</d2p1:County>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:HorizontalCoordinateReferenceSystemCode>sample string 21</d2p1:HorizontalCoordinateReferenceSystemCode>
<d2p1:Latitude>sample string 18</d2p1:Latitude>
<d2p1:LocationID>2</d2p1:LocationID>
<d2p1:Longitude>sample string 19</d2p1:Longitude>
<d2p1:NumberofMortgagees>22</d2p1:NumberofMortgagees>
<d2p1:PhoneNumber>sample string 17</d2p1:PhoneNumber>
<d2p1:RangeValue>sample string 20</d2p1:RangeValue>
<d2p1:SQFT>sample string 10</d2p1:SQFT>
<d2p1:State>sample string 8</d2p1:State>
<d2p1:Street>sample string 5</d2p1:Street>
<d2p1:SublocationTypeCode>sample string 11</d2p1:SublocationTypeCode>
<d2p1:Zip>sample string 9</d2p1:Zip>
</d2p1:PolicyDetailsGeneralBuildingDTO>
<d2p1:PolicyDetailsGeneralBuildingDTO>
<d2p1:AddressLine1>sample string 12</d2p1:AddressLine1>
<d2p1:AddressLine2>sample string 13</d2p1:AddressLine2>
<d2p1:AddressLine3>sample string 14</d2p1:AddressLine3>
<d2p1:AddressLine4>sample string 15</d2p1:AddressLine4>
<d2p1:BuildingID>1</d2p1:BuildingID>
<d2p1:BuildingNumber>sample string 3</d2p1:BuildingNumber>
<d2p1:City>sample string 6</d2p1:City>
<d2p1:Country>sample string 16</d2p1:Country>
<d2p1:County>sample string 7</d2p1:County>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:HorizontalCoordinateReferenceSystemCode>sample string 21</d2p1:HorizontalCoordinateReferenceSystemCode>
<d2p1:Latitude>sample string 18</d2p1:Latitude>
<d2p1:LocationID>2</d2p1:LocationID>
<d2p1:Longitude>sample string 19</d2p1:Longitude>
<d2p1:NumberofMortgagees>22</d2p1:NumberofMortgagees>
<d2p1:PhoneNumber>sample string 17</d2p1:PhoneNumber>
<d2p1:RangeValue>sample string 20</d2p1:RangeValue>
<d2p1:SQFT>sample string 10</d2p1:SQFT>
<d2p1:State>sample string 8</d2p1:State>
<d2p1:Street>sample string 5</d2p1:Street>
<d2p1:SublocationTypeCode>sample string 11</d2p1:SublocationTypeCode>
<d2p1:Zip>sample string 9</d2p1:Zip>
</d2p1:PolicyDetailsGeneralBuildingDTO>
</d2p1:PolicyDetailsGeneralBuildings>
<d2p1:PolicyQuoteID>2</d2p1:PolicyQuoteID>
<d2p1:State>sample string 7</d2p1:State>
<d2p1:Street>sample string 4</d2p1:Street>
<d2p1:TaxCode>sample string 14</d2p1:TaxCode>
<d2p1:TypeofBusiness>sample string 17</d2p1:TypeofBusiness>
<d2p1:Zip>sample string 8</d2p1:Zip>
</d2p1:PolicyDetailsGeneralLocationDTO>
<d2p1:PolicyDetailsGeneralLocationDTO>
<d2p1:AddressLine3>sample string 11</d2p1:AddressLine3>
<d2p1:AddressLine4>sample string 12</d2p1:AddressLine4>
<d2p1:AptSuiteOther>sample string 10</d2p1:AptSuiteOther>
<d2p1:BuildingInterest>sample string 18</d2p1:BuildingInterest>
<d2p1:City>sample string 5</d2p1:City>
<d2p1:Country>sample string 13</d2p1:Country>
<d2p1:County>sample string 6</d2p1:County>
<d2p1:CountyTownCode>sample string 15</d2p1:CountyTownCode>
<d2p1:DescriptionofOperations>sample string 16</d2p1:DescriptionofOperations>
<d2p1:LocationID>1</d2p1:LocationID>
<d2p1:LocationNumber>3</d2p1:LocationNumber>
<d2p1:LocationType>sample string 9</d2p1:LocationType>
<d2p1:PolicyDetailsGeneralBuildings>
<d2p1:PolicyDetailsGeneralBuildingDTO>
<d2p1:AddressLine1>sample string 12</d2p1:AddressLine1>
<d2p1:AddressLine2>sample string 13</d2p1:AddressLine2>
<d2p1:AddressLine3>sample string 14</d2p1:AddressLine3>
<d2p1:AddressLine4>sample string 15</d2p1:AddressLine4>
<d2p1:BuildingID>1</d2p1:BuildingID>
<d2p1:BuildingNumber>sample string 3</d2p1:BuildingNumber>
<d2p1:City>sample string 6</d2p1:City>
<d2p1:Country>sample string 16</d2p1:Country>
<d2p1:County>sample string 7</d2p1:County>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:HorizontalCoordinateReferenceSystemCode>sample string 21</d2p1:HorizontalCoordinateReferenceSystemCode>
<d2p1:Latitude>sample string 18</d2p1:Latitude>
<d2p1:LocationID>2</d2p1:LocationID>
<d2p1:Longitude>sample string 19</d2p1:Longitude>
<d2p1:NumberofMortgagees>22</d2p1:NumberofMortgagees>
<d2p1:PhoneNumber>sample string 17</d2p1:PhoneNumber>
<d2p1:RangeValue>sample string 20</d2p1:RangeValue>
<d2p1:SQFT>sample string 10</d2p1:SQFT>
<d2p1:State>sample string 8</d2p1:State>
<d2p1:Street>sample string 5</d2p1:Street>
<d2p1:SublocationTypeCode>sample string 11</d2p1:SublocationTypeCode>
<d2p1:Zip>sample string 9</d2p1:Zip>
</d2p1:PolicyDetailsGeneralBuildingDTO>
<d2p1:PolicyDetailsGeneralBuildingDTO>
<d2p1:AddressLine1>sample string 12</d2p1:AddressLine1>
<d2p1:AddressLine2>sample string 13</d2p1:AddressLine2>
<d2p1:AddressLine3>sample string 14</d2p1:AddressLine3>
<d2p1:AddressLine4>sample string 15</d2p1:AddressLine4>
<d2p1:BuildingID>1</d2p1:BuildingID>
<d2p1:BuildingNumber>sample string 3</d2p1:BuildingNumber>
<d2p1:City>sample string 6</d2p1:City>
<d2p1:Country>sample string 16</d2p1:Country>
<d2p1:County>sample string 7</d2p1:County>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:HorizontalCoordinateReferenceSystemCode>sample string 21</d2p1:HorizontalCoordinateReferenceSystemCode>
<d2p1:Latitude>sample string 18</d2p1:Latitude>
<d2p1:LocationID>2</d2p1:LocationID>
<d2p1:Longitude>sample string 19</d2p1:Longitude>
<d2p1:NumberofMortgagees>22</d2p1:NumberofMortgagees>
<d2p1:PhoneNumber>sample string 17</d2p1:PhoneNumber>
<d2p1:RangeValue>sample string 20</d2p1:RangeValue>
<d2p1:SQFT>sample string 10</d2p1:SQFT>
<d2p1:State>sample string 8</d2p1:State>
<d2p1:Street>sample string 5</d2p1:Street>
<d2p1:SublocationTypeCode>sample string 11</d2p1:SublocationTypeCode>
<d2p1:Zip>sample string 9</d2p1:Zip>
</d2p1:PolicyDetailsGeneralBuildingDTO>
</d2p1:PolicyDetailsGeneralBuildings>
<d2p1:PolicyQuoteID>2</d2p1:PolicyQuoteID>
<d2p1:State>sample string 7</d2p1:State>
<d2p1:Street>sample string 4</d2p1:Street>
<d2p1:TaxCode>sample string 14</d2p1:TaxCode>
<d2p1:TypeofBusiness>sample string 17</d2p1:TypeofBusiness>
<d2p1:Zip>sample string 8</d2p1:Zip>
</d2p1:PolicyDetailsGeneralLocationDTO>
</Data>
<DisplayMessage>sample string 7</DisplayMessage>
<ErrorCode>sample string 5</ErrorCode>
<ErrorMessage>sample string 6</ErrorMessage>
<Href>sample string 8</Href>
<IsSuccess>true</IsSuccess>
<Links>
<PageLink>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
</PageLink>
<PageLink>
<Href>sample string 2</Href>
<Rel>sample string 1</Rel>
</PageLink>
</Links>
<PageNumber>1</PageNumber>
<PagesTotal>2</PagesTotal>
<TotalItems>3</TotalItems>
</PageOfPolicyDetailsGeneralLocationDTO>