Swagger docs:
https://testing-api.keyholding.com/swagger-ui.html#/
The example below is a typical alarm booking:
- The property ID is our internal demonstration property for testing
- The service ID is our standard alarm call, but multiple services are available with different IDs
- The notes are optional
- The instructions are individual pieces of information that are often sent to the attending officer (with the exception of internal/client reference numbers). These must be sent to the correct IDs so that we can show them in the correct places in our mobile app.
{
"property_id": "a9df1d45-3a3f-59f2-fee0-07f486ac02c8",
"service_id": "ca350966-823b-b16b-58d0-0443d135c504",
"notes": [
{
"value": "Free-text that can be sent to the attending officer"
}
],
"instructions": [
{
"instruction_type_id": "243d935a-f8eb-dabe-d14c-c39df90d0dfc",
"value": "Monitoring Station Name"
},
{
"instruction_type_id": "6c8d7444-5941-4ad7-acfc-1fd0d390107e",
"value": "Type of alarm call"
},
{
"instruction_type_id": "199f5882-55e0-c4e4-4327-52146f0d77f3",
"value": "Type of alarm activation"
},
{
"instruction_type_id": "85bee466-1e2d-7861-ead5-38cbdce1839b",
"value": "Status of alarm activation"
},
{
"instruction_type_id": "cf0268de-9d0b-a2f3-5eab-93726d7171bf",
"value": "Third party attendees"
},
{
"instruction_type_id": "80d9c633-802a-f11c-48fa-15d9a4e66ddc",
"value": "Your reference number"
}
]
}
Here is an example populated with real values:
{
"property_id": "a9df1d45-3a3f-59f2-fee0-07f486ac02c8",
"service_id": "ca350966-823b-b16b-58d0-0443d135c504",
"notes": [
{
"value": "Please check zone 3 on the 5th floor"
}
],
"instructions": [
{
"instruction_type_id": "243d935a-f8eb-dabe-d14c-c39df90d0dfc",
"value": "Custodian"
},
{
"instruction_type_id": "6c8d7444-5941-4ad7-acfc-1fd0d390107e",
"value": "Intruder"
},
{
"instruction_type_id": "199f5882-55e0-c4e4-4327-52146f0d77f3",
"value": "Battery fail"
},
{
"instruction_type_id": "85bee466-1e2d-7861-ead5-38cbdce1839b",
"value": "Monitored"
},
{
"instruction_type_id": "cf0268de-9d0b-a2f3-5eab-93726d7171bf",
"value": "Police"
},
{
"instruction_type_id": "80d9c633-802a-f11c-48fa-15d9a4e66ddc",
"value": "123092302"
}
]
}