Path Parameters
The STS Gen2 APIs use the following path parameters. Required parameters may vary by endpoint; refer to the API and request documentation to determine where each parameter is required or used.
| Name | Description | Type/Format | Required | Example | API | Request |
|---|---|---|---|---|---|---|
| checkRef | Check identifier | string | Yes | "929aacee2c6d42c78ae877e824c28eed00000431" | Checks API | DELETE /checks/{checkRef}; Declared reusable parameter; GET /checks/{checkRef}; GET /checks/{checkRef}/printed; POST /checks/{checkRef}/round |
| discountCollectionId | Discount Collection Identifier | string | Yes | "discounts" | Configuration API v1 | Declared reusable parameter |
| LocRef | The location identifier. Will be forced to lower-case. | string | Yes | "fdmnh144" | Employees API | Declared reusable parameter |
| locRef | Location Identifier | string | Yes | "fdmnh144" | Organization API | Declared reusable parameter; GET /organizations/{orgShortName}/locations/{locRef}; GET /organizations/{orgShortName}/locations/{locRef}/revenueCenters; GET /organizations/{orgShortName}/locations/{locRef}/revenueCenters/{rvcRef} |
| menuId | The identifier for an individual menu. | string | Yes | "tfoinc:fdmnh144:42" | Configuration API v1 | Declared reusable parameter; GET /menus/{menuId} |
| menuId | The identifier for an individual menu. | string | Yes | "tfoinc:fdmnh144:42" | Configuration API v2 | Declared reusable parameter; GET /menus/{menuId} |
| OrgShortName | The organization identifier. Will be forced to lower-case. | string | Yes | "tfoinc" | Employees API | Declared reusable parameter |
| orgShortName | Organization identifier | string | Yes | "tfoinc" | Organization API | Declared reusable parameter; GET /organizations/{orgShortName}; GET /organizations/{orgShortName}/locations; GET /organizations/{orgShortName}/locations/{locRef}; GET /organizations/{orgShortName}/locations/{locRef}/revenueCenters; GET /organizations/{orgShortName}/locations/{locRef}/revenueCenters/{rvcRef} |
| rvcRef | Revenue Center Identifier | integer | Yes | 42 | Organization API | Declared reusable parameter; GET /organizations/{orgShortName}/locations/{locRef}/revenueCenters/{rvcRef} |
| serviceChargeCollectionId | Service Charge Collection Identifier | string | Yes | "serviceCharges" | Configuration API v1 | Declared reusable paramete |
| subscriptionId | Subscription Identifier | string | Yes | "7f49b2d0-6b30-4f02-b9a6-01d7c5b1b111" | Notifications API | DELETE /notifications/subscriptions/{subscriptionId}; Declared reusable parameter; GET /notifications/subscriptions/{subscriptionId} |
| tenderCollectionId | Tender Collection Identifier | string | Yes | "tenders" | Configuration API v1 | Declared reusable parameter |