|
Region
An object that defines a region for a parent country object.
Supported API Calls: List | Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique ID representing the region object. When adding a new region the value must be 0. |
|
CountryId |
integer |
The ID of the parent country object. |
|
CountryName |
string (100) |
The name of the parent country. |
|
Name |
string (100) |
Name of the region. |
|
Code |
string (100) |
A region code. |
|
TaxRate |
float |
The tax rate for the region. |
|
RegionTaxList |
List<RegionTax> |
A list of regions and their tax rates. |
List
Description
Returns a list of regions associated with a country.
URL
https://{company}.bluecamroo.com/api/region/list?countryId={countryId}
HTTP Method
GET
Parameters
Data Return
Returns a list of regions in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
401: Not authorized (you need to log in)
Get
Description
Returns the details of the region specified by its id.
URL
https://{company}.bluecamroo.com/api/region/get/{id}
HTTP Method
GET
Parameters
None
Data Return
Returns the region object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds the region to the country's list of regions.
URL
https://{company}.bluecamroo.com/api/region/add
HTTP Method
POST
Parameters
A region object
Data Return
Returns the region object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Update
Description
Updates a region.
URL
https://{company}.bluecamroo.com/api/region/update
HTTP Method
PUT
Parameters
A region object
Data Return
Returns the region object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Delete
Description
Deletes the specified region.
URL
https://{company}.bluecamroo.com/api/region/delete/{id}
HTTP Method
DELETE
Parameters
None
Data Return
None
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
|