|
Country
Object that represents a country serviced.
Supported API Calls: List | Get | Update
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique ID for a country object. When adding a new country the value must be 0. |
|
Name |
string (100) |
Name of the country. |
|
Code |
string (100) |
Two letter country code. |
|
CurrencyId |
integer |
ID of the currency object associated with this country. |
|
IsActive |
boolean |
Flag to indicate if this country is actively being serviced. |
|
IsDefault |
boolean |
Flag to indicate this is the default country. |
|
TaxId |
integer |
ID of the tax object for the country tax. This value is optional. |
|
TaxRate |
double |
Percentage value of the country tax rate. This value is optional. |
List
Description
Returns a list of active countries setup in BlueCamroo.
URL
https://{company}.bluecamroo.com/api/country/list?isActive={isActive}
HTTP Method
GET
Data Return
Returns the country list 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 a country.
URL
https://{company}.bluecamroo.com/api/country/get/{id}
HTTP Method
GET
Parameters
None
Data Return
Returns the specified country 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)
Update
Description
Updates a specified Country.
URL
https://{company}.bluecamroo.com/api/country/update
HTTP Method
PUT
Parameters
A country object.
Data Return
Returns the specified country 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)
|