R2 API Resources

The key abstraction of information in REST is a resource.

Any information that can be named can be a resource: a document or image, entities (e.g. a customer, employee), and so on. REST uses a resource identifier to identify the particular resource involved in an interaction between components.

The exchange of information about a resource is done using methods (aka actions). The method is the type of request you send to the server. They are used to perform four possible actions: Create, Read, Update, and Delete (CRUD).

We are now supporting following resources...

Table 1.0: List of resources supported by our APIs

Resources	Method	Filters	Pagination	Path	Description
Accounts Groups	GET			/Groups	List of Groups
	GET			/Groups/{Id}	Get Group information
	POST			/Groups	Create Group
	PUT			/Groups/{Id}	Update Group

AR Batches	GET			/arbatches	List of Batches
AR Batches	GET			/arbatches/{id}	Get Batch information

Assets	GET			/assets	List of Assets
	GET			/assets/{id}	Get Asset information
	GET			/assets/{id}/changehistory	Get Asset bin and shelf change history
	PUT			/assets/{id}	Update Asset

Categories	GET			/categories	List of Categories

Containers	GET			/categories	List of Containers

Customers	GET			/Customers	List of Customers
	GET			/Customers/{Id}	Get Customer information
	POST			/Customers	Create Customer
	PUT			/Customers/{Id}	Update Customer
	PATCH			/Customers/{Id}	Partially update Customer

Departments	GET			/Departments	List of Departments

Events	GET			/events	List of Events
	GET			/events/{id}	Get Event information
	POST			/events	Create Event
	PUT			/events/{id}	Update Event information

Invoices	GET			/invoices/{id}	Get Invoice information
Invoices	POST			/invoices/{id}/post	Post Invoice

Items	GET			/Items	List of Items
	GET			/Items{Id}?siteid={sitdeId}	Get Item information
	PUT			/Items/{id}	Update Item information

Locations	GET			/locations	List of Locations

Orders	GET			/Orders	List of Orders
	GET			/Orders/{Id}	Get Order information
	POST			/Orders	Create Order
	POST			/Orders/{Id}/convert/{type}	Convert Order to a specific type
	PUT			/Orders/{Id}	Update Order

Projects	GET			/projects	List of Projects
	GET			/projects/{id}	Get Project information
	POST			/projects	Create Project
	PUT			/projects/{id}	Update Project

Sites	GET			/sites	List of Sites

Sub- Categories	GET			/subcategories	List of Sub-Categories

Receive entire Object as return while creating a object

Whenever a new object is created or an existing one is update through an API, the system returns the entire object along with all the values that were entered.

User Context

The R2 APIs have been enhanced to address the above issue, and now shall identify 'the user' (through the request header) who has request for the resource.

And the requested data is processed accordingly for each of the 'User Request' separately and simultaneously, and without affecting or overriding each other's changes.

Order of preference for empid:

'empid' if it exists in UserContext & is not blank
Else 'empid' specified in .ini file.

Order of preference for siteid:

'siteid' if it exists in UserContext & is not blank
Else default siteid of empid as mentioned in UserContext if empid is not blank
Else default siteid of empid as mentioned in .ini file.

Filters

You can search for relevant records using comparison operators ‘<’, ‘>’, ‘<=’, ’>=’, ‘!=’, ‘=’, and ‘LIKE’.

You can also search the records with multiple fields using conditional operators such as AND and OR.

For example: customerstate="{customerstate}" AND companyname="{companyname}" OR companyname LIKE "%{companyname}%"

You can search records on complex nested conditions also.

For example: customerid="{customerid}" AND (ordertype="{(ordertype}" OR ordertype="{ordertype}") OR shippingboothroomnumber= "{shippingboothroomnumbe}"

If ‘Filters’ are supported for the Verb by a specific API Resource, the same is signified by a Green Star in the table above.

Pagination

The records are returned in sets of 25 per page. ‘Next-Page’ attribute in the response header is the flag that tells you if another page exists.

If ‘Pagination’ is supported for the Verb by a specific API Resource, the same is signified by a Green Star in the table above.

To know more about our API's, and to get it on your test environment today, please reach out to our Sales team.