Access Codes

Create Access Codes

Generate new access code(s)

Endpoint

POST /access-codes

Parameters

Name	Type	Required	Description
location_id	string	✔️	Location / venue ID
service_profile_id	string		Service profile ID for the access code(s). If not provided service profile for the given location is used
guest_id	string		Guest ID
type	integer	✔️	Type of the access code. Values: 1: Shared, 2: Access Code
code	string		Static shared code to be used. Required when type is Shared.
quantity	integer		Number of access codes to be generated. Default: 1
start_date	date		Start date of the code. Format: YYYY-MM-DD
expiry_date	date		Expiry date of the code. Format: YYYY-MM-DD
description	string

Response

TIP

Create single code

HTTP/1.1 201 Created

{
  "data": {
    "status": true,
    "message": "Created 1 code",
    "count": 1,
    "access_code": {
      "id": "ApR3zO7zqeZ",
      "location_id": "rdb6XWwXQ2j",
      "location_name": "Default Location",
      "code": "u2",
      "type": 2,
      "type_name": "Access Code",
      "description": null,
      "service_profile_id": "KPGD8j3xW25",
      "service_profile_name": "Default Service Profile - 60 Minute(s)",
      "start_date": null,
      "expiry_date": null,
      "status": 1,
      "status_name": "Available",
      "use_count": 0,
      "used_at": null,
      "guest_id": null,
      "guest_name": "",
      "created_at": "2017-01-04T09:55:31.000000Z"
    }  
  }
}

TIP

Create multiple codes

HTTP/1.1 201 Created

When multiple access codes are created the first one will be returned in the response.

{
  "data": {
    "status": true,
    "message": "Created 10 codes",
    "count": 10,
    "access_code": {
      "id": "ApR3zO7zqeZ",
      "location_id": "rdb6XWwXQ2j",
      "location_name": "Default Location",
      "code": "u2",
      "type": 2,
      "type_name": "Access Code",
      "description": null,
      "service_profile_id": "KPGD8j3xW25",
      "service_profile_name": "Default Service Profile - 60 Minute(s)",
      "start_date": null,
      "expiry_date": null,
      "status": 1,
      "status_name": "Available",
      "use_count": 0,
      "used_at": null,
      "guest_id": null,
      "guest_name": "",
      "created_at": "2017-01-04T09:55:31.000000Z"
    }
  }
}

Unprocessible Entity

HTTP/1.1 422 Unprocessible Entity

{
    "message": "The given data was invalid.",
    "errors": {
        "location_id": [
            "The location field is required."
        ]
    }
}

DANGER

HTTP/1.1 500 Internal Server Error

{
  "data": {
    "status": false,
    "message": "Could not create any access codes"
  }
}