services notificationsRouteService

baasicNotificationsRouteService

Baasic Notifications Route Service provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Notifications Route Service to obtain needed routes while other routes will be obtained through HAL. By convention, all route services use the same function names as their corresponding services.

---

baasicNotificationsRouteService.publish.create()

Parses create publish route; this route does not expose any additional options.

Example:

baasicNotificationsRouteService.publish.create.expand({});

baasicNotificationsRouteService.publish.batch.create()

Parses create publish batch route; this route does not expose any additional options.

Example:

baasicNotificationsRouteService.publish.batch.create.expand({});

baasicNotificationsRouteService.subscriptions.users.create()

Parses create user subscription route; this route does not expose any additional options

Example:

baasicNotificationsRouteService.subscriptions.users.create.expand({});

baasicNotificationsRouteService.subscriptions.users.find()

Parses find user subscriptions route which can be expanded with additional options. Supported items are:

• searchQuery - A string referencing user subscription properties using the phrase search.
• userIds - Comma separated list of user identifiers.
• channels - Comma separated list of channels.
• page - A value used to set the page number, i.e. to retrieve certain user subscriptions subset from the storage.
• rpp - A value used to limit the size of result set per page.
• sort - A string used to set the user subscription property to sort the result collection by.
• embed - Comma separated list of resources to be contained within the current representation.

Example:

baasicNotificationsRouteService.subscriptions.users.find.expand({
    searchQuery: '<search-phrase>',
    channels: '<channel-name>,<channel-name>'
});

baasicNotificationsRouteService.subscriptions.users.get()

Parses get user subscription route; this route should be expanded with the Id of user subscription resource.

Example:

baasicNotificationsRouteService.subscriptions.users.get.expand({
    id: '<subscription-id>'
});

baasicNotificationsRouteService.subscriptions.users.batch.create()

Parses create user subscriptions batch route; this route does not expose any additional options

Example:

baasicNotificationsRouteService.subscriptions.users.batch.create.expand({});

baasicNotificationsRouteService.subscriptions.users.batch.remove()

Parses remove user subscriptions batch route; this route does not expose any additional options

Example:

baasicNotificationsRouteService.subscriptions.users.batch.remove.expand({});

baasicNotificationsRouteService.subscriptions.users.batch.update()

Parses update user subscriptions batch route; this route does not expose any additional options

Example:

baasicNotificationsRouteService.subscriptions.users.batch.update.expand({});

baasicNotificationsRouteService.subscriptions.anonymous.create()

Parses create anonymous subscription route; this route does not expose any additional options

Example:

baasicNotificationsRouteService.subscriptions.anonymous.create.expand({});

baasicNotificationsRouteService.subscriptions.anonymous.find()

Parses find anonymous subscriptions route which can be expanded with additional options. Supported items are:

• searchQuery - A string referencing user subscription properties using the phrase search.
• registrationIds - Comma separated list of anonymous registration identifiers.
• channels - Comma separated list of channels.
• page - A value used to set the page number, i.e. to retrieve certain user subscription subset from the storage.
• rpp - A value used to limit the size of result set per page.
• sort - A string used to set the user subscription property to sort the result collection by.
• embed - Comma separated list of resources to be contained within the current representation.

Example:

baasicNotificationsRouteService.subscriptions.anonymous.find.expand({
    searchQuery: '<search-phrase>',
    channels: '<channel-name>,<channel-name>'
});

baasicNotificationsRouteService.subscriptions.anonymous.get()

Parses get anonymous subscription route; this route should be expanded with the Id of anonymous subscription resource.

Example:

baasicNotificationsRouteService.subscriptions.anonymous.get.expand({
    id: '<subscription-id>'
});

baasicNotificationsRouteService.subscriptions.anonymous.batch.create()

Parses create anonymous subscription batch route; this route does not expose any additional options

Example:

baasicNotificationsRouteService.subscriptions.anonymous.batch.create.expand({});

baasicNotificationsRouteService.subscriptions.anonymous.batch.remove()

Parses remove anonymous subscription batch route; this route does not expose any additional options

Example:

baasicNotificationsRouteService.subscriptions.anonymous.batch.remove.expand({});

baasicNotificationsRouteService.subscriptions.anonymous.batch.update()

Parses update anonymous subscription batch route; this route does not expose any additional options

Example:

baasicNotificationsRouteService.subscriptions.anonymous.batch.update.expand({});

baasicNotificationsRouteService.registrations.users.create()

Parses create users registrations route; this route does not expose any additional options

Example:

baasicNotificationsRouteService.registrations.users.create.expand({});

baasicNotificationsRouteService.registrations.users.find()

Parses find users registrations route which can be expanded with additional options. Supported items are:

• searchQuery - A string referencing user subscription properties using the phrase search.
• userIds - Comma separated list of user identifiers.
• providers - Comma separated list of notification providers.
• page - A value used to set the page number, i.e. to retrieve certain user subscription subset from the storage.
• rpp - A value used to limit the size of result set per page.
• sort - A string used to set the user subscription property to sort the result collection by.
• embed - Comma separated list of resources to be contained within the current representation.

Example:

baasicNotificationsRouteService.registrations.users.find.expand({
    searchQuery: '<search-phrase>',
    providers: '<provider-name>,<provider-name>'
});

baasicNotificationsRouteService.registrations.users.get()

Parses get users registrations route; this route should be expanded with the Id of users registrations resource.

Example:

baasicNotificationsRouteService.registrations.users.get.expand({
    id: '<registration-id>'
});

baasicNotificationsRouteService.registrations.users.batch.create()

Parses create users registrations batch route; this route does not expose any additional options

Example:

baasicNotificationsRouteService.registrations.users.batch.create.expand({});

baasicNotificationsRouteService.registrations.users.batch.remove()

Parses remove users registrations batch route; this route does not expose any additional options

Example:

baasicNotificationsRouteService.registrations.users.batch.remove.expand({});

baasicNotificationsRouteService.registrations.users.batch.update()

Parses update users registrations batch route; this route does not expose any additional options

Example:

baasicNotificationsRouteService.registrations.users.batch.update.expand({});

baasicNotificationsRouteService.registrations.anonymous.create()

Parses create anonymous registrations route; this route does not expose any additional options

Example:

baasicNotificationsRouteService.registrations.anonymous.create.expand({});

baasicNotificationsRouteService.registrations.anonymous.find()

Parses find anonymous registrations route which can be expanded with additional options. Supported items are:

• searchQuery - A string referencing user subscription properties using the phrase search.
• providers - Comma separated list of notification providers.
• page - A value used to set the page number, i.e. to retrieve certain user subscription subset from the storage.
• rpp - A value used to limit the size of result set per page.
• sort - A string used to set the user subscription property to sort the result collection by.
• embed - Comma separated list of resources to be contained within the current representation.

Example:

baasicNotificationsRouteService.registrations.anonymous.find.expand({
    searchQuery: '<search-phrase>',
    providers: '<provider-name>,<provider-name>'
});

baasicNotificationsRouteService.registrations.anonymous.get()

Parses get anonymous registrations route; this route should be expanded with the Id of anonymous registrations resource.

Example:

baasicNotificationsRouteService.registrations.anonymous.get.expand({
    id: '<registration-id>'
});

baasicNotificationsRouteService.registrations.anonymous.batch.create()

Parses create anonymous registrations batch route; this route does not expose any additional options

Example:

baasicNotificationsRouteService.registrations.anonymous.batch.create.expand({});

baasicNotificationsRouteService.registrations.anonymous.batch.remove()

Parses remove anonymous registrations batch route; this route does not expose any additional options

Example:

baasicNotificationsRouteService.registrations.anonymous.batch.remove.expand({});

baasicNotificationsRouteService.registrations.anonymous.batch.update()

Parses update anonymous registrations batch route; this route does not expose any additional options

Example:

baasicNotificationsRouteService.registrations.anonymous.batch.update.expand({});

baasicNotificationsRouteService.settings.get()

Parses get notification settings route; this route should be expanded with the notification provider name.

Example:

baasicNotificationsRouteService.settings.get.expand({
    id: '<provider-name>'
});

baasicNotificationsRouteService.settings.update()

Parses update notification settings route; this route should be expanded with the notification provider name.

Example:

baasicNotificationsRouteService.settings.update.expand({
    id: '<provider-name>'
});

---

Notes:

• Refer to the REST API documentation for detailed information about available Baasic REST API end-points.
• URI Template syntax enables expanding the Baasic route templates to Baasic REST URIs providing it with an object that contains URI parameters.
• All end-point objects are transformed by the associated route service.