Manufacturer Resources
Wednesday, 28 of January 2015
Introduction
The purpose of this section is to describe the Repcamp's manufacturer Resources. Each resource is described through a list fields definition guide and their uses in the Resources request / response actions
GET manufacturers
Receive a collection of manufacturer Objects.
Resource URL
http://api.repcamp.com/v1/manufacturers
Resource Information
Requests per rate limit window: unlimited/user
Authentication: Requires API auth
Response Formats: json
Resource family: manufacturers
Response Object: manufacturer
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/manufacturers?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/manufacturers?skip=200&take=20 |
Response
Status 200 - Content body: Array of customers
Status: 401 - Unauthorized
Status: 500 - Error
POST manufacturers
Add a manufacturer Object .
Resource URL
http://api.repcamp.com/v1/manufacturers
Resource Information
Requests per rate limit window: unlimited/user
Authentication: Requires API auth
Response Formats: json
Resource family: manufacturers
Post Object: manufacturers
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 manufacturers/bulk
Add a list of manufacturers
Resource URL
http://api.repcamp.com/v1/manufacturers/bulk
Resource Information
Requests per rate limit window: unlimited/user
Authentication: Requires API auth
Response Formats: json
Resource family: manufacturers
Post Object: manufacturer 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": "Manufacturer",
"total": 2,
"inserts": 2,
"updates": 0,
"errors": 0,
"items_error": [ ]
}
Status: 401 - Unauthorized
Status: 500 - Error
PUT manufacturers/:code
Update a manufacturer by code
Resource URL
http://api.repcamp.com/v1/manufacturers/:code
Resource Information
Requests per rate limit window: unlimited/user
Authentication: Requires API auth
Response Formats: json
Resource family: manufacturers
Post Object: manufacturer
API Version: v1.1
Parameters
Parameter | Required? | Description |
---|---|---|
code | Yes | manufacturer Code https://api.repcamp.com/v1/manufacturers/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 manufacturers/:code
Delete a manufacturer by code
Resource URL
http://api.repcamp.com/v1/manufacturers/:code
Resource Information
Requests per rate limit window: unlimited/user
Authentication: Requires API auth
Response Formats: json
Resource family: manufacturers
API Version: v1.1
Parameters
Parameter | Required? | Description |
---|---|---|
code | Yes | manufacturer Code https://api.repcamp.com/v1/manufacturers/CUS2200 |
Response
Status 200 - Content body: JSON Object that contains the guid of the object deleted: {_id:219918292198919}
Status: 401 - Unauthorized
Status: 500 - Error