Notifications

User notifications management.

The Notifications Model

A notification is represented by the following schema:

Scheme

  • Name
    id
    Type
    integer
    Description
  • Name
    type
    Type
    string
    Description
  • Name
    always
    Type
    boolean
    Description
  • Name
    web
    Type
    boolean
    Description
  • Name
    mail
    Type
    boolean
    Description
  • Name
    sms
    Type
    boolean
    Description
  • Name
    calendarId
    Type
    integer
    Description
  • Name
    attributes
    Type
    object
    Description

Notification type is represented by the following schema:

Scheme

  • Name
    type
    Type
    string
    Description
GET/notifications

Retrieve a list of notifications

Without any params, returns a list of notifications the user has access to

Authorizations

BasicAuth or ApiKey

  • Name
    BasicAuth
    Type
    scheme
    Description

    HTTP Authorization Scheme: basic

  • Name
    ApiKey
    Type
    scheme
    Description

    HTTP Authorization Scheme: bearer

Query Parameters

  • Name
    all
    Type
    boolean
    Description

    Can only be used by administrators or managers to retrieve all objects.

  • Name
    userId
    Type
    integer
    Description

    Standard users can use this only with their own userId

  • Name
    deviceId
    Type
    integer
    Description

    Standard users can use this only with deviceIds they have access to

  • Name
    groupId
    Type
    integer
    Description

    Standard users can use this only with groupIds they have access to

  • Name
    refresh
    Type
    boolean
    Description

Responses

  • Name
    200
    Type
    success
    Description
  • Name
    application/json
    Type
    response schema
    Description

    • Array of Notification

Request

GET
/notifications
curl --location 'https://gw.onemap8.com/api/notifications?all=%3Cboolean%3E&userId=%3Cinteger%3E&deviceId=%3Cinteger%3E&groupId=%3Cinteger%3E&refresh=%3Cboolean%3E' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {your_access_token}'

Response

[
  {
    "id": 0,
    "type": "string",
    "always": true,
    "web": true,
    "mail": true,
    "sms": true,
    "calendarId": 0,
    "attributes": { }
  },
  {
    ...
  }
]
POST/notifications

Create a notification

Authorizations

BasicAuth or ApiKey

  • Name
    BasicAuth
    Type
    scheme
    Description

    HTTP Authorization Scheme: basic

  • Name
    ApiKey
    Type
    scheme
    Description

    HTTP Authorization Scheme: bearer

Request body schema

  • Name
    application/json
    Type
    schema
    Description

Body schema

  • Name
    id
    Type
    integer
    Description
  • Name
    type
    Type
    string
    Description
  • Name
    always
    Type
    boolean
    Description
  • Name
    web
    Type
    boolean
    Description
  • Name
    mail
    Type
    boolean
    Description
  • Name
    sms
    Type
    boolean
    Description
  • Name
    calendarId
    Type
    integer
    Description
  • Name
    attributes
    Type
    object
    Description

Responses

  • Name
    200
    Type
    success
    Description
  • Name
    application/json
    Type
    response schema
    Description

    • Notification

Request

POST
/notifications
curl --location 'https://gw.onemap8.com/api/notifications' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {your_access_token}' \
--data '{
"id": "<integer>",
"type": "<string>",
"always": "<boolean>",
"web": "<boolean>",
"mail": "<boolean>",
"sms": "<boolean>",
"calendarId": "<integer>",
"attributes": {}
}'

Response

{
  "id": 0,
  "type": "string",
  "always": true,
  "web": true,
  "mail": true,
  "sms": true,
  "calendarId": 0,
  "attributes": { }
}
PUT/notifications/{id}

Update a notification

Authorizations

BasicAuth or ApiKey

  • Name
    BasicAuth
    Type
    scheme
    Description

    HTTP Authorization Scheme: basic

  • Name
    ApiKey
    Type
    scheme
    Description

    HTTP Authorization Scheme: bearer

Path parameters

  • Name
    id
    Type
    integer
    Description

    required

Request body schema

  • Name
    application/json
    Type
    schema
    Description

Body schema

  • Name
    id
    Type
    integer
    Description
  • Name
    type
    Type
    string
    Description
  • Name
    always
    Type
    boolean
    Description
  • Name
    web
    Type
    boolean
    Description
  • Name
    mail
    Type
    boolean
    Description
  • Name
    sms
    Type
    boolean
    Description
  • Name
    calendarId
    Type
    integer
    Description
  • Name
    attributes
    Type
    object
    Description

Response schema

  • Name
    application/json
    Type
    schema
    Description

Responses

  • Name
    application/json
    Type
    response schema
    Description
  • Name
    200
    Type
    success
    Description

    Notification

Request

PUT
/notifications/{id}
  curl --location --request PUT 'https://gw.onemap8.com/api/notifications/<integer>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {your_access_token}' \
--data '{
"id": "<integer>",
"type": "<string>",
"always": "<boolean>",
"web": "<boolean>",
"mail": "<boolean>",
"sms": "<boolean>",
"calendarId": "<integer>",
"attributes": {}
}'

Response

{
    "id": 0,
    "type": "string",
    "always": true,
    "web": true,
    "mail": true,
    "sms": true,
    "calendarId": 0,
    "attributes": {}
}
DELETE/notifications/{id}

Delete a notification

Authorizations

BasicAuth or ApiKey

  • Name
    BasicAuth
    Type
    scheme
    Description

    HTTP Authorization Scheme: basic

  • Name
    ApiKey
    Type
    scheme
    Description

    HTTP Authorization Scheme: bearer

Path parameters

  • Name
    id
    Type
    integer required
    Description

Responses

  • Name
    204
    Type
    success
    Description

    No content

Request

DELETE
/notifications/{id}
  curl --location --request DELETE 'https://gw.onemap8.com/api/notifications/<integer>' \
  --header 'Authorization: Basic {your_access_token}'

Response

No content
GET/notifications/types

Retrieve a list of available Notification types

Authorizations

BasicAuth or ApiKey

  • Name
    BasicAuth
    Type
    scheme
    Description

    HTTP Authorization Scheme: basic

  • Name
    ApiKey
    Type
    scheme
    Description

    HTTP Authorization Scheme: bearer

Responses

  • Name
    200
    Type
    success
    Description
  • Name
    application/json
    Type
    response schema
    Description

    • Array of Notification types

Request

GET
/notifications/types
curl --location 'https://gw.onemap8.com/api/notifications/types' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {your_access_token}'

Response

[
    {
        "type": "string"
    },
    {
        ...
    }
]
POST/notifications/test

Send test Notification to current user vía email or sms

Authorizations

BasicAuth or ApiKey

  • Name
    BasicAuth
    Type
    scheme
    Description

    HTTP Authorization Scheme: basic

  • Name
    ApiKey
    Type
    scheme
    Description

    HTTP Authorization Scheme: bearer

Responses

  • Name
    204
    Type
    success
    Description

    Successful sending

  • Name
    400
    Type
    success
    Description

    Sending has failed

Request

POST
/notifications
curl --location --request POST 'https://gw.onemap8.com/api/notifications/test' \
--header 'Authorization: Basic {your_access_token}'

Response

Successful sending