Customer Resources

API version 1.0
Wednesday, 28 of January 2015

Introduction

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

 

GET customers

Receive a collection of Customer Objects.

 

Resource URL

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

 

Resource Information

Rate Limited? Yes
Requests per rate limit window: unlimited/user
Authentication: Requires API auth
Response Formats: json
 
HTTP Methods: GET
Resource family: customers
Response Object: customer
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/customers?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/customers?skip=200&take=20

Response

Status 200  - Content body: Array of customers

Status: 401 - Unauthorized

Status: 500 - Error

 

POST customers

Add a Customer Object .

 

Resource URL

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

 

Resource Information

Rate Limited? Yes
Requests per rate limit window: unlimited/user
Authentication: Requires API auth
Response Formats: json
 
HTTP Methods: POST
Resource family: customers
Post Object: customer
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 customers/bulk

Add a list of customers

 

Resource URL

http://api.repcamp.com/v1/customers/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: customers
Post Object: customer 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": "Customer",
"total": 2,
"inserts": 2,
"updates": 0,
"errors": 0,
"items_error": [ ]
}

 

Status: 401 - Unauthorized

Status: 500 - Error

 

PUT customers/:code

Update a customer by code

 

Resource URL

http://api.repcamp.com/v1/customers/: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: customers
Post Object: customer
API Version: v1.1

 

Parameters

Parameter Required? Description
code Yes Customer Code
https://api.repcamp.com/v1/customers/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 customers/:code

Delete a customer by code

 

Resource URL

http://api.repcamp.com/v1/customers/: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: customers
API Version: v1.1

Parameters

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

Response

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

Status: 401 - Unauthorized

Status: 500 - Error