# baasicCommerceCountryStateService

Baasic Commerce Country State Service provides an easy way to consume Baasic Commerce REST API end-points. In order to obtain a needed routes `baasicCommerceCountryStateService` uses `baasicCommerceCountryStateRouteService`.



* * *

### baasicCommerceCountryStateService.create() 

Returns a promise that is resolved once the create commerce action has been performed; this action creates a new commerce resource.


**Example**:
```js
baasicCommerceCountryStateService.create({  
  countryId : '<country-id>',
  name: '<name>',
  abrv: '<abrv>',
  description: '<description>'
})
.success(function (data) {
  // perform success action here
})
.error(function (response, status, headers, config) {
  // perform error handling here
});
```


### baasicCommerceCountryStateService.find() 

Returns a promise that is resolved once the find action has been performed. Success response returns a list of commerce resources matching the given criteria.


**Example**:
```js
baasicCommerceCountryStateService.find({
  countryId: '<country-id>'
  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
});    
```


### baasicCommerceCountryStateService.get() 

Returns a promise that is resolved once the get action has been performed. Success response returns the commerce resource.


**Example**:
```js
baasicCommerceCountryStateService.get('<state-id>')
.success(function (data) {
  // perform success action here
})
.error(function (response, status, headers, config) {
  // perform error handling here
});
```


### baasicCommerceCountryStateService.update() 

Returns a promise that is resolved once the update commerce action has been performed; this action updates a commerce resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicCommerceCountryStateRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.removeParams(commerceCountryState);
var uri = params['model'].links('put').href;
```


**Example**:
```js
// commerceCountryState is a resource previously fetched using get action.
commerceCountryState.description = '<description>';
baasicCommerceCountryStateService.update(commerceCountryState)
.success(function (data) {
  // perform success action here
})
.error(function (response, status, headers, config) {
  // perform error handling here
});
```


### baasicCommerceCountryStateService.remove() 

Returns a promise that is resolved once the remove action has been performed. This action will remove a commerce resource from the system if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicCommerceCountryStateRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.removeParams(commerceCountryState);
var uri = params['model'].links('delete').href;
```


**Example**:
```js
// commerceCountryState is a resource previously fetched using get action.				 
baasicCommerceCountryStateService.remove(commerceCountryState)
.success(function (data) {
  // perform success action here
})
.error(function (response, status, headers, config) {
  // perform error handling here
});		
```


### baasicCommerceCountryStateService.batch.create() 

Returns a promise that is resolved once the create commerce action has been performed; this action creates a new commerce resources.


**Example**:
```js
baasicCommerceCountryStateService.batch.create([{
  countryId: '<country-id>',  
  name : '<name>',
  abrv: '<abbreviation>',
  description: '<description>'
}])
.success(function (data) {
  // perform success action here
})
.error(function (response, status, headers, config) {
  // perform error handling here
});
```


### baasicCommerceCountryStateService.batch.remove() 

Returns a promise that is resolved once the remove commerce action has been performed. This action will remove commerce resources from the system if successfully completed.


**Example**:
```js
baasicCommerceCountryStateService.batch.remove(commerceCountryStateIds)
  .success(function (data) {
    // perform success action here
  })
  .error(function (response, status, headers, config) {
    // perform error handling here
  });		
```


### baasicCommerceCountryStateService.batch.update() 

Returns a promise that is resolved once the update commerce action has been performed; this action updates specified commerce resources.


**Example**:
```js
baasicCommerceCountryStateService.batch.update(commerceCountryStates)
  .success(function (data) {
    // perform success action here
  })
  .error(function (response, status, headers, config) {
    // perform error handling here
  });
```


### baasicCommerceCountryStateService.routeService() 

Provides direct access to `routeService`.


**Example**:
```js
baasicCommerceCountryStateService.routeService.get(expandObject);
```



* * *

**Notes:**
 - Refer to the [Baasic REST API](http://dev.baasic.com/api/reference/home) for detailed information about available Baasic REST API end-points.
 - All end-point objects are transformed by the associated route service.

*(c) 2017 Mono Ltd*

**Author:** Mono Ltd

**License:** MIT