InsurableObject

The InsurableObject represents an object that can be insured - it might be during a rental period, during transport or for a period of time after purchase. In some cases the object has a distinct identity, e.g. a vehicle with a license number, serial number or VIN code, but in cases where the object is e.g. a sofa the object can be seen as a reference to the ad itself. Typically the InsurableObject maps to the same type the platform uses to keep track of the items.

The owner of an object is associated via the UserHandle returned by the user registration call.

Just as with User, the ExternalProperties can be used to track various meta-information about the object.

InsurableObject

In the case the insurance is a insurance, the InsurableObject type is used:

{
    "objectId": "pd1234567", 
    "objectCategory": "Tools", 
    "ownerHandle": "c3a40203-edbd-46b9-b878-7812cb30b852", 
    "shortDescription": "18V power drill", 
    "description": "A really nice drill. You should really rent it. Blah blah.", 
    "objectValue": {
        "amount": 1500, 
        "currency": "SEK"
    }, 
    "externalProperties": [
        {
            "type": "ImageLink",
            "name": "Front image",
            "value": "http://some.platform.com/images/pd1235467front.jpg",
            "description": "Image showing front of object"
        },
        {
            "type": "ImageLink",
            "name": "Back image",
            "value": "http://some.platform.com/images/pd1235467back.jpg",
            "description": "Image showing back of object"
        },
        {
            "type": "Text",
            "name": "Brand",
            "value": "Husqvarna",
            "description": "Maker of the object"
        },
        {
            "type": "Text",
            "name": "Model",
            "value": "ABC123",
            "description": "Model"
        }
    ]
}

Notable fields

Property	Comment
ObjectId	The integrating platform's identifier uniquely identifying the object, oftentimes a db identity. In many cases this will represent the ad and not really the object, but with a "mostly 1:1" relationship to the object.
ObjectCategory	A category from a list that has to be defined collaboratory between the integrating platform and Omocom. Some platforms have fine-grained categories that can be used, others not.
ShortDescription	In most cases this maps to the title of the ad. The ShortDescription is used in various listings but also in the insurance letter using a writing like "an insurance on the object in your ad with title 'blah blah'". Chose something that can represent the ad in a more human-friendly way than objectId.
Description	A longer description of the object, typically the body text of the ad.
PhysicalId	A serial number of the object, e.g. VIN of a vehicle, or other permanent identity. Note that car registration numbers should go into an ExternalProperty named LicensePlate - see below). Leave blank if no such identity exists.

External Properties

While the External Properties are relatively free form by nature there are some property key names that are commonly used. Some of the properties can be required if outlined in the agreement between the integrating platform and Omocom.

Key	Purpose
LicensePlate	Registration number of a vehicle
ReservationId	If different from Ad ID
VehicleColor
VehicleMaker
VehicleMileage
VehicleModel
VehicleYear