Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

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. 


Note

...

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.

...

Panel

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "api-info" and space = "OSD" and type = "page"

Authorization

Postman calls will need to be checked via the LDAP permissions before any data is returned. So a valid user must be used before making the call. The password will be the Lotus Notes Internet password for the user.

  • Select the "Authorization" tab
  • Set the type to "Basic Auth"
  • Enter your email and password

...

 All of these APIs are "GET" calls and return JSON data. All endpoints require an authorization header included in the request.

Panel

Base URL: https://ips-api-prod.salvationarmy.org/

Info

New base URL as of 1/31/2022.


Child pages (Children Display)
sorttitle


Authorization

In order to call IPS APIs, an `access_token` is required to be sent in the `authorization` header with the request. In order to retrieve a token, a client application registration is required. To set up machine-to-machine access, follow the steps outlined in the document below.

View file
nameIPS Api Documentation.pdf
height250


Info

Common error responses:


200 OK

Results were found that match the request and are included in the response body

401 UnauthorizedThe 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 ErrorOne or more request string parameters are invalid or an error was encountered by the server while processing the request

...

Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@132e0
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel = "api" and type = "page" and space = "OSD"
labelsapi moves-api

...

hiddentrue

...