UNPKG

baasic-sdk-angularjs

Version:

AngularJS SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).

183 lines (128 loc) 4.99 kB
# baasicSkillService Baasic Skill Service provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Skill 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. * * * ### baasicSkillService.create() Returns a promise that is resolved once the create skill action has been performed; this action creates a new skill resource. **Example**: ```js baasicSkillService.create({ description : '<description>', name : '<name>', slug: '<slug>' }) .success(function (data) { // perform success action here }) .error(function (response, status, headers, config) { // perform error handling here }); ``` ### baasicSkillService.find() Returns a promise that is resolved once the find action has been performed. Success response returns a list of skill resources matching the given criteria. **Example**: ```js baasicSkillService.find({ pageNumber : 1, pageSize : 10, orderBy : '<field>', orderDirection : '<asc|desc>', search : '<search-phrase>' }) .success(function (collection) { // perform success action here }) .error(function (response, status, headers, config) { // perform error handling here }); ``` ### baasicSkillService.get() Returns a promise that is resolved once the get action has been performed. Success response returns the skill resource. **Example**: ```js baasicSkillService.get() .success(function (data) { // perform success action here }) .error(function (response, status, headers, config) { // perform error handling here }); ``` ### baasicSkillService.remove() Returns a promise that is resolved once the remove action has been performed. This action will remove a skill resource from the system if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicSkillRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects: ``` var params = baasicApiService.removeParams(skill); var uri = params['model'].links('delete').href; ``` **Example**: ```js // skill is a resource previously fetched using get action. baasicSkillService.remove(skill) .success(function (data) { // perform success action here }) .error(function (response, status, headers, config) { // perform error handling here }); ``` ### baasicSkillService.update() Returns a promise that is resolved once the update skill action has been performed; this action updates a skill resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicSkillRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects: ``` var params = baasicApiService.removeParams(skill); var uri = params['model'].links('put').href; ``` **Example**: ```js // skill is a resource previously fetched using get action. skill.description = '<description>'; baasicSkillService.update(skill) .success(function (data) { // perform success action here }) .error(function (response, status, headers, config) { // perform error handling here }); ``` ### baasicSkillService.batch.create() Returns a promise that is resolved once the create skill action has been performed; this action creates new skill resources. **Example**: ```js baasicSkillService.batch.create([{ description : '<description>', name : '<name>', slug: '<slug>' }]) .success(function (data) { // perform success action here }) .error(function (response, status, headers, config) { // perform error handling here }); ``` ### baasicSkillService.batch.update() Returns a promise that is resolved once the update skill action has been performed; this action updates specified skill resources. **Example**: ```js baasicSkillService.batch.update(companies) .success(function (data) { // perform success action here }) .error(function (response, status, headers, config) { // perform error handling here }); ``` ### baasicSkillService.batch.remove() Returns a promise that is resolved once the remove action has been performed. This action will remove skill resources from the system if successfully completed. **Example**: ```js baasicSkillService.batch.remove(skillIds) .success(function (data) { // perform success action here }) .error(function (response, status, headers, config) { // perform error handling here }); ``` * * * **Notes:** - Refer to the [REST API documentation](https://github.com/Baasic/baasic-rest-api/wiki) for detailed information about available Baasic REST API end-points. - All end-point objects are transformed by the associated route service.