Skip to main content

Identifiers API 1.5.0

Identifiers, card numbers and identifier-related operations.

Base path: https://{controller_ip}/api/v1. API description version: 1.5.0.

Examples use placeholder values for passwords, tokens, UUIDs, addresses and secrets. Replace them with values from your controller before sending requests.

Section methods​

MethodPath
GET/identifier/generate
GET/identifier/{code}
GET/identifiers
GET/identifiers/count
GET/identifiers/ext_privileges
GET/identifiers/search
GET/identifiers/sort
POST/identifiers
PUT/identifiers/{code}
DELETE/identifiers/{code}

GET /identifier/generate​

Section: Identifiers.

Returns data for the identifiers endpoint /identifier/generate.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/identifier/generate" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/identifier/generate" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/identifier/generate"
  }
}

GET /identifier/{code}​

Section: Identifiers.

Returns data for the identifiers endpoint /identifier/{code}.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/identifier/{code}" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/identifier/{code}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/identifier/{code}"
  }
}

GET /identifiers​

Section: Identifiers.

Returns data for the identifiers endpoint /identifiers.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/identifiers" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/identifiers" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/identifiers"
  }
}

GET /identifiers/count​

Section: Identifiers.

Returns a count for the identifiers endpoint /identifiers/count.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/identifiers/count" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/identifiers/count" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "count": 12
}

GET /identifiers/ext_privileges​

Section: Identifiers.

Returns data for the identifiers endpoint /identifiers/ext_privileges.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/identifiers/ext_privileges" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/identifiers/ext_privileges" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/identifiers/ext_privileges"
  }
}

Section: Identifiers.

Returns data for the identifiers endpoint /identifiers/search.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/identifiers/search" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/identifiers/search" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/identifiers/search"
  }
}

GET /identifiers/sort​

Section: Identifiers.

Returns sorting metadata for the identifiers endpoint /identifiers/sort.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/identifiers/sort" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/identifiers/sort" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/identifiers/sort"
  }
}

POST /identifiers​

Section: Identifiers.

Creates a record or starts an operation for the identifiers endpoint /identifiers.

Request example​

curl -k -X POST "https://{controller_ip}/api/v1/identifiers" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "code": "<card_code>",
  "type": "card",
  "active": true
}'

Request body example​

{
  "code": "<card_code>",
  "type": "card",
  "active": true
}

Response command example​

curl -k -sS -X POST "https://{controller_ip}/api/v1/identifiers" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

PUT /identifiers/{code}​

Section: Identifiers.

Updates data for the identifiers endpoint /identifiers/{code}.

Request example​

curl -k -X PUT "https://{controller_ip}/api/v1/identifiers/{code}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "code": "<card_code>",
  "type": "card",
  "active": true
}'

Request body example​

{
  "code": "<card_code>",
  "type": "card",
  "active": true
}

Response command example​

curl -k -sS -X PUT "https://{controller_ip}/api/v1/identifiers/{code}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

DELETE /identifiers/{code}​

Section: Identifiers.

Deletes data for the identifiers endpoint /identifiers/{code}.

Request example​

curl -k -X DELETE "https://{controller_ip}/api/v1/identifiers/{code}" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X DELETE "https://{controller_ip}/api/v1/identifiers/{code}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "deleted": true
}