Link label

POST

/tracking_integrations/reelables/assets/labels/link/v1/:asset_id

POST

/tracking_integrations/reelables/assets/labels/link/v1/:asset_id

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.trackingIntegrations.reelables.assets.linkLabelV1("asset_id", {
8         nfc_id: "nfc_id",
9     });
10 }
11 main();

1 {
2   "_id": "_id",
3   "asset_id": "asset_id",
4   "name": "name",
5   "org_id": "org_id",
6   "schema_version": 1,
7   "workspace_id": "workspace_id",
8   "created_at_timestamp": "2024-01-15T09:30:00Z",
9   "destination_geofence_location": {
10     "geometry": {
11       "type": "GeometryCollection",
12       "geometries": [
13         {
14           "type": "LineString",
15           "coordinates": [
16             []
17           ]
18         }
19       ]
20     },
21     "type": "Feature",
22     "bbox": [
23       {
24         "key": "value"
25       }
26     ],
27     "id": 1,
28     "properties": {
29       "address": "address",
30       "name": "name"
31     }
32   },
33   "destination_geofence_radius_miles": 1.1,
34   "label": {
35     "added_at_timestamp": "2024-01-15T09:30:00Z",
36     "ble_id": 1,
37     "nfc_id": "nfc_id",
38     "config__reporting_interval": "config__reporting_interval"
39   },
40   "last_seen_at_location": {
41     "geometry": {
42       "type": "GeometryCollection",
43       "geometries": [
44         {
45           "type": "LineString",
46           "coordinates": [
47             []
48           ]
49         }
50       ]
51     },
52     "type": "Feature",
53     "bbox": [
54       {
55         "key": "value"
56       }
57     ],
58     "id": 1,
59     "properties": {
60       "address": "address",
61       "name": "name"
62     }
63   },
64   "last_seen_at_location_city": "last_seen_at_location_city",
65   "last_seen_at_location_large_city": "last_seen_at_location_large_city",
66   "last_seen_at_timestamp": "2024-01-15T09:30:00Z",
67   "synced_at_timestamp": "2024-01-15T09:30:00Z"
68 }

Links a label to an unlinked Reelables asset and starts tracking. Existing labels must be unlinked first. | authz: min_org_role=operator | (ReelablesAssetLabelLinkReq) -> (ReelablesAsset1)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

asset_idstringRequired

Request

This endpoint expects an object.

nfc_idstringRequiredformat: "^[a-zA-Z0-9]*$"1-20 characters

Response

Successful Response

_idstring

asset_idstring

namestring

org_idstring

Must be a string starting with org_

schema_versioninteger

workspace_idstring

created_at_timestampdatetime or nullOptional

destination_geofence_locationobject or nullOptional

GeoJSON Feature with typed properties for locations

The geometry field is strongly typed as Geometry (union of all geometry types) but remains optional to match the base Feature class specification. To ensure geometry is always present, validate it at runtime or make it required.

destination_geofence_radius_milesdoubleOptional<=10000Defaults to 0.1

labelobject or nullOptional

last_seen_at_locationobject or nullOptional

GeoJSON Feature with typed properties for locations

last_seen_at_location_citystring or nullOptional

last_seen_at_location_large_citystring or nullOptional

last_seen_at_timestampdatetime or nullOptional

synced_at_timestampdatetime or nullOptional

Errors

422

Assets Link Label V1request Unprocessable Entity Error