Add Pass Authorization

Last Updated on : 2022-06-01 10:01:01

Add the pass authorization for a specified vehicle.


  • It is used to add a pass authorization credential to the vehicle for a specified time period. The time period is not strictly limited, such as day, month, and year.
  • Support vehicles with monthly payment plans, purchased parking spaces, and long-term payment plans.

API address

POST: /v1.0/parking-control/{device_id}/pass-authorizations/{pass_authorization_id}

Request parameter

Parameter nameTypeINRequiredDescription
device_idStringuritrueThe ID of a specified device in the parking lot.
pass_authorization_idStringuritrueThe ID of the pass authorization.

Description of body

Parameter nameTypeINRequiredDescription
pass_authorization_idString trueThe ID of the pass authorization.
pass_authorization_ownerString trueThe name of the authorized user.
begin_timeLong trueThe timestamp of the start time of a specified pass authorization. Unit: milliseconds.
end_timeLong trueThe timestamp of the end time of a specified pass authorization. Unit: milliseconds.
pass_authorization_car_infosList trueThe information about vehicles that are linked with the pass authorization. Up to 10 vehicles can be linked with one pass authorization.

Description of pass_authorization_car_infos

Parameter nameTypeINRequiredDescription
plate_noString trueThe license plate number.
device_idsList falseA collection of device IDs. If the value is empty, the vehicle can pass all barrier gates in the parking lot.

Return parameter

Parameter nameTypeDescription
resultCmdIssueResultResponseThe returned result.

Description of result

Parameter nameTypeDescription
snStringThe command record ID.

Request example

POST: /v1.0/parking-control/6ce****/pass-authorizations/123****
  "passAuthorizationId": "1",
  "passAuthorizationOwner": "Lee**",
  "beginTime": 1652699604013,
  "endTime": 1655378004000,
  "passAuthorizationCarInfos": [
      "plateNo": "A1***5"

Return example

    "result": {
        "sn": "135****"
    "t": 1652779976771,
    "success": true

Error code

For more information, see error code.