| Requires any of the roles: | Admin, TenantAdmin, Receptionist |
| GET | /notification | Gets a notification |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | Yes | Notification ID |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | integer | No | Api version |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | NotificationView | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Created | form | DateTime | No | |
| Title | form | string | No | |
| RecipientTypes | form | HashSet<RecipientType> | No | |
| NotificationType | form | NotificationType | No | |
| Vibrate | form | bool | No | |
| Description | form | string | No | |
| ServiceId | form | Guid? | No | |
| OrganizationId | form | Guid | No | |
| Deactivated | form | bool | No | |
| DeactivatedOn | form | DateTime? | No | |
| DeactivatedBy | form | int? | No | |
| Roles | form | HashSet<string> | No | |
| MobileUsers | form | HashSet<UserNotificationDto> | No | |
| BusinessUsers | form | HashSet<BusinessUserNotificationDto> | No | |
| Things | form | HashSet<ThingNotificationDto> | No | |
| ThingTypes | form | HashSet<ThingTypeNotificationDto> | No | |
| DomainData | form | IDomainNotification | No |
| Name | Value |
|---|---|
| Guest | 10 |
| AllGuests | 20 |
| StaffMember | 30 |
| AllStaff | 40 |
| Thing | 50 |
| ThingType | 60 |
| Role | 70 |
| User | 80 |
| Name | Value |
|---|---|
| Access | 10 |
| Offer | 20 |
| TaskList | 30 |
| System | 40 |
| SmartSpace | 50 |
| Alarm | 60 |
| Info | 70 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserId | form | int | No | |
| NotificationId | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BusinessUserId | form | int | No | |
| NotificationId | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ThingId | form | Guid | No | |
| NotificationId | form | Guid | No | |
| ThingName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ThingTypeId | form | Guid | No | |
| NotificationId | form | Guid | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /notification HTTP/1.1 Host: api.4spaces.io Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"id":"00000000000000000000000000000000","created":-62135596800000,"title":"String","recipientTypes":[10],"notificationType":10,"vibrate":false,"description":"String","serviceId":"00000000000000000000000000000000","organizationId":"00000000000000000000000000000000","deactivated":false,"deactivatedOn":-62135596800000,"deactivatedBy":0,"roles":["String"],"mobileUsers":[{"userId":0,"notificationId":"00000000000000000000000000000000"}],"businessUsers":[{"businessUserId":0,"notificationId":"00000000000000000000000000000000"}],"things":[{"thingId":"00000000000000000000000000000000","notificationId":"00000000000000000000000000000000","thingName":"String"}],"thingTypes":[{"thingTypeId":"00000000000000000000000000000000","notificationId":"00000000000000000000000000000000"}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}