============================================= API Schema | Notification API - Http | 10.8.0 ============================================= ---------------------------------- CreateOrUpdateEmailTemplateCommand ---------------------------------- TraceOne.Api.Notification.Default.Messages.Commands.EmailTemplate.CreateOrUpdateEmailTemplateCommand Id Guid Name String Translations List TraceOne.Api.Notification.Default.Messages.Commands.EmailTemplate.CreateOrUpdateEmailTemplateCommand+EmailTemplateTranslationModel LanguageCode String CompanyId Nullable IsDefault Boolean SubjectTemplate String ContentTemplate String ContentTemplateForDigest String SendinBlueTemplateId Nullable DoNotUseDefaultSendinBlueTemplate Boolean OverwriteExisting Boolean MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- CreateOrUpdateEmailTemplateCommand requests require an identity token for an authenticated identity with authorisation to permissions notificationEmailTemplates.write ----------- Error Codes ----------- 1727960a-25bc-4a3b-99c4-e0ae51c0826a NoSingleDefaultTranslation 178a47c0-5354-448f-ba9e-067b21a382c5 DuplicatedTranslationLanguage 996948a0-afa4-405e-9464-e9b15dc80072 TemplateNameAlreadyInUse ed436eb8-b027-45b2-9025-d1dc236688fe ErrorInSubjectTemplate f03b89cf-48c5-48c6-9c19-da759c6d6f65 ErrorInContentTemplate ------------------------------------- CreateOrUpdateNotificationTypeCommand ------------------------------------- TraceOne.Api.Notification.Default.Messages.Commands.NotificationType.CreateOrUpdateNotificationTypeCommand Id Guid FullyQualifiedName String SenderZone String Translations List TraceOne.Api.Notification.Default.Messages.Commands.NotificationType.CreateOrUpdateNotificationTypeCommand+NotificationTypeTranslationsModel LanguageCode String IsDefault Boolean Title String VariableNames List DefaultSubjectTemplate String DefaultContentTemplate String IsUserAllowedToSelfSubscribe Boolean IsUserAllowedToSubscribeInDigest Nullable OptionalAuthorisationUrl String OverwriteExisting Boolean DelegatedSenderZones List IsUserAllowedToSetPreferences Nullable DefaultCommunicationMethods List TraceOne.Api.Notification.Constants.Enums.CommunicationMethods Web 0 Email 1 CompanyActivities List RetainDays Nullable MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- CreateOrUpdateNotificationTypeCommand requests require an identity token for an authenticated identity with authorisation to permissions notificationTypes.write ----------- Error Codes ----------- 269e5a3c-16f0-41c0-a2a9-4a3236dfe830 NoSingleDefaultTranslation ce3ff848-8bbe-466e-b165-3a0e09cbd6ca DuplicatedTranslationLanguage 9a2dd1b2-45db-4b92-864b-68f6520ef83b FullyQualifiedNameAlreadyInUse 3a0fb0e3-b463-4b4d-a79a-bdcdc0ae356e ErrorInDefaultSubjectTemplate d1795ff4-0eef-48fb-8713-1b467fc1cb11 ErrorInDefaultContentTemplate 23769ef0-85f6-4251-be96-de99d7cecdcd DuplicateVariableNames ab6a80db-5955-46dd-b5ee-8c5b1244b4e0 UnknownSenderZone 142c261d-9f6c-405b-a4d2-4c6a519ab230 DuplicatedDelegatedSenderZones 8ee0ae58-710d-4cb7-b63a-201322df79f3 UnknownDelegatedSenderZones f869581a-ebd8-47fc-9f32-467f235b3937 UnknownDefaultCommunicationMethod ed66256b-37a2-4489-b481-0d62f84b1c44 UnknownCompanyActivity 81199c52-2e7c-401f-b1bf-8c4e9fb95e78 InvalidRetainDaysValue -------------------------------- CreateOrUpdateWebTemplateCommand -------------------------------- TraceOne.Api.Notification.Default.Messages.Commands.WebTemplate.CreateOrUpdateWebTemplateCommand Id Guid Name String Translations List TraceOne.Api.Notification.Default.Messages.Commands.WebTemplate.CreateOrUpdateWebTemplateCommand+WebTemplateTranslationModel LanguageCode String CompanyId Nullable IsDefault Boolean SubjectTemplate String ContentTemplate String OverwriteExisting Boolean MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- CreateOrUpdateWebTemplateCommand requests require an identity token for an authenticated identity with authorisation to permissions notificationWebTemplates.write ----------- Error Codes ----------- 1727960a-25bc-4a3b-99c4-e0ae51c0826a NoSingleDefaultTranslation 178a47c0-5354-448f-ba9e-067b21a382c5 DuplicatedTranslationLanguage 996948a0-afa4-405e-9464-e9b15dc80072 TemplateNameAlreadyInUse ed436eb8-b027-45b2-9025-d1dc236688fe ErrorInSubjectTemplate f03b89cf-48c5-48c6-9c19-da759c6d6f65 ErrorInContentTemplate -------------------------------------------- DeleteMultipleOccurrenceUserInstancesCommand -------------------------------------------- TraceOne.Api.Notification.Default.Messages.Commands.OccurrenceUserInstance.DeleteMultipleOccurrenceUserInstancesCommand OccurrenceUserInstanceIds IEnumerable MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- DeleteMultipleOccurrenceUserInstancesCommand requests require an identity token for an authenticated identity. ----------- Error Codes ----------- e524d770-0826-40ed-8a67-4b7154d021d5 CommandForUsersOnly ea433889-f579-4e3e-adf2-650240fc8115 NotAllIdsAreDistinct 26aca820-d5d4-46f7-8ec8-c2216d984dad SomeIdsAreInvalid 858ad0c2-2a86-427c-a79c-312cda333462 SomeInstancesCannotBeUpdatedByUser ----------------------------------- DeleteOccurrenceUserInstanceCommand ----------------------------------- TraceOne.Api.Notification.Default.Messages.Commands.OccurrenceUserInstance.DeleteOccurrenceUserInstanceCommand OccurrenceUserInstanceId Guid GlobalUserId Nullable MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- DeleteOccurrenceUserInstanceCommand requests require an identity token for an authenticated identity. ----------- Error Codes ----------- 49baa5c0-530a-4185-9624-312ef5d270d1 NotFound ----------------------------------------- DeleteUsersNotificationPreferencesCommand ----------------------------------------- TraceOne.Api.Notification.Default.Messages.Commands.NotificationPreference.DeleteUsersNotificationPreferencesCommand NotificationTypeId Guid GlobalUserId Nullable MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- DeleteUsersNotificationPreferencesCommand requests require an identity token for an authenticated identity. ----------- Error Codes ----------- adfeda72-c9a3-4ecf-87d6-9bbd4965ad1f NotFound 2a01a710-9768-4e98-9ba8-014dab4846c0 UserIsNotAllowedToRemovePreferences ------------------------------ MarkNotificationsAsReadCommand ------------------------------ TraceOne.Api.Notification.Default.Messages.Commands.NotificationPreference.MarkNotificationsAsReadCommand SenderZone String GlobalUserId Nullable MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- MarkNotificationsAsReadCommand requests require an identity token for an authenticated identity. ----------- Error Codes ----------- 6dea6836-a0c8-47d9-a15f-2cd1f45ca959 DisallowedAccessToken d6066c67-390a-44c7-8736-d58212b084c2 NotFound 9acf768f-95d2-42c7-94c7-e324b7176a5e UnknownSenderZone --------------------------------------------------- ModifyMultipleOccurrenceUserInstanceStatusesCommand --------------------------------------------------- TraceOne.Api.Notification.Default.Messages.Commands.OccurrenceUserInstance.ModifyMultipleOccurrenceUserInstanceStatusesCommand OccurrenceUserInstanceIds IEnumerable NewStatus TraceOne.Api.Notification.Default.Messages.Commands.OccurrenceUserInstance.ModifyMultipleOccurrenceUserInstanceStatusesCommand+OccurrenceUserInstanceStatus TraceOne.Api.Notification.Default.Messages.Commands.OccurrenceUserInstance.ModifyMultipleOccurrenceUserInstanceStatusesCommand+OccurrenceUserInstanceStatus Unread 0 Read 1 MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- ModifyMultipleOccurrenceUserInstanceStatusesCommand requests require an identity token for an authenticated identity. ----------- Error Codes ----------- b303c82c-bb0f-4d19-94c6-ba299d01881e CommandForUsersOnly d4d6b679-6977-449e-be83-f0595a754865 NotAllIdsAreDistinct a07eff03-ed60-4a4e-9ae9-701939392a39 SomeIdsAreInvalid 18c6ef49-62da-468b-be1b-c03ed23cfb2a SomeInstancesCannotBeUpdatedByUser ------------------------------------------- ModifyNotificationPreferencesForUserCommand ------------------------------------------- TraceOne.Api.Notification.Default.Messages.Commands.NotificationPreference.ModifyNotificationPreferencesForUserCommand NotificationPreferences IList TraceOne.Api.Notification.Default.Messages.Commands.NotificationPreference.ModifyNotificationPreferencesForUserCommand+NotificationPreferenceModel Level TraceOne.Api.Notification.Constants.Enums.NotificationPreferenceLevels TraceOne.Api.Notification.Constants.Enums.NotificationPreferenceLevels Undefined 0 SenderZone 1 NotificationType 2 SenderZone String NotificationTypeId Nullable CommunicationMethods IList TraceOne.Api.Notification.Constants.Enums.CommunicationMethods Web 0 Email 1 IsDigestActive Nullable DigestFrequency Nullable UserId Nullable MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- ModifyNotificationPreferencesForUserCommand requests require an identity token for an authenticated identity. ----------- Error Codes ----------- b1342578-37a2-49f5-843d-9e0f9540eeb0 DisallowedAccessToken f8c895a0-53ad-4685-ad02-b93324df4a24 IncorrectUserIdUsage 02c1d81b-e433-47b9-9720-f6e95ada2b7d UserNotFound 68721596-b4e8-42f4-98f7-dd9a94836a0c EmptyNotificationPreferences 7cbee904-f792-493c-9155-9315ce6d8f05 EmptyDigestFrequency 96eeaafd-b720-4558-b8ac-d60342de16ed UndefinedLevel 24fff710-e387-4163-8660-d5f00e1d0638 EmptySenderZone 0af0892e-ed1a-4806-b93a-71328d75f09f EmptyNotificationType 1be6db16-3019-4882-b2e6-7526d59fa6bc UndefinedCommunicationMethods 20be9741-c90a-4457-af80-0e12cbe2f5d3 SenderZoneNotRegistered 14bf2673-fe1d-4e47-85ee-8bae686bb775 NotificationTypeNotRegistered cd633df0-4143-4dc0-be6a-b90a78fd0e99 NotificationTypeDoesNotAllowSettingUserPreferences 3c093053-cab0-48af-9b05-a8b32baad6cd DuplicateNotificationPreferences 0f70afaa-f9bc-4b38-87cc-9d7ca6d426e5 TooManyNotificationTypeIds 1d4f292b-a7ed-4b33-824f-72b295859000 SenderZoneOutsideOfNotificationTypeDelegatedSenderZones 78d7316f-d0ac-4d28-8490-2a9cec3a9bf6 MultipleSenderZonesOnTheNotificationTypeNativeSenderZone 44674cf7-120c-4c8c-8ac8-9c97e75ed561 SenderZoneDifferentThanTheNotificationTypeNativeSenderZone 0eef28ba-a50d-4765-87f3-89982407a4f4 DigestActiveRequireEmailMethod 2d14d4fb-5c36-480e-b9d2-adc84c5dc81f DigestActiveRequireEmailFrequency 6da109a6-cf5c-4720-b9b0-e0776a7eb82e CommunicationMethodsOutsideOfNotificationTypeDefaultCommunicationMethod -------------------------------------- ModifyNotificationTypeTemplatesCommand -------------------------------------- TraceOne.Api.Notification.Default.Messages.Commands.NotificationType.ModifyNotificationTypeTemplatesCommand NotificationTypeId Guid NewWebTemplateId Nullable NewEmailTemplateId Nullable MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- ModifyNotificationTypeTemplatesCommand requests require an identity token for an authenticated identity with authorisation to permissions notificationTypes.write ----------- Error Codes ----------- 243c67d3-bbc0-418c-a22f-1f68b5fd3488 InvalidNotificationTypeId 2ef389b9-84b3-42ac-bff3-25f9df7f68b0 InvalidEmailTemplateId 6ea8ec54-d4ba-4515-9ae6-6ee436d024d8 InvalidWebTemplateId ----------------------------------------- ModifyOccurrenceUserInstanceStatusCommand ----------------------------------------- TraceOne.Api.Notification.Default.Messages.Commands.OccurrenceUserInstance.ModifyOccurrenceUserInstanceStatusCommand OccurrenceUserInstanceId Guid NewStatus TraceOne.Api.Notification.Default.Messages.Commands.OccurrenceUserInstance.ModifyOccurrenceUserInstanceStatusCommand+OccurrenceUserInstanceStatus TraceOne.Api.Notification.Default.Messages.Commands.OccurrenceUserInstance.ModifyOccurrenceUserInstanceStatusCommand+OccurrenceUserInstanceStatus Unread 0 Read 1 GlobalUserId Nullable MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- ModifyOccurrenceUserInstanceStatusCommand requests require an identity token for an authenticated identity. ----------- Error Codes ----------- a26f5cc9-0f02-403f-b96f-126a8f225a12 NotFound ------------------------------- ModifySubscribedItemNameCommand ------------------------------- TraceOne.Api.Notification.Default.Messages.Commands.Subscription.ModifySubscribedItemNameCommand SubscriptionId Guid NewSubscribedItemName String MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- ModifySubscribedItemNameCommand requests require an identity token for an authenticated identity. --------------------------------------------- ModifySubscriptionCommunicationMethodsCommand --------------------------------------------- TraceOne.Api.Notification.Default.Messages.Commands.Subscription.ModifySubscriptionCommunicationMethodsCommand SubscriptionId Guid NewCommunicationMethods IList TraceOne.Api.Notification.Default.Messages.Commands.Subscription.ModifySubscriptionCommunicationMethodsCommand+CommunicationMethods Web 0 Email 1 MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- ModifySubscriptionCommunicationMethodsCommand requests require an identity token for an authenticated identity. -------------------------------------- SubscribeToNotificationsForItemCommand -------------------------------------- ------- Request ------- TraceOne.Api.Notification.Default.Messages.Commands.Subscription.SubscribeToNotificationsForItemCommand NotificationTypeId Guid SubscribedItemId Nullable SubscribedItemUrl String SubscribedItemName String NotificationCommunicationMethods IList TraceOne.Api.Notification.Default.Messages.Commands.Subscription.SubscribeToNotificationsForItemCommand+CommunicationMethods Web 0 Email 1 MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Response -------- TraceOne.Api.Notification.Default.Messages.Commands.Subscription.SubscribeToNotificationsForItemCommand+SubscriptionResponse SubscriptionId Guid -------- Security -------- SubscribeToNotificationsForItemCommand requests do not require authentication. ------------------ UnsubscribeCommand ------------------ TraceOne.Api.Notification.Default.Messages.Commands.Subscription.UnsubscribeCommand SubscriptionId Guid MessageId Guid TimeOfCreationAtOrigin Nullable Headers Dictionary IdentityToken String -------- Security -------- UnsubscribeCommand requests do not require authentication. ============================================= ------------------------ 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