Get Locations

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/getLocations

Use the Get Locations endpoint to retrieve a list of locations according to the search criteria. You can search by location ID, location name, and location street address. You can use a partial match for location name and location street address.

Form Data

apiLogin

string

required

Web service username, as provided by SoFi Tech Solutions.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by SoFi Tech Solutions.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

transactionId

string

required

1 to 60

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency.. A UUID is preferred.
Pattern: Maximum 60 characters
Example: "9845dk-39fdk3fj3-4483483478"

searchCriteria

string

required

^.+$

String containing the search criteria. Must be of the type specified in searchCriteriaType.
Pattern: Alphanumeric string
Example: "5544"

searchCriteriaType

string

required

^[1|2|3]$

Type of criteria that is specified in searchCriteria:

1 — Location ID
2 — Location name, full or partial
3 — Location street address, full or partial

Pattern: Numeric string
Example: "1"

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

default