OMS uses APIs to pull data from the IHQ database and load the information into the application. The OMS APIs can be run in Postman to access the desired JSON data. There are many options in Postman so the following outlines what a user needs to do in order to get results when calling an OMS API.
For more information on using Postman refer to their website: Postman Support.
Overview
URL
Users should refer to the articles below for each OMS API as the parameters will vary for each one. It is important to format the URL correctly to ensure the request can be returned. The following articles will offer additional information regarding each API URL and the available parameters. All of these APIs are "GET" calls and return JSON data. All endpoints require an authorization header included in the request.
Authorization
API calls will be validated via the LDAP permissions before any data is returned. Therefore, a valid user must be used when making the call. The password for the user will be the Lotus Notes Internet password.
- Select the "Authorization" tab
- Set the type to "Basic Auth"
- Enter your email and password
Common error responses:
200 OK | Results were found that match the request and are included in the response body |
| 401 Unauthorized | The current account in the request header does not have access to the API |
403 Forbidden | The current account in the request header does not have access to the territory requested in the request URL |
404 Not Found | Returned if NO results were found that match the specified criteria |
| 500 Internal Server Error | One or more request string parameters are invalid or an error was encountered by the server while processing the request |