GAgalileo-ft
Instant Issue

Get Load Locations

Use the Get Load Locations endpoint to retrieve a list of load locations that are nearest to the specified postal code.

post/getLoadLocations

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/getLoadLocations
  • Auth
    none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

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

apiTransKeystring required

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

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>.. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

programIdinteger required

A unique program identifier from SoFi Tech Solutions. Pattern: Positive integer Example: 1032

postalCodestring nullable

Postal code for the locations to retrieve. The finder returns load locations in and near this postal code. Pattern: 12345, 12345-6789 or K1A-1A1 Example: "84121"

resultCountinteger

The maximum number of records to return. Pattern: Integer 1–9999 Example: 100

latLongstring nullable

The latitude and longitude of the requester's location. The finder returns load locations near this geographical point. Pattern: Latitude/longitude pair separated by a comma and space; no limit on decimal places Example: 40.57297941556069, -111.89920138637734

newVersion0 | 1 nullable

Specifies whether to use the new version of the load-location finder:

  • 0 — Do not use the new version
  • 1 — Use the new version

Pattern: 0 or 1 Example: 1

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "programId": 1032,
  "postalCode": "84121",
  "resultCount": 100,
  "latLong": "40.57297941556069, -111.89920138637734"
}

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

Changes

No recorded changes to this operation across all 2 revisions of this API.