Header Parameters
The API uses a variety of header parameters. Each API provides more information on parameters required for specific types of requests. The following table describes sample header parameters:
Name | Description | Type/Format | Required | Example | API | Request |
---|---|---|---|---|---|---|
SimphonyOrgShortName | The organization identifier | String | Yes | "tfoinc" | Configuration API | GET {basePath}/menus/{menuId} |
Simphony-LocRef | The location identifier | String | Yes | "fdmnh144" | Checks API | POST {basePath}/checks/calculator |
If-Modified-Since | Standard HTTP caching header (HTTP caching link) | String | No | Wed, 21 Oct 2015 07:28:00 GMT | Employees API | GET {basePath}/employees |