Download OpenAPI specification:Download
The organization service implements a the organization logic in GroupAlarm.
To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token
for every request, otherwise the API will return an "401 Unauthorized" error for your request.
Security Scheme Type | API Key |
---|---|
Header parameter name: | API-TOKEN |
To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token
for every request, otherwise the API will return an "401 Unauthorized" error for your request.
Security Scheme Type | API Key |
---|---|
Header parameter name: | Personal-Access-Token |
Update an existing organization with passed organization payload
organization payload
availableUsers | object (AvailableUsersCount) AvailableUsersCount payload |
availableUsersTotal | object (AvailableUsersCount) AvailableUsersCount payload |
avatarURL | string AvatarURL |
creationDate | string <date-time> CreationDate of the organization |
description | string user defined description |
hasChildren | boolean defines if it's the parent of any other organization |
id | integer <int64> ID of this organization |
location | object (OrganizationLocation) OrganizationLocation describes the location payload |
name | string user defined name |
ownerIDs | Array of integers <int64> user id of the organization owner/creator |
parentID | integer <int64> optional: ID of the parent organization |
state | string (OrganizationState) OrganizationState represents the current state of an organization, like trial, active, inactive |
tags | Array of strings Tags are used for internal purposes only |
timezone | string Canonical name of the timezone in the IANA time zone database (e.g. 'Europe/Berlin') |
trialEndDate | string <date-time> TrialEndDate contains the timestamp when the organization's trial period expires |
updated organization payload
passed organization payload is missing or in a wrong format
database error
{- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": "2021-03-03T10:35:35Z",
- "description": "string",
- "hasChildren": true,
- "id": 0,
- "location": {
- "address": "string",
- "latitude": 0,
- "longitude": 0
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": "2021-03-03T10:35:35Z"
}
{- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": "2021-03-03T10:35:35Z",
- "description": "string",
- "hasChildren": true,
- "id": 0,
- "location": {
- "address": "string",
- "latitude": 0,
- "longitude": 0
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": "2021-03-03T10:35:35Z"
}
Create an organization with passed organization payload
organization payload
availableUsers | object (AvailableUsersCount) AvailableUsersCount payload |
availableUsersTotal | object (AvailableUsersCount) AvailableUsersCount payload |
avatarURL | string AvatarURL |
creationDate | string <date-time> CreationDate of the organization |
description | string user defined description |
hasChildren | boolean defines if it's the parent of any other organization |
id | integer <int64> ID of this organization |
location | object (OrganizationLocation) OrganizationLocation describes the location payload |
name | string user defined name |
ownerIDs | Array of integers <int64> user id of the organization owner/creator |
parentID | integer <int64> optional: ID of the parent organization |
state | string (OrganizationState) OrganizationState represents the current state of an organization, like trial, active, inactive |
tags | Array of strings Tags are used for internal purposes only |
timezone | string Canonical name of the timezone in the IANA time zone database (e.g. 'Europe/Berlin') |
trialEndDate | string <date-time> TrialEndDate contains the timestamp when the organization's trial period expires |
created organization payload
passed organization payload is missing or in a wrong format
database error
{- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": "2021-03-03T10:35:35Z",
- "description": "string",
- "hasChildren": true,
- "id": 0,
- "location": {
- "address": "string",
- "latitude": 0,
- "longitude": 0
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": "2021-03-03T10:35:35Z"
}
{- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": "2021-03-03T10:35:35Z",
- "description": "string",
- "hasChildren": true,
- "id": 0,
- "location": {
- "address": "string",
- "latitude": 0,
- "longitude": 0
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": "2021-03-03T10:35:35Z"
}
Get specific organization by its ID
organizationID required | int64 id of the requested organization |
requested organization payload
passed organization id is missing or in a wrong format
database error
{- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": "2021-03-03T10:35:36Z",
- "description": "string",
- "hasChildren": true,
- "id": 0,
- "location": {
- "address": "string",
- "latitude": 0,
- "longitude": 0
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": "2021-03-03T10:35:36Z"
}
Uploads an Avatar for the Organization
organizationID required | int64 id of the organization |
blob of the image
upload complete
data is invalid
database error
null
Get paginated children of specific organization by its ID
organizationID required | int64 id of the requested organization |
limit | int64 max. amount of entries in list |
offset | int64 amount of entries to skip |
Paginated child organizations for the fiven ID
database error
{- "childs": [
- {
- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": "2021-03-03T10:35:36Z",
- "description": "string",
- "hasChildren": true,
- "id": 0,
- "location": {
- "address": "string",
- "latitude": 0,
- "longitude": 0
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": "2021-03-03T10:35:36Z"
}
], - "path": [
- {
- "availableUsers": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "availableUsersTotal": {
- "countAvailable": 0,
- "countInEvent": 0,
- "countNotAvailable": 0
}, - "avatarURL": "string",
- "creationDate": "2021-03-03T10:35:36Z",
- "description": "string",
- "hasChildren": true,
- "id": 0,
- "location": {
- "address": "string",
- "latitude": 0,
- "longitude": 0
}, - "name": "string",
- "ownerIDs": [
- 0
], - "parentID": 0,
- "state": "string",
- "tags": [
- "string"
], - "timezone": "string",
- "trialEndDate": "2021-03-03T10:35:36Z"
}
], - "totalChilds": 0
}
Get organization's availability history of the last 14 days
limit | int64 max. amount of entries in list |
offset | int64 amount of entries to skip |
availability history of the last 14 days
invalid organizationID
missing jwt token or failed rbac check
internal error
{- "end_date": "2021-03-03T10:35:36Z",
- "entries": [
- {
- "creation_date": "2021-03-03T10:35:36Z",
- "id": 0,
- "organization_id": 0,
- "update_date": "2021-03-03T10:35:36Z",
- "users_available": [
- 0
], - "users_in_event": [
- 0
], - "users_not_available": [
- 0
]
}
], - "start_date": "2021-03-03T10:35:36Z"
}
Open a secure websocket connection to receive immediate updates about availability changes
upgrade to websocket connection
invalid organizationID
Inserts or updates an organizations location
organizationID required | int64 id of the organization |
location payload of the organization
address | string |
latitude | number <double> |
longitude | number <double> |
upsert complete
data is invalid
database error
{- "address": "string",
- "latitude": 0,
- "longitude": 0
}
Deletes an organizations location
organizationID required | int64 id of the organization |
delete successful
data is invalid
database error
Update an existing organization by adding a new owner
organizationID required | int64 id of the organization |
email address of the user
updated organization owners
data is invalid
user is not allowed to update owners
database error
"string"