RESTful Web Services API
- Olivier Michaut
- IT Stonebranch
Overview
UDMG supports a RESTful-based web services API that allows you to perform multiple operations, which are listed alphabetically on the following pages.
Formatting specifications for each web service, including details about field requirements, are provided.
Methods of API Operations
Every API operation is performed using one of the following methods:
Â
Method | Description |
|---|---|
GET | Retrieves records from the UDMG database. |
POST | Creates, or performs an action on a record in the UDMG database. |
PUT | Modifies a record in the UDMG database. Note PUT, by itself, actually replaces an existing record with whatever information you include in the PUT operation. If you include only partial record information in a PUT, the record in the database will then contain only that information. In order to modify information in a record and retain all of its unmodified information, you must first GET the record from the database, modify (add/delete/change) information in the record, and then PUT the record back in the database |
DELETE | Deletes a record in the UDMG database. |
Access
Access to the UDMG requires basic HTTP authentication over HTTPS.
The following methods are used:
- HTTP GET is used for data look up (no data is modified).
- HTTP PUT and POST are used for data modification such as create and update.
Returned Messages
The following table identifies the status codes (part of the HTTP/1.1 standard) that can be returned.
Status Code | Description |
|---|---|
200 | Success |
400 | Bad request data. |
401 | User does not have authorization (password identification failure). |
403 | User does not have permission to access Web Services.
|
404 | Resource not found. |
| 429 | Too Many Requests. |
500 | All other errors. |
| 503 | Service Unavailable. |
Any other failure status codes may be returned by the underlying RESTful services. Most resources (UDMG records) are returned as JSON.