You are here:
InsPolicyService:getInsuredItems
Use this service to find and return insured items and insured parties from a policy (asset).
You can use this service in OmniScripts and Integration Procedures for modifying and canceling policies, to get the insured items and insured parties available in the current policy.
You can get a specific insured item, a subset of insured items, or all of them, based on your options.
Method: getInsuredItems
How It Works
-
Uses the
assetIdorpolicyIdto find the policy (asset) to search. -
Finds the insured item object and/or held product relationship object (insured parties) associated with the policy. If
productCodeand/orinstanceKeyare specified, finds only those insured items or insured parties that have the specified code or key. -
Returns a JSON that contains the attributes of the insured items and insured parties, and their instance keys.
Remote Options
Output JSON
The service returns a JSON that contains an array of insured parties and insured items by product code.
In this example, only an assetId was specified, so all insured
items are returned.
{
"error": "OK",
"Step1": {
"AUTO": [{
"VehicleType": "PASSENGER CAR",
"isPrimary": true,
"isParent": true,
"autoInstanceKey": "2015 Lexus LX250",
"est_annual_mileage": "1-10000",
"BodyClass": "Sedan/Saloon",
"autoYear": 2015,
"autoModel": "LX250",
"autoLicNum": "Lexus",
"autoAntiTheft": false
},
{
"VehicleType": "MULTIPURPOSE PASSENGER VEHICLE (MPV)",
"isPrimary": true,
"isParent": true,
"autoInstanceKey": "2006 Honda Odyssey",
"est_annual_mileage": "1-10000",
"BodyClass": "Minivan",
"autoYear": 2006,
"autoModel": "Odyssey",
"autoLicNum": "Honda",
"autoAntiTheft": false
},
{
"VehicleType": "PASSENGER CAR",
"isPrimary": true,
"isParent": true,
"autoInstanceKey": "2018 530 BMW",
"est_annual_mileage": "1-10000",
"BodyClass": "Sedan/Saloon",
"autoYear": 2018,
"autoModel": "BMW",
"autoLicNum": "530",
"autoAntiTheft": false
},
{
"VehicleType": "PASSENGER CAR",
"isPrimary": true,
"isParent": true,
"autoInstanceKey": "2016 Camry Toyota",
"est_annual_mileage": "1-10000",
"BodyClass": "Sedan/Saloon",
"autoYear": 2016,
"autoModel": "Toyota",
"autoLicNum": "Camry",
"autoAntiTheft": false
}
],
"DRIVER": [{
"LN": "Smith",
"LastName": "Smith",
"isPrimary": false,
"isParent": false,
"driverInstanceKey": "Joan Smith",
"GENDER": "Female",
"FN": "Joan",
"FirstName": "Joan",
"AGE": 20
},
{
"LN": "Smith",
"LastName": "Smith",
"isPrimary": false,
"isParent": false,
"driverInstanceKey": "John Smith",
"GENDER": "Male",
"FN": "John",
"FirstName": "John",
"AGE": 30
},
{
"LN": "Henderson",
"LastName": "Henderson",
"isPrimary": false,
"isParent": false,
"driverInstanceKey": "Robert Henderson",
"GENDER": "Male",
"FN": "Robert",
"FirstName": "Robert",
"AGE": 30
},
{
"LN": "Schell",
"LastName": "Schell",
"isPrimary": false,
"isParent": false,
"driverInstanceKey": "Kinsey Schell",
"GENDER": "Female",
"FN": "Kinsey",
"FirstName": "Kinsey",
"AGE": 20
}
]
}
}