| Endpoint | Headers | Params | Query | Form Data |
|---|---|---|---|---|
| POST /auth/login | - username: string (required) - password: string (required) |
|||
| POST /auth/sso | - token: string (required) |
| Endpoint | Headers | Params | Query | Form Data |
|---|---|---|---|---|
| GET /categories | - order_by: string (optional) |
|||
| POST /categories | - Authorization: string (required) -- Bearer token |
- name: string (required) - icon: string (optional) - parent: uuid (optional) |
||
| DELETE /categories/mass-delete | - Authorization: string (required) -- Bearer token |
- ids: array (required) |
||
| GET /categories/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
||
| PATCH categories/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
- name: string (optional) - icon: string (optional) - parent: uuid (optional) |
|
| DELETE categories/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
| Endpoint | Headers | Params | Query | Form Data |
|---|---|---|---|---|
| GET /cctvs | ||||
| POST /cctvs | - Authorization: string (required) -- Bearer token |
- name: string (required) - description: string (optional) - region: string (optional) -- if not defined, will use default region - location: object (required) - configuration: object (required) |
||
| GET /cctvs/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
||
| PATCH users/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
- name: string (optional) - description: string (optional) - region: string (optional) - location: object (optional) - configuration: object (optional) |
|
| DELETE users/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
| Endpoint | Headers | Params | Query | Form Data |
|---|---|---|---|---|
| GET /chats | - Authorization: string (required) -- Bearer token |
- offset: number (optional) |
||
| POST /chats | - Authorization: string (required) -- Bearer token |
- message: string (required) |
| Endpoint | Headers | Params | Query | Form Data |
|---|---|---|---|---|
| GET /cctvs |
| Endpoint | Headers | Params | Query | Form Data |
|---|---|---|---|---|
| GET /mappings | - Authorization: string (optional) -- Bearer token |
- region: string (optional) -- if not defined, will use default region - type: enum (optional) -- enum: MARKER,POLYGON - status: enum (optional) -- enum: ACTIVE,PENDING,DECLINED |
||
| POST /mappings | - Authorization: string (optional) -- Bearer token |
- title: string (required) - category_id: uuid (required) -- uuid of category - description: string (optional) - region: string (optional) -- if not defined, will use default region - location: object (required) - type: enum (required) -- enum: MARKER,POLYGON - icon: string (optional) - color: string (optional) - attachment1: file (optional) -- file attachment1 - attachment2: file (optional) -- file attachment2 |
||
| GET /mappings/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
||
| PATCH mappings/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
- title: string (optional) - description: string (optional) - type: enum (optional) -- enum: MARKER,POLYGON - status: enum (optional) -- enum: ACTIVE,PENDING,DECLINED - category_id: string (optional) -- uuid of category - icon: string (optional) - color: string (optional) - location: object (optional) - attachment1: file (optional) -- file attachment1 - attachment2: file (optional) -- file attachment2 |
|
| DELETE mappings/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
| Endpoint | Headers | Params | Query | Form Data |
|---|---|---|---|---|
| GET /mappings | - Authorization: string (optional) -- Bearer token |
|||
| POST /mappings | - Authorization: string (optional) -- Bearer token |
- name: string (required) - category: enum (required) -- enum: WARNING,PROHIBITORY,MANDATORY,DIRECTORY - img: file (optional) -- file img |
||
| GET /signs/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
||
| PATCH signs/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
- name: string (required) - category: enum (required) -- enum: WARNING,PROHIBITORY,MANDATORY,DIRECTORY - img: file (optional) -- file img |
|
| DELETE signs/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
| Endpoint | Headers | Params | Query | Form Data |
|---|---|---|---|---|
| GET /summary | - Authorization: string (required) -- Bearer token |
| Endpoint | Headers | Params | Query | Form Data |
|---|---|---|---|---|
| GET /users | - Authorization: string (required) -- Bearer token |
|||
| POST /users | - Authorization: string (required) -- Bearer token |
- username: string (required) - password: string (required) - role: enum (required) -- options ["admin", "operator", "kelian"] - region: string (required) - image: file (optional) |
||
| PATCH users/current | - Authorization: string (required) -- Bearer {{TOKEN}} |
- id: string (required) |
- username: string (optional) - password: string (optional) - phone_number: string (optional) - image: file (optional) |
|
| GET /users/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
||
| PATCH users/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
- password: string (optional) - role: enum (optional) -- options ["admin", "operator", "kelian"] - region: string (optional) - image: file (optional) |
|
| DELETE users/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
| Endpoint | Headers | Params | Query | Form Data |
|---|---|---|---|---|
| GET /user-activities | - Authorization: string (required) -- Bearer token |
- page: number (optional) -- number of page, default value 1 - perPage: enum (optional) -- total data per page, default value 10 - user: enum (optional) -- this is used for filter by username - startDate: enum (optional) -- start date of tracking user activity - endDate: enum (optional) -- end date of tracking user activity |
| Endpoint | Headers | Params | Query | Form Data |
|---|---|---|---|---|
| GET /zones | - Authorization: string (optional) -- Bearer token |
|||
| POST /zones | - Authorization: string (optional) -- Bearer token |
- location: object (required) - name: string (required) - description: string (optional) |
||
| GET /zones/traffic-summary | - Authorization: string (optional) -- Bearer token |
- id: string (optional) -- Zone id - from: date (optional) -- Datetime format YYYY-MM-DD HH:mm:ss - to: date (optional) -- Datetime format YYYY-MM-DD HH:mm:ss - datestring: string (optional) -- Filter date with matched string, e.g. '16:' will filter show summary at all dates with '16:' text |
||
| GET /zones-logs/current-traffic-info | - Authorization: string (optional) -- Bearer token |
|||
| GET /zones/:id/traffic | - id: string (optional) |
- provider: string (optional) -- Default is tomtom, options: ['google', 'tomtom'] |
||
| PATCH mappings/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
- location: object (optional) - name: string (optional) - description: string (optional) |
|
| DELETE mappings/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
| Endpoint | Headers | Params | Query | Form Data |
|---|---|---|---|---|
| GET /zones-logs | - Authorization: string (optional) -- Bearer token |
|||
| GET /zones-logs/export | - Authorization: string (optional) -- Bearer token |
- dateStart: string (optional) -- YYYY-MM-DD - dateEnd: string (optional) -- YYYY-MM-DD |
| Endpoint | Headers | Params | Query | Form Data |
|---|---|---|---|---|
| GET /emergency-contact | - category_id: string (optional) -- Emergency contact category ID |
|||
| POST /emergency-contact | - Authorization: string (required) -- Bearer token |
- service: string (required) - number: string (required) - call: string (required) - image: file (optional) -- file img - category: string (required) |
||
| PATCH /emergency-contact/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
- service: string (optional) - number: string (optional) - call: string (optional) - image: file (optional) - category: string (optional) |
|
| DELETE /emergency-contact/{id} | - Authorization: string (required) -- Bearer token |
- id: string (required) |
| Endpoint | Headers | Params | Query | Form Data |
|---|---|---|---|---|
| GET /emergency-contact-categories | ||||
| POST /emergency-contact-categories | - Authorization: string (required) -- Bearer token |
- name: string (required) |
||
| PUT /emergency-contact-categories/:id | - Authorization: string (required) -- Bearer token |
- id: string (optional) |
- name: string (required) |
|
| DELETE /emergency-contact-categories/:id | - Authorization: string (required) -- Bearer token |
- id: string (optional) |