Skip to main content

GET - List of points in location

List of points in location

Request​

  • Method: GET
  • Endpoint: /locations/{id}/points
  • Base URL: https://api.targpatrol.com/api/v1
  • Operation ID: get-points-by-id

Authorization​

This endpoint requires an external API key.

x-api-key: {your_external_api_key}

Parameters​

NameInRequiredSchemaDescription
limitquerynointegerinclude first N items of a resource collection
offsetquerynonumberexclude first N items of a resource collection

Responses​

200 OK​

Content-Type: application/json Schema: object

Schema
{
  "allOf": [
    {
      "$ref": "#/components/schemas/PageResponse"
    },
    {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/PointResponse"
          }
        }
      }
    }
  ]
}

Example: example-1

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "locationId": "12a8af51-52f6-409b-82c2-08bbd5df18c2",
      "name": "P001",
      "type": "VIRTUAL",
      "address": null,
      "latitude": null,
      "longitude": null,
      "graphicPlans": [],
      "rfidCode": null,
      "qrCode": null,
      "allowOnDemandCheckIn": true,
      "onDemandCheckInDefaults": [
        {
          "actionId": "064d33e5-ddff-42b7-a3e2-80a870396cf7",
          "actionOrder": 1
        },
        {
          "actionId": "38c70628-870a-4b39-9492-1c23bfc3ef2e",
          "actionOrder": 2
        }
      ],
      "onDemandCheckInUserOverrides": [
        {
          "actionId": "064d33e5-ddff-42b7-a3e2-80a870396cf7",
          "actionOrder": 1,
          "groupName": "Employees",
          "userId": "c6dd00e4-eee3-4fb2-95ba-4f53b7a61b78"
        },
        {
          "actionId": "38c70628-870a-4b39-9492-1c23bfc3ef2e",
          "actionOrder": 2,
          "groupName": "Employees",
          "userId": "c6dd00e4-eee3-4fb2-95ba-4f53b7a61b78"
        }
      ],
      "tags": [
        "tag1"
      ]
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 20,
    "count": 15,
    "sort": [
      {
        "property": "id",
        "direction": "asc"
      }
    ]
  }
}

400 Bad Request​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "invalid input data",
  "code": "input.data.invalid",
  "timestamp": "2023-03-07T05:57:59.315Z",
  "details": [
    {
      "message": "invalid data type",
      "code": "data.type.invalid",
      "identifier": "id",
      "args": [
        "[UUID]"
      ]
    }
  ]
}

401 Unauthorized​

500 Internal Server Error​

Content-Type: application/json Schema: ErrorResponse

Schema
{
  "$ref": "#/components/schemas/ErrorResponse"
}

Example: example-1

{
  "message": "internal server error",
  "code": "internal.server.error",
  "timestamp": "2023-03-07T05:57:59.315Z"
}