logo
Documentation Powered by ReDoc

Organization API specification (2.0.0)

Download OpenAPI specification:Download

The organization service implements a the organization logic in GroupAlarm.

Authentication

API_Token

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

Personal-Access-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

organization

UpdateOrganization

Update an existing organization with passed organization payload

Request Body schema: application/json
availableUsers
object (AvailableUsersCount)

AvailableUsersCount payload

availableUsersTotal
object (AvailableUsersCount)

AvailableUsersCount payload

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 integer <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 string

Tags are used for internal purposes only

trialEndDate
string <date-time>

TrialEndDate contains the timestamp when the organization's trial period expires

Responses

200

updated organization payload

400

passed organization payload is missing or in a wrong format

500

database error

put /organization
https://app.groupalarm.com/api/v1/organization

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "availableUsers":
    {
    },
  • "availableUsersTotal":
    {
    },
  • "creationDate": "2019-11-08T12:54:37Z",
  • "description": "string",
  • "hasChildren": true,
  • "id": 0,
  • "location":
    {
    },
  • "name": "string",
  • "ownerIDs":
    [
    ],
  • "parentID": 0,
  • "state": "string",
  • "tags":
    [
    ],
  • "trialEndDate": "2019-11-08T12:54:37Z"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "availableUsers":
    {
    },
  • "availableUsersTotal":
    {
    },
  • "creationDate": "2019-11-08T12:54:37Z",
  • "description": "string",
  • "hasChildren": true,
  • "id": 0,
  • "location":
    {
    },
  • "name": "string",
  • "ownerIDs":
    [
    ],
  • "parentID": 0,
  • "state": "string",
  • "tags":
    [
    ],
  • "trialEndDate": "2019-11-08T12:54:37Z"
}

CreateOrganization

Create an organization with passed organization payload

Request Body schema: application/json
availableUsers
object (AvailableUsersCount)

AvailableUsersCount payload

availableUsersTotal
object (AvailableUsersCount)

AvailableUsersCount payload

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 integer <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 string

Tags are used for internal purposes only

trialEndDate
string <date-time>

TrialEndDate contains the timestamp when the organization's trial period expires

Responses

201

created organization payload

400

passed organization payload is missing or in a wrong format

500

database error

post /organization
https://app.groupalarm.com/api/v1/organization

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "availableUsers":
    {
    },
  • "availableUsersTotal":
    {
    },
  • "creationDate": "2019-11-08T12:54:37Z",
  • "description": "string",
  • "hasChildren": true,
  • "id": 0,
  • "location":
    {
    },
  • "name": "string",
  • "ownerIDs":
    [
    ],
  • "parentID": 0,
  • "state": "string",
  • "tags":
    [
    ],
  • "trialEndDate": "2019-11-08T12:54:37Z"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "availableUsers":
    {
    },
  • "availableUsersTotal":
    {
    },
  • "creationDate": "2019-11-08T12:54:37Z",
  • "description": "string",
  • "hasChildren": true,
  • "id": 0,
  • "location":
    {
    },
  • "name": "string",
  • "ownerIDs":
    [
    ],
  • "parentID": 0,
  • "state": "string",
  • "tags":
    [
    ],
  • "trialEndDate": "2019-11-08T12:54:37Z"
}

GetOrganization

Get specific organization by its ID

path Parameters
organizationID
required
int64

id of the requested organization

Responses

200

requested organization payload

400

passed organization id is missing or in a wrong format

500

database error

get /organization/{organizationID}
https://app.groupalarm.com/api/v1/organization/{organizationID}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "availableUsers":
    {
    },
  • "availableUsersTotal":
    {
    },
  • "creationDate": "2019-11-08T12:54:37Z",
  • "description": "string",
  • "hasChildren": true,
  • "id": 0,
  • "location":
    {
    },
  • "name": "string",
  • "ownerIDs":
    [
    ],
  • "parentID": 0,
  • "state": "string",
  • "tags":
    [
    ],
  • "trialEndDate": "2019-11-08T12:54:37Z"
}

children

GetChildren

Get paginated children of specific organization by its ID

path Parameters
organizationID
required
int64

id of the requested organization

query Parameters
limit
int64

max. amount of entries in list

offset
int64

amount of entries to skip

Responses

200

Paginated child organizations for the fiven ID

500

database error

get /organization/{organizationID}/children
https://app.groupalarm.com/api/v1/organization/{organizationID}/children

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "childs":
    [
    ],
  • "path":
    [
    ],
  • "totalChilds": 0
}

availability-history

GetAvailabilityHistory

Get organization's availability history of the last 14 days

query Parameters
limit
int64

max. amount of entries in list

offset
int64

amount of entries to skip

Responses

200

availability history of the last 14 days

400

invalid organizationID

401

missing jwt token or failed rbac check

500

internal error

get /organization/{organizationID}/history
https://app.groupalarm.com/api/v1/organization/{organizationID}/history

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "end_date": "2019-11-08T12:54:37Z",
  • "entries":
    [
    ],
  • "start_date": "2019-11-08T12:54:37Z"
}

WebsocketConnection

Open a secure websocket connection to receive immediate updates about availability changes

Responses

200

upgrade to websocket connection

400

invalid organizationID

get /organization/{organizationID}/history/ws
https://app.groupalarm.com/api/v1/organization/{organizationID}/history/ws

location

UpsertOrganizationLocation

Inserts or updates an organizations location

path Parameters
organizationID
required
int64

id of the organization

Request Body schema: application/json
address
string
latitude
number <double>
longitude
number <double>

Responses

200

upsert complete

400

data is invalid

500

database error

put /organization/{organizationID}/location
https://app.groupalarm.com/api/v1/organization/{organizationID}/location

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "address": "string",
  • "latitude": 0,
  • "longitude": 0
}

DeleteOrganizationLocation

Deletes an organizations location

path Parameters
organizationID
required
int64

id of the organization

Responses

200

delete successful

400

data is invalid

500

database error

delete /organization/{organizationID}/location
https://app.groupalarm.com/api/v1/organization/{organizationID}/location

owner

AddOwnerWithEmail

Update an existing organization by adding a new owner

path Parameters
organizationID
required
int64

id of the organization

Request Body schema: application/json
string

Responses

200

updated organization owners

400

data is invalid

403

user is not allowed to update owners

500

database error

put /organization/{organizationID}/owner
https://app.groupalarm.com/api/v1/organization/{organizationID}/owner

Request samples

application/json
Copy
 Expand all Collapse all
"string"

GetOwnerInParentOrganization

Gets the topmost parent organization the given user is the owner of

path Parameters
organizationID
required
int64

id of the organization

userID
required
int64

id of the user

Responses

200

organization found

400

data is invalid

500

database error

get /organization/{organizationID}/owner/{userID}
https://app.groupalarm.com/api/v1/organization/{organizationID}/owner/{userID}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "availableUsers":
    {
    },
  • "availableUsersTotal":
    {
    },
  • "creationDate": "2019-11-08T12:54:37Z",
  • "description": "string",
  • "hasChildren": true,
  • "id": 0,
  • "location":
    {
    },
  • "name": "string",
  • "ownerIDs":
    [
    ],
  • "parentID": 0,
  • "state": "string",
  • "tags":
    [
    ],
  • "trialEndDate": "2019-11-08T12:54:37Z"
}

AddOwner

Update an existing organization by adding a new owner

path Parameters
organizationID
required
int64

id of the organization

userID
required
int64

id of the user

Responses

200

updated organization owners

400

data is invalid

403

user is not allowed to update owners

500

database error

put /organization/{organizationID}/owner/{userID}
https://app.groupalarm.com/api/v1/organization/{organizationID}/owner/{userID}

RemoveOwner

Update an existing organization by removing an existing owner

path Parameters
organizationID
required
int64

id of the organization

userID
required
int64

id of the user

Responses

200

updated organization owners

400

data is invalid

403

user is not allowed to update owners

500

database error

delete /organization/{organizationID}/owner/{userID}
https://app.groupalarm.com/api/v1/organization/{organizationID}/owner/{userID}

organizationsByOwner

GetUsersOwnedOrganizations

Get all organizations for user in JWT token where the user is the owner of

Responses

200

All organizations for logged in user

500

database error

get /organizations/owner
https://app.groupalarm.com/api/v1/organizations/owner

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

organizations

GetPaginatedOrganizations

Get paginated organizations for user with the passed JWT token

query Parameters
limit
int64

max. amount of entries in list

offset
int64

amount of entries to skip

Responses

200

Paginated organizations for logged in user

500

database error

get /organizations/paginated
https://app.groupalarm.com/api/v1/organizations/paginated

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "organizations":
    [
    ],
  • "totalOrganizations": 0
}