Intended Purpose
Overview
This documentation is here to provide a reference for both incoming and outgoing data streams of the HPD Research API for HPD Collaborative Open Standard v2.3.
While outgoing data structures are not required to match the patterns described herein, it's recommended to follow these standard for consistency.
All incoming property values are set to Pascal Case and must be sent/received using exact Pascal Cased names shown here.
TIP
Use the Versions dropdown menu top right of the page to view other versions of the documentation.
What to Expect
On each doc page you'll find a Structure section which will illustrate the shape of the data with type values, and then all properties available for the given data structure.
Let's make up a data object example widget.
Structure
{
"Name": "<string>",
"Quantity": "<int>",
"Amount": "<float>",
"Status": "<bool>",
"Options": "<array|null>"
}Name
- type:
<string> - required:
true
INFO
Occasionally you'll see additional notes if something needs to be noted or explained. Otherwise this box will not appear at all.
Quantity
- type:
<int> - required:
true
IMPORTANT
Make sure you pay attention to yellow warning and red danger boxes for items that need special attention.
Amount
- type:
<float> - required:
true
WARNING
Numerical props will come in either <int>, <float> or <decimal>, make sure you note this in your internal storage.
Status
- type:
<bool> - required:
true
Options
- type:
<array> - related: Options
- required:
false - default:
<null|string>
TIP
Only props that are NOT required will have a default value, if at all. Props that show a related option are linked to their related data object.
If you have any questions or issues, this repository is public so you can feel free to open a discussion at Github.