Get

GET

/operations/departments/v1/:department_id

GET

/operations/departments/v1/:department_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.operations.departments.getV1("department_id");
8 }
9 main();

1 {
2   "schema_version": 1,
3   "name": "name",
4   "department": "automotive",
5   "_id": "_id",
6   "org_id": "org_id",
7   "created_by_user_id": "created_by_user_id",
8   "created_at": "2024-01-15T09:30:00Z",
9   "location": {
10     "type": "Feature",
11     "geometry": {
12       "type": "GeometryCollection",
13       "geometries": [
14         {
15           "type": "LineString",
16           "coordinates": [
17             []
18           ]
19         }
20       ]
21     },
22     "bbox": [
23       {
24         "key": "value"
25       }
26     ],
27     "properties": {
28       "address": "address",
29       "name": "name"
30     },
31     "id": 1
32   },
33   "operator_user_ids": [
34     "operator_user_ids"
35   ]
36 }

Retrieves a single department configuration. | authz: min_org_role=operator | () -> (Department1)

Authentication

AuthorizationBearer

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

Path parameters

department_idstringRequired

Response

Successful Response

schema_versioninteger

namestring

departmentenum

_idstring

org_idstring

Must be a string starting with org_

created_by_user_idstring

Must be a string starting with user_

created_atdatetime

locationobject

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.

operator_user_idslist of strings

Errors

422

Departments Get V1request Unprocessable Entity Error