1. Home
  2. bolt/unlock

PUT bolt/unlock

This resource is used to unlock bolt.
As the request is passed to other services and response is synchronus unlock-id is returned in response.
It should be used to check bolt unlock operation status.
Current status is returned in response.

Resource URL

https://api.safeguard24.eu/{version}/bolt/unlock

Parameters

Parameter Description Required Default
number Trailer registration number, no spaces and special chars, only [A-Z0-9] characters accepted. Length: 7 characters. yes none
unlock_code Trailer unlock code, only [0-9] characters accepted. Length 7 digits. yes none

Example

PUT
https://api.safeguard24.eu/v1.0/bolt/unlock

Request body

  number: ELE78UT
  unlock_code: 0044161

Response body

  {
    "error": false,
    "msg": "Bolt unlock accepted",
    "status": 200,
    "_data" : {
      "unlock-id":  1397601756895433440,
      "unlock-status": "SENT"
    }
  }

Error Response

  {
    "error": true,
    "msg": "Wrong unlock code",
    "status": 400
  }

Resource Information

API version v1.0
Method PUT
Authentication HMAC
Response Format JSON