API
The API will continue to allow traditional 4-digit club numbers and 9-digit agreement numbers. It will also be updated to accept true 5-digit club numbers and 10-digit agreement numbers in the URI
Stands for "Uniform Resource Identifier;" it is a string of characters used to identify a resource on a computer network. The best know type is the web address or URL. (true means that the number begins with 1-9; it has no leading zeros).
The API will not accept a 5-digit club number or a 10-digit agreement number that begins with a leading zero. If a 5-digit club number or 10-digit agreement number is sent, a 404 (Not Found) error will occur.
As long as the request contains a traditional 4-digit club number/9-digit agreement number or a true 5-digit club number/10-digit agreement number (with no leading zeros), the response will echo what was sent in the request.
For example:
| If the request contains a... | The response will contain a... |
|---|---|
| 4-digit club number (EX: 9003) | 4-digit club number (EX: 9003) |
| 5-digit club number (EX: 12345) | 5-digit club number (EX: 12345) |
| 9-digit agreement number (EX: 900312345) | 9-digit agreement number (EX: 900312345) |
| 10-digit agreement number (EX: 1234567890) | 10-digit agreement number (EX: 1234567890) |
Allowing 4- or 5-digit club numbers and echoing the number sent in the request provides the following benefits.
- Vendors will not be forced to coordinate migration of their databases at the same time ABC does. They will be able to maintain existing data as it is today.
- The 2.0 Door will leverage the club number from the local database's config table to call REST APIs for multiple endpoints. (For more information, see the Door System.)