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 .xml suffix or ?format=xml

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NotificationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Business">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Views.Business.Notification">
    <d2p1:BusinessUsers xmlns:d3p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Notification">
      <d3p1:BusinessUserNotificationDto>
        <d3p1:BusinessUserId>0</d3p1:BusinessUserId>
        <d3p1:NotificationId>00000000-0000-0000-0000-000000000000</d3p1:NotificationId>
      </d3p1:BusinessUserNotificationDto>
    </d2p1:BusinessUsers>
    <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
    <d2p1:Deactivated>false</d2p1:Deactivated>
    <d2p1:DeactivatedBy>0</d2p1:DeactivatedBy>
    <d2p1:DeactivatedOn>0001-01-01T00:00:00</d2p1:DeactivatedOn>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:DomainData i:nil="true" />
    <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
    <d2p1:MobileUsers xmlns:d3p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Notification">
      <d3p1:UserNotificationDto>
        <d3p1:NotificationId>00000000-0000-0000-0000-000000000000</d3p1:NotificationId>
        <d3p1:UserId>0</d3p1:UserId>
      </d3p1:UserNotificationDto>
    </d2p1:MobileUsers>
    <d2p1:NotificationType>Access</d2p1:NotificationType>
    <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
    <d2p1:RecipientTypes xmlns:d3p1="http://schemas.datacontract.org/2004/07/Viviot.Domain.AggregateModel.NotificationAggregate">
      <d3p1:RecipientType>Guest</d3p1:RecipientType>
    </d2p1:RecipientTypes>
    <d2p1:Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Roles>
    <d2p1:ServiceId>00000000-0000-0000-0000-000000000000</d2p1:ServiceId>
    <d2p1:ThingTypes xmlns:d3p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Notification">
      <d3p1:ThingTypeNotificationDto>
        <d3p1:NotificationId>00000000-0000-0000-0000-000000000000</d3p1:NotificationId>
        <d3p1:ThingTypeId>00000000-0000-0000-0000-000000000000</d3p1:ThingTypeId>
      </d3p1:ThingTypeNotificationDto>
    </d2p1:ThingTypes>
    <d2p1:Things xmlns:d3p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Notification">
      <d3p1:ThingNotificationDto>
        <d3p1:NotificationId>00000000-0000-0000-0000-000000000000</d3p1:NotificationId>
        <d3p1:ThingId>00000000-0000-0000-0000-000000000000</d3p1:ThingId>
        <d3p1:ThingName>String</d3p1:ThingName>
      </d3p1:ThingNotificationDto>
    </d2p1:Things>
    <d2p1:Title>String</d2p1:Title>
    <d2p1:Vibrate>false</d2p1:Vibrate>
  </Data>
</NotificationResponse>