Viviot.Api

<back to all web services

GetNotification

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, Receptionist
The following routes are available for this service:
GET/notificationGets a notification
ExistingNotificationOperation Parameters:
NameParameterData TypeRequiredDescription
IdformstringYesNotification ID
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
NotificationResponse Parameters:
NameParameterData TypeRequiredDescription
DataformNotificationViewNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
NotificationView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
CreatedformDateTimeNo
TitleformstringNo
RecipientTypesformHashSet<RecipientType>No
NotificationTypeformNotificationTypeNo
VibrateformboolNo
DescriptionformstringNo
ServiceIdformGuid?No
OrganizationIdformGuidNo
DeactivatedformboolNo
DeactivatedOnformDateTime?No
DeactivatedByformint?No
RolesformHashSet<string>No
MobileUsersformHashSet<UserNotificationDto>No
BusinessUsersformHashSet<BusinessUserNotificationDto>No
ThingsformHashSet<ThingNotificationDto>No
ThingTypesformHashSet<ThingTypeNotificationDto>No
DomainDataformIDomainNotificationNo
RecipientType Enum:
NameValue
Guest10
AllGuests20
StaffMember30
AllStaff40
Thing50
ThingType60
Role70
User80
NotificationType Enum:
NameValue
Access10
Offer20
TaskList30
System40
SmartSpace50
Alarm60
Info70
UserNotificationDto Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
NotificationIdformGuidNo
BusinessUserNotificationDto Parameters:
NameParameterData TypeRequiredDescription
BusinessUserIdformintNo
NotificationIdformGuidNo
ThingNotificationDto Parameters:
NameParameterData TypeRequiredDescription
ThingIdformGuidNo
NotificationIdformGuidNo
ThingNameformstringNo
ThingTypeNotificationDto Parameters:
NameParameterData TypeRequiredDescription
ThingTypeIdformGuidNo
NotificationIdformGuidNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}