services userProfileAvatarRouteService

baasicUserProfileAvatarRouteService

Baasic Article Files Route Service provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Article Files 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.

---

baasicUserProfileAvatarRouteService.get()

Parses get route; this route should be expanded with the Id of the profile.

Example:

baasicUserProfileAvatarRouteService.get.expand(
    {id: '<file-id>'}
);               

baasicUserProfileAvatarRouteService.link()

Parses link route; this route should be expanded with the Id of the profile.

Example:

baasicUserProfileAvatarRouteService.link.expand({id: '<file-id>'});              

baasicUserProfileAvatarRouteService.streams.get()

Parses get route; this route should be expanded with id of profile. Additional supported items are:

• width - width of desired derived image.
• height - height of desired derived image.

Example:

baasicUserProfileAvatarRouteService.streams.get.expand(
    {id: '<file-id>'}
);               

baasicUserProfileAvatarRouteService.streams.create()

Parses create route; this route should be expanded with the filename which indicates where the stream will be saved as well with id of the profile.

Example:

baasicUserProfileAvatarRouteService.streams.create.expand(
    {
        filename: '<filename>',
        id: '<file-id>'
    },
);               

baasicUserProfileAvatarRouteService.streams.update()

Parses update route; this route should be expanded with the id of the profile. Additional supported items are:

• width - width of derived image to update.
• height - height of derived image to update.

Example:

baasicUserProfileAvatarRouteService.streams.update.expand(
    {id: '<file-id>'}
);               

baasicUserProfileAvatarRouteService.parse()

Parses and expands URI templates based on RFC6570 specifications. For more information please visit the project GitHub page.

Example:

baasicUserProfileAvatarRouteService.parse(
	'<route>/{?embed,fields,options}'
).expand(
	{embed: '<embedded-resource>'}
);

---

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.