Category Resources

Wednesday, 28 of January 2015

Introduction

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

 

GET categories

Receive a collection of category Objects.

 

Resource URL

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

 

Resource Information

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

Response

Status 200  - Content body: Array of customers

Status: 401 - Unauthorized

Status: 500 - Error

 

POST categories

Add a category Object .

 

Resource URL

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

 

Resource Information

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

Add a list of categories

 

Resource URL

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

 

Status: 401 - Unauthorized

Status: 500 - Error

 

PUT categories/:code

Update a category by code

 

Resource URL

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

 

Parameters

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

Delete a category by code

 

Resource URL

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

Parameters

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

Response

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

Status: 401 - Unauthorized

Status: 500 - Error