Country Resources

Monday, 23 of February 2015

Introduction

The purpose of this section is to describe the Repcamp's country Resources. Each resource is described through a list fields definition guide and their uses in the Resources request / response actions

 

GET countries

Receive a collection of country Objects.

 

Resource URL

http://api.repcamp.com/v1/countries

 

Resource Information

Rate Limited? Yes
Requests per rate limit window: unlimited/user
Authentication: Requires API auth
Response Formats: json
 
HTTP Methods: GET
Resource family: countries
Response Object: country
API Version: v1.1

 

Parameters

Parameter Required? Description
skip No Number of objects to be get by the request. Required for a paginated request
https://api.repcamp.com/v1/countries?skip=200&take=20
take No Number of objects to be get by the request. Required for a paginated request
https://api.repcamp.com/v1/countries?skip=200&take=20

Response

Status 200  - Content body: Array of customers

Status: 401 - Unauthorized

Status: 500 - Error

 

POST countries

Add a country Object .

 

Resource URL

http://api.repcamp.com/v1/countries

 

Resource Information

Rate Limited? Yes
Requests per rate limit window: unlimited/user
Authentication: Requires API auth
Response Formats: json
 
HTTP Methods: POST
Resource family: countries
Post Object: countries
API Version: v1.1

Response

Status 200  - Content body: JSON Object that contains the guid of the object inserted: {_id:219918292198919}

Status: 401 - Unauthorized

Status: 500 - Error

 

POST countries/bulk

Add a list of countries

 

Resource URL

http://api.repcamp.com/v1/countries/bulk

 

Resource Information

Rate Limited? Yes
Requests per rate limit window: unlimited/user
Authentication: Requires API auth
Response Formats: json
 
HTTP Methods: POST
Resource family: countries
Post Object: country array
API Version: v1.1

Response

Status 200  - Content body: JSON Object
 

{Total:Elements sended
inserts: Number of inserts
updates: Number of updates
errors: Number of errors
items_error: array that contains the codes of the error objects. }

 

{
"item_type": "country",
"total": 2,
"inserts": 2,
"updates": 0,
"errors": 0,
"items_error": [ ]
}

 

Status: 401 - Unauthorized

Status: 500 - Error

 

PUT countries/:code

Update a country by code

 

Resource URL

http://api.repcamp.com/v1/countries/:code

 

Resource Information

Rate Limited? Yes
Requests per rate limit window: unlimited/user
Authentication: Requires API auth
Response Formats: json
 
HTTP Methods: GET
Resource family: countries
Post Object: country
API Version: v1.1

 

Parameters

Parameter Required? Description
code Yes country Code
https://api.repcamp.com/v1/countries/CUS2200
 

Response

Status 200  - Content body: JSON Object that contains the guid of the object updated: {_id:219918292198919}

Status: 401 - Unauthorized

Status: 500 - Error

 

DELETE countries/:code

Delete a country by code

 

Resource URL

http://api.repcamp.com/v1/countries/:code

 

Resource Information

Rate Limited? Yes
Requests per rate limit window: unlimited/user
Authentication: Requires API auth
Response Formats: json
 
HTTP Methods: DELETE
Resource family: countries
API Version: v1.1

Parameters

Parameter Required? Description
code Yes country Code
https://api.repcamp.com/v1/countries/CUS2200
 

Response

Status 200  - Content body: JSON Object that contains the guid of the object deleted: {_id:219918292198919}

Status: 401 - Unauthorized

Status: 500 - Error