API changes: ACTION REQUIRED. Click the following for more info.
Thousands of requests each hour are currently being received with misspelled query parameters or otherwise ill-formed URL syntax.
The REST API currently silently ignores the invalid query params, so the developer isn't aware their intent is not well formed.
Frequent Mistakes Description
/orders?pgsize=100 (or orderspgsiz, pg_siz, pgziz) It must be spelled pgsiz. Close only counts in horseshoes and hand grenades.
/orders?order?pgsiz=100&pgnum=12 The ill-formed second ? makes "order?pgsiz" a query parameter. Therefore, the intended page size of 100 is ignored.
/orders?customerid=5&facilityid=7 Neither customerid nor facilityid are defined parameters for /orders. Numerous other examples similar to this for other URIs are received every day.
The customer/customeralertdefinitions rel has been replaced by the following rels:
Rel Description
customers/emailalertdef and customers/emailalertdefs To setup notitications via email for a customer (c2).
properties/emailtemplate To modify email templates at the threepl (c1) level.
customers/emailtemplate To create/modify email templates at the customer (c2) level
customers/ftpalertdef and customers/ftpalertdefs To setup notitications via ftp for a customer (c2)
Hypertext Application Language.

As stated in the description of the Billboard, 3PLCentral's REST API employs HATEOAS.
HAL is a popular standard for the wire format of links used in HATEOAS.

Formal description

See Mike Kelly's overview of HAL.
Also see the formal Internet-Draft standard at IETF.

Language bindings

3PLCentral's servers use an open source HAL media type formatter for C# called WebApi.Hal.

Because it is a standard, you are welcome to use whatever HAL-compliant client library you wish for your language of choice. If using C#, we recommend WebApi.Hal.

All example request and response payloads contained in this REL documentation are expressed in application/hal+json.

Industry usage

For information of industry uses of HAL, consult these representative examples:

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact [email protected] with any questions about this documentation.