REL documentation
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:
- Microsoft IIS Admin API
- Amazon API Gateway
- API Best Practices: Hypermedia (MS blog) wherein it states, "HAL is one of the most supported and most widely used hypermedia specs out there today, and is surrounded by a strong and vocal community."
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 api@3plcentral.com with any questions about this documentation.