SMS API specification (936bd03ca8e969a9b757a0fdf50687623dfabfcf)

Download OpenAPI specification:Download

The sms service implements all sms functions for GroupAlarm

Authentication

API_Token

You can generate an API-Token in the permissions-settings of your organization. All requests will be performed in the scope of this organization. Requests regarding users will fail.

Security Scheme Type API Key
Header parameter name: API-TOKEN

Personal-Access-Token

You can generate a Personal Access Token in your profile settings. All requests will be performed as the user who created the token, with permissions as configured in each organization.

Security Scheme Type API Key
Header parameter name: Personal-Access-Token

alarming

ListConfigurations

Returns all sms-alarming configurations

query Parameters
organization_id
required
integer

requesting organization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

UpdateConfiguration

Updates an existing sms-alarming configuration

Request Body schema: application/json

updated sms-alarming configuration

gsm
string
id
integer <int64>
name
string
organizationID
integer <int64>
pin
string

Responses

Request samples

Content type
application/json
{
  • "gsm": "string",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "pin": "string"
}

Response samples

Content type
application/json
{
  • "gsm": "string",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "pin": "string"
}

CreateConfiguration

Creates a new sms-alarming configuration

Request Body schema: application/json

new sms-alarming configuration

gsm
string
id
integer <int64>
name
string
organizationID
integer <int64>
pin
string

Responses

Request samples

Content type
application/json
{
  • "gsm": "string",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "pin": "string"
}

Response samples

Content type
application/json
{
  • "gsm": "string",
  • "id": 0,
  • "name": "string",
  • "organizationID": 0,
  • "pin": "string"
}

DeleteConfiguration

Deletes an existing sms-alarming configuration

path Parameters
configurationID
required
integer

ID of an existing sms-alarming configuration

Responses

organizations

GetDisabledOrganization

Returns whether the given organization has disabled this way of alarming or not

query Parameters
organization_id
required
integer

requesting organization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SetDisabledOrganization

Sets whether the given organization has this way of alarming disabled or not

query Parameters
organization_id
required
integer

requesting organization

Request Body schema: application/json

isDisabled payload

isDisabled
boolean

Responses

Request samples

Content type
application/json
{
  • "isDisabled": true
}

text-formatter

GetTextFormatter

Returns the current text formatter of the given organization

query Parameters
organization
required
integer

requested organization

Responses

Response samples

Content type
application/json
{
  • "organizationID": 0,
  • "textFormatterName": "string"
}

SetTextFormatter

Sets the given organization's text formatter

Request Body schema: application/json

organization and it's text formatter settings

organizationID
integer <int64>
textFormatterName
string

Responses

Request samples

Content type
application/json
{
  • "organizationID": 0,
  • "textFormatterName": "string"
}

gsm

List

Returns all gsm numbers for queried owner

query Parameters
owner_id
required
integer

requested owner by using his user ID

organization_id
integer

requesting organization, not required if user accesses his own resources

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update

Updates an existing gsm configuration

query Parameters
organization_id
integer

requesting organization, not required if user accesses his own resources

Request Body schema: application/json

mobile configuration payload

active
boolean

true, if this configuration can be used for alarm notifications

gsm
string

gsm number for alarm notifications with sms (E.164-format with 00 instead of +)

id
integer <int64>

id for this configuration

name
string

user defined name for this configuration

ownerID
integer <int64>

user id, who owns this configuration

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "gsm": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Response samples

Content type
application/json
{
  • "active": true,
  • "gsm": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Create

Create a gsm configuration for specific user

query Parameters
organization_id
integer

requesting organization, not required if user accesses his own resources

Request Body schema: application/json

mobile configuration payload

active
boolean

true, if this configuration can be used for alarm notifications

gsm
string

gsm number for alarm notifications with sms (E.164-format with 00 instead of +)

id
integer <int64>

id for this configuration

name
string

user defined name for this configuration

ownerID
integer <int64>

user id, who owns this configuration

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "gsm": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Response samples

Content type
application/json
{
  • "active": true,
  • "gsm": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Delete

Delete an existing gsm configuration

path Parameters
mobileID
required
integer

ID of an existing mobile configuration

query Parameters
organization_id
integer

requesting organization, not required if user accesses his own resources

Responses

Response samples

Content type
application/json
{
  • "status": "deleted"
}

Get

Returns an gsm number configuration

path Parameters
mobileID
required
integer

ID of an gsm configuration

query Parameters
organization_id
integer

requesting organization, not required if user accesses his own resources

Responses

Response samples

Content type
application/json
[
  • {
    }
]

mobiles

AnyActive

Check if any gsm is active for the passed owner id in the passed organization id

query Parameters
user_id
required
integer

id of the user

organization_id
required
integer

id of the organization

Responses

Response samples

Content type
application/json
{
  • "activeCount": 0,
  • "anyActive": true
}

user-permissions

GetPermission

Returns true if there is an active permissions for the passed organization or specifically for the passed user in an organization

query Parameters
organization_id
required
integer

ID of an organization

user_id
integer

ID of an user in this organization

Responses

CreatePermission

Creates a user permission with the passed organizationID and userID for this device

Request Body schema: application/json

restriction configuration with user and organization id

organizationID
integer <int64>
userID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "organizationID": 0,
  • "userID": 0
}

DeletePermission

Removes a configured user permission for this device

path Parameters
organizationID
required
integer

ID of an organization

userID
required
integer

ID of an user in this organization

Responses