Docs
Create
POST /Activities
POST
/ActivitiesCreates a new activity record. Activities may be single‑occurrence or recurring, may span multiple locations, and may include users and departments as participants.
Top‑Level Fields
| Field | Type | Required | Description |
|---|---|---|---|
| type | string | Required | Category of activity (e.g., Maintenance, Training). |
| name | string | Required | Human‑readable name of the activity. |
| description | string | Required | Detailed description of the activity. |
| startDateTime | DateTime | Required | Start timestamp of the activity. |
| endDateTime | DateTime | Required | End timestamp of the activity. |
| exactLocation | string | Required | Free‑text location description. |
| isGlobal | bool | Required | Whether the activity applies globally across all locations. |
| isAllDay | bool | Required | Whether the activity spans the entire day. |
| recurrenceRules | object | Optional | Recurrence configuration. |
| locations | List<Guid> | Optional | List of location IDs associated with the activity. |
| users | List<ActivityParticipant> | Optional | User participants. |
| departments | List<ActivityParticipant> | Optional | Department participants. |
RecurrenceRules Object
| Field | Type | Required | Description |
|---|---|---|---|
| frequency | string | Required | Recurrence frequency (Daily, Weekly, Monthly). |
| interval | int | Required | How often the recurrence repeats. |
| daysOfWeek | List<string> | Optional | Days of the week (for weekly recurrences). |
| endDate | DateTime | Required | When the recurrence stops. |
ActivityParticipant Object
| Field | Type | Required | Description |
|---|---|---|---|
| id | Guid | Required | User or department ID. |
| isRequired | bool | Required | Whether attendance is mandatory. |
| role | string | Required | Role of the participant (e.g., Technician, Supervisor). |
Error Codes
| Code | HTTP Status | Description | Retry |
|---|---|---|---|
UNAUTHORIZED | 401 | Missing or invalid API key | No |
NOT_FOUND | 404 | Resource not found | No |
RATE_LIMIT_EXCEEDED | 429 | Too many requests | Yes |
INVALID_REQUEST | 400 | Malformed request | No |
INTERNAL_SERVER_ERROR | 500 | Unexpected server error | Yes |