Sublocations
Schema​
Sublocation​
| Name | Type | Description | Example |
|---|---|---|---|
| description | string? | The description of the sublocation | "My description" |
| displayId | ID | The display for the sublocation | "A1-B2" |
| id | ID | The unique sublocation ID | "ckmnpybisiy5x08abky4g2d1f" |
| locationId | ID | The ID of the location | "ckmnpybisiy5x08abky4g2d1f" |
| parentId | ID? | The ID of the parent location | "ckmnpybisiy5x08abky4g2d1f" |
| updatedAt | DateTime | When this location was last updated | "2021-03-24 17:26:46.983Z" |
REST Endpoints​
GET /sublocations​
Read the list of sublocations
Accepts all standard pagination parameters.
Allowed orderBy fields: createdAt, id, updatedAt.
Allowed filter fields: createdAt, id, locationId, parentId, updatedAt.
Response​
A list of Sublocation objects.
Example Request​
GET https://api.kojo.tech/sublocations
Example Response​
[
{
"id": "clku7gtqt000cpwtzv6e971xg",
"createdAt": "2021-03-24 17:26:46.983Z",
"updatedAt": "2021-03-24 17:26:46.983Z",
"description": "My description",
"displayId": "A1",
"locationId": "ckmnpybisiy5x08abky4g2d1f",
"parentId": null,
}
]