Factsheet

1.3: Request format

Requests should always take the format below:

{
        "srvcVrsn": "2",
        "userInfo": {
                "id": "1234567890abcdefghij1234567890ab",
                "athrzt": {
                        "id": "1234567890abcdefghij1234567890ab",
                        "key": "1234567890abcdefghij1234567890ab"
                }
        },
        "cmmnd": {
                "cmmnd": "...",
                "seed": {...}
        }
}
Data idMeaningFurther Info
srvcVrsnThis data stands for the version of the service being requested.Since version 1 has been discontinued and version 2 is the active version, the value should be 2.
userInfo.idThis data stands for your Octamile issued ID.
userInfo.athrzt.idThis data stands for your authorization ID.
userInfo.athrzt.keyThis data stands for your authorization key.
cmmnd.cmmndThis data stands for the command to be executed.The way you would manage your insurances is by issuing commands to our arms.
cmmnd.seedThis data stands for the additional data required by the command.Some commands require additional data. Under such circumstances, the additional data should be embedded herein.