Cloud Services API ReferenceAdvanced Device ServicesExtension APIsThird-Party Industry Device CapabilitiesVehicle ServiceVisitor VehicleAdd Visitor Vehicle

Add Visitor Vehicle

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

Add the information about a specified visitor vehicle. Its accessible end time must be greater than the accessible start time.

API address

POST: /v1.0/parking-control/{device_id}/visitor-cars/{visitor_car_id}

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	uri	true	The ID of a specified device in the parking lot.
visitor_car_id	String	uri	true	The ID of a specified visitor vehicle.

Description of body

Parameter name	Type	Required	Description
visitor_car_id	String	true	The ID of a specified visitor vehicle.
plate_no	String	true	The license plate number of a specified visitor vehicle.
visitor_name	String	true	The name of a specified visitor.
begin_time	Long	true	The start time of the accessible period for a specified visitor vehicle.
end_time	Long	true	The end time of the accessible period for a specified visitor vehicle.
visitor_phone	String	true	The mobile phone number of the visitor.

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****/visitor-cars/123****

{
  "visitorCarId": "1",
  "plateNo": "A1***5",
  "visitorName": "Lee**",
  "beginTime": 1652777782808,
  "endTime": 1655456182000,
  "visitorPhone": "133****1234"
}

Return example

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

Error code

For more information, see error code.

Prev DocDelete Visitor Vehicle

Next DocExtend Accessible Period of Visitor Vehicle