=============================================
API Schema | Notification API - Http | 10.8.0
=============================================

-------------------------------
GetNotificationPreferencesQuery
-------------------------------
  -------
  Request
  -------
    TraceOne.Api.Notification.Default.Messages.Queries.NotificationPreferences.GetNotificationPreferencesQuery
      LanguageCode                            String
      SenderZone                              String
      Level                                   Nullable<TraceOne.Api.Notification.Constants.Enums.NotificationPreferenceLevels>
      IncludeNotUserCustomizedNotifications   Nullable<Boolean>
      GlobalUserId                            Guid
      CompanyActivity                         Nullable<Int32>
      MessageId                               Guid
      TimeOfCreationAtOrigin                  Nullable<DateTime>
      Headers                                 Dictionary<String, String>
      IdentityToken                           String
  --------
  Response
  --------
    TraceOne.Api.Notification.Default.Messages.Queries.NotificationPreferences.GetNotificationPreferencesQuery+GetNotificationPreferencesQueryResponse
      NotificationPreferences                 IList<TraceOne.Api.Notification.Default.Messages.Queries.NotificationPreferences.GetNotificationPreferencesQuery+NotificationPreferenceModel>
        TraceOne.Api.Notification.Default.Messages.Queries.NotificationPreferences.GetNotificationPreferencesQuery+NotificationPreferenceModel
          Level                                   TraceOne.Api.Notification.Constants.Enums.NotificationPreferenceLevels
            TraceOne.Api.Notification.Constants.Enums.NotificationPreferenceLevels
              Undefined                               0
              SenderZone                              1
              NotificationType                        2
          SenderZone                              String
          NotificationTypeId                      Nullable<Guid>
          NotificationTypeTitle                   String
          CommunicationMethods                    IList<TraceOne.Api.Notification.Constants.Enums.CommunicationMethods>
            TraceOne.Api.Notification.Constants.Enums.CommunicationMethods
              Web                                     0
              Email                                   1
          IsDigestActive                          Boolean
          IsUserAllowedToSubscribeInDigest        Boolean
          IsUserAllowedToSetPreferences           Boolean
          NotificationTypeDefaultCommunicationMethodsIList<TraceOne.Api.Notification.Constants.Enums.CommunicationMethods>
            TraceOne.Api.Notification.Constants.Enums.CommunicationMethods
              Web                                     0
              Email                                   1
      DigestFrequency                         TraceOne.Api.Notification.Constants.Enums.DigestFrequencies
        TraceOne.Api.Notification.Constants.Enums.DigestFrequencies
          Off                                     0
          Daily                                   1
          Weekly                                  2
  --------
  Security
  --------
    GetNotificationPreferencesQuery requests require an identity token for an authenticated identity.
  -----------
  Error Codes
  -----------
    d239f5e5-c0e8-4ef5-acce-dcc0c2e0b8c1    NoUserToken
    34f68850-0793-46f0-8bbf-565bf416d55f    SenderZoneNotRegistered
    1748eae4-3f88-4209-a2a5-b51b88ca1cb6    InvalidLanguageCode

----------------------------------
GetSubscriptionDetailsForItemQuery
----------------------------------
  -------
  Request
  -------
    TraceOne.Api.Notification.Default.Messages.Queries.Subscriptions.GetSubscriptionDetailsForItemQuery
      NotificationTypeId                      Guid
      SubscribedItemId                        Nullable<Guid>
      GlobalUserId                            Guid
      MessageId                               Guid
      TimeOfCreationAtOrigin                  Nullable<DateTime>
      Headers                                 Dictionary<String, String>
      IdentityToken                           String
  --------
  Response
  --------
    TraceOne.Api.Notification.Default.Messages.Queries.Subscriptions.GetSubscriptionDetailsForItemQuery+SubscriptionDetailsViewModel
      SubscriptionId                          Guid
      CommunicationMethods                    IList<TraceOne.Api.Notification.Default.Messages.Queries.Subscriptions.GetSubscriptionDetailsForItemQuery+SubscriptionDetailsViewModel+NotificationCommunicationMethods>
        TraceOne.Api.Notification.Default.Messages.Queries.Subscriptions.GetSubscriptionDetailsForItemQuery+SubscriptionDetailsViewModel+NotificationCommunicationMethods
          Web                                     0
          Email                                   1
  --------
  Security
  --------
    GetSubscriptionDetailsForItemQuery requests require an identity token for an authenticated identity.

---------------------
GetSubscriptionsQuery
---------------------
  -------
  Request
  -------
    TraceOne.Api.Notification.Default.Messages.Queries.Subscriptions.GetSubscriptionsQuery
      LanguageCode                            String
      GlobalUserId                            Guid
      MessageId                               Guid
      TimeOfCreationAtOrigin                  Nullable<DateTime>
      Headers                                 Dictionary<String, String>
      IdentityToken                           String
  --------
  Response
  --------
    TraceOne.Api.Notification.Default.Messages.Queries.Subscriptions.GetSubscriptionsQuery+CategorisedSubscriptionsViewModel
      Subscriptions                           IDictionary<String, IList<SubscriptionViewModel>>
  --------
  Security
  --------
    GetSubscriptionsQuery requests require an identity token for an authenticated identity.

-------------------------------
GetUnreadNotificationCountQuery
-------------------------------
  -------
  Request
  -------
    TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetUnreadNotificationCountQuery
      WithDetailsPerSender                    Boolean
      GlobalUserId                            Guid
      MessageId                               Guid
      TimeOfCreationAtOrigin                  Nullable<DateTime>
      Headers                                 Dictionary<String, String>
      IdentityToken                           String
  --------
  Response
  --------
    TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetUnreadNotificationCountQuery+UnreadNotificationCountViewModel
      TotalUnreadCount                        Int32
      CountsBySenderZones                     List<TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetUnreadNotificationCountQuery+CountBySenderZone>
        TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetUnreadNotificationCountQuery+CountBySenderZone
          SenderZone                              String
          UnreadCount                             Int32
      CountsByExternalSystemNames             List<TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetUnreadNotificationCountQuery+CountByExternalSystemName>
        TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetUnreadNotificationCountQuery+CountByExternalSystemName
          ExternalSystemName                      String
          UnreadCount                             Int32
  --------
  Security
  --------
    GetUnreadNotificationCountQuery requests require an identity token for an authenticated identity.

---------------------------------
GetWebNotificationsByFiltersQuery
---------------------------------
  -------
  Request
  -------
    TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetWebNotificationsByFiltersQuery
      Skip                                    Int32
      Take                                    Int32
      LanguageCode                            String
      SenderZone                              String
      SearchText                              String
      NotificationEventUtcDateTimeAfter       Nullable<DateTime>
      NotificationEventUtcDateTimeBefore      Nullable<DateTime>
      Status                                  Nullable<TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetWebNotificationsByFiltersQuery+OccurrenceUserInstanceStatus>
      NotificationTypeIds                     List<Guid>
      GlobalUserId                            Guid
      MessageId                               Guid
      TimeOfCreationAtOrigin                  Nullable<DateTime>
      Headers                                 Dictionary<String, String>
      IdentityToken                           String
  --------
  Response
  --------
    TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetWebNotificationsByFiltersQuery+NotificationsViewModel
      ExternalNotifications                   List<TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetWebNotificationsByFiltersQuery+NotificationsViewModel+ExternalNotificationViewModel>
        TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetWebNotificationsByFiltersQuery+NotificationsViewModel+ExternalNotificationViewModel
          UnreadCount                             Int32
          ExternalSystemName                      String
          ExternalSystemUrl                       String
      Notifications                           List<TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetWebNotificationsByFiltersQuery+NotificationsViewModel+NotificationViewModel>
        TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetWebNotificationsByFiltersQuery+NotificationsViewModel+NotificationViewModel
          OccurrenceUserInstanceId                Guid
          NotificationSubject                     String
          NotificationContent                     String
          NotificationUrl                         String
          NotificationTypeId                      Guid
          NotificationTypeTitle                   String
          SenderZone                              String
          NotificationEventUtcDateTime            DateTime
          Status                                  TraceOne.Api.Notification.Constants.Enums.WebNotificationStatusCode
            TraceOne.Api.Notification.Constants.Enums.WebNotificationStatusCode
              Unread                                  0
              Read                                    1
          IsUserAllowedToSetPreferences           Nullable<Boolean>
      SkipAndTakeQueryStats                   TraceOne.ApiPlatform.MessagesSharedWithClients.Optional.SkipAndTakeQueryStats
        TraceOne.ApiPlatform.MessagesSharedWithClients.Optional.SkipAndTakeQueryStats
          TotalCount                              Int32
          CurrentCount                            Int32
      ServerDateTimeUtc                       DateTime
  --------
  Security
  --------
    GetWebNotificationsByFiltersQuery requests require an identity token for an authenticated identity.

---------------------------
GetWebNotificationsIdsQuery
---------------------------
  -------
  Request
  -------
    TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetWebNotificationsIdsQuery
      LanguageCode                            String
      SenderZone                              String
      SearchText                              String
      NotificationEventUtcDateTimeAfter       Nullable<DateTime>
      GlobalUserId                            Guid
      MessageId                               Guid
      TimeOfCreationAtOrigin                  Nullable<DateTime>
      Headers                                 Dictionary<String, String>
      IdentityToken                           String
  --------
  Response
  --------
    TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetWebNotificationsIdsQuery+NotificationsViewModel
      OccurrenceUserInstancesIds              List<Guid>
  --------
  Security
  --------
    GetWebNotificationsIdsQuery requests require an identity token for an authenticated identity.

------------------------
GetWebNotificationsQuery
------------------------
  -------
  Request
  -------
    TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetWebNotificationsQuery
      Skip                                    Int32
      Take                                    Int32
      LanguageCode                            String
      SenderZone                              String
      SearchText                              String
      NotificationEventUtcDateTimeAfter       Nullable<DateTime>
      GlobalUserId                            Guid
      MessageId                               Guid
      TimeOfCreationAtOrigin                  Nullable<DateTime>
      Headers                                 Dictionary<String, String>
      IdentityToken                           String
  --------
  Response
  --------
    TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetWebNotificationsQuery+NotificationsViewModel
      ExternalNotifications                   List<TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetWebNotificationsQuery+NotificationsViewModel+ExternalNotificationViewModel>
        TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetWebNotificationsQuery+NotificationsViewModel+ExternalNotificationViewModel
          UnreadCount                             Int32
          ExternalSystemName                      String
          ExternalSystemUrl                       String
      Notifications                           List<TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetWebNotificationsQuery+NotificationsViewModel+NotificationViewModel>
        TraceOne.Api.Notification.Default.Messages.Queries.WebNotifications.GetWebNotificationsQuery+NotificationsViewModel+NotificationViewModel
          OccurrenceUserInstanceId                Guid
          NotificationSubject                     String
          NotificationContent                     String
          NotificationUrl                         String
          NotificationTypeTitle                   String
          SenderZone                              String
          NotificationEventUtcDateTime            DateTime
          Status                                  TraceOne.Api.Notification.Constants.Enums.WebNotificationStatusCode
            TraceOne.Api.Notification.Constants.Enums.WebNotificationStatusCode
              Unread                                  0
              Read                                    1
      SkipAndTakeQueryStats                   TraceOne.ApiPlatform.MessagesSharedWithClients.Optional.SkipAndTakeQueryStats
        TraceOne.ApiPlatform.MessagesSharedWithClients.Optional.SkipAndTakeQueryStats
          TotalCount                              Int32
          CurrentCount                            Int32
      ServerDateTimeUtc                       DateTime
  --------
  Security
  --------
    GetWebNotificationsQuery requests require an identity token for an authenticated identity.


=============================================

------------------------
API Platform Error Codes
------------------------
  2f65ced1-ee26-400a-aa79-e0ce02092962    ApiMessageWithMessageIdHasAlreadyBeenProcessed
  15541748-28da-4753-807e-7a8104c45d74    MessageLogItemCreationFailure
  7520255f-152f-4e08-a081-f1bda0ff4d43    AuthenticatorFailure
  6a86426a-6082-4a9e-a295-937a81ea393f    AuthenticationRequired
  e3fcfb67-4e06-413c-8a8f-4519e01c5a87    AuthorisationFailure
  d4b50726-e3d1-432c-ab70-46baec1dbf8c    AuthorisationRequired