Cloud Services API ReferenceAdvanced Device ServicesExtension APIsThird-Party Industry Device CapabilitiesVehicle ServicePass Authorization Add Pass Authorization

Add Pass Authorization

Last Updated on : 2023-06-20 14:54:09

Add the pass authorization for a specified vehicle.

Note:
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 name	Type	IN	Required	Description
device_id	String	uri	true	The ID of a specified device in the parking lot.
pass_authorization_id	String	uri	true	The ID of the pass authorization.

Description of body

Parameter name	Type	Required	Description
pass_authorization_id	String	true	The ID of the pass authorization.
pass_authorization_owner	String	true	The name of the authorized user.
begin_time	Long	true	The timestamp of the start time of a specified pass authorization. Unit: milliseconds.
end_time	Long	true	The timestamp of the end time of a specified pass authorization. Unit: milliseconds.
pass_authorization_car_infos	List	true	The 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 name	Type	IN	Required	Description
plate_no	String		true	The license plate number.
device_ids	List		false	A collection of device IDs. If the value is empty, the vehicle can pass all barrier gates in the parking lot.

Return parameter

Parameter name	Type	Description
result	CmdIssueResultResponse	The returned result.

Description of result

Parameter name	Type	Description
sn	String	The 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.

Prev DocPass Authorization

Next DocUpdate Pass Authorization