user-notifications
Operations addressed under /user-notifications — 4 operations.
aurax-bff-dynamic-get-user-notification-last-activity
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-user-notification-last-activity; this entry declares none of its own.
Response body, read from the service source
The route declares its response as UserNotificationActivityDto.
| Field | Declared type | Nullable |
|---|---|---|
NotificationLastReadDate | DateTime? | yes |
Member names are the service's declaration names.
aurax-bff-dynamic-get-user-notification-last-activity › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-dynamic-reset-user-notification-last-read-date
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target reset-user-notification-last-read-date; this entry declares none of its own.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
aurax-bff-dynamic-reset-user-notification-last-read-date › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-dynamic-get-user-notification-unread-count
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request and response fields are declared on the routing target get-user-notification-unread-count; this entry declares none of its own.
Response body, read from the service source
The route returns int, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON number, a 32-bit integer. This is a complete answer read from the declaration, not a gap.
aurax-bff-dynamic-get-user-notification-unread-count › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
aurax-bff-redirect-get-user-notification-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Request body description
The catalog declares Body-bound fields on this GET operation. Request bodies on GET have no defined semantics in HTTP; this documents the catalog, not a recommendation.
Response body, read from the service source
The route declares its response as IEnumerable<UserNotificationDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
GroupName | string | no |
NotificationType | int | no |
Message | string | no |
MessageParameters | Dictionary<string, object> | no |
IsRead | bool | no |
CreatedDate | DateTime | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeaurax-bff-redirect-get-user-notification-list › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.