Gate Codes (Facility Level)

>>>

POST /v1/:facility_id/gate_codes/availability_check
Check gate code availability

Params

Param name Description
availability_check
required

Validations:

  • Must be a Hash
availability_check[gate_access_code]
required

A gate code to check availability for

Validations:

  • Must be a String

Examples

POST /v1/2b3de672-9f75-4dc8-b042-ef85fa639ff2/gate_codes/availability_check
{
  "availability_check": {
    "gate_access_code": 10000
  },
  "gate_code": {
    "availability_check": {
      "gate_access_code": 10000
    }
  }
}
200
{
  "availability_check": {
    "gate_access_code": "10000",
    "available": true
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "POST",
    "request_id": null,
    "parameters": {
      "availability_check": {
        "gate_access_code": 10000
      },
      "facility_id": "2b3de672-9f75-4dc8-b042-ef85fa639ff2",
      "gate_code": {
        "availability_check": {
          "gate_access_code": 10000
        }
      }
    }
  }
}
>>>

GET /v1/:facility_id/access_points
Provides a list of cloud access points for a facility

>>>

POST /v1/:facility_id/gate_codes/open
Opens a gate

Params

Param name Description
gate_code
required

Validations:

  • Must be a String
access_point_id
required

Validations:

  • Must be a String