1. Simphony Transaction Services Gen2 API Guide
  2. Tasks
  3. Organization API

Get search for locations within an organization

get

/api/v1/search/locations

{basePath}/search/locations?orgShortName=tfoinc&latitude=40.763188&longitude=-73.914835&radius=50000&floor=1&count=2

The API returns a list of locations within an organization based on distance from the given geo-coordinate.

Supported only for STS Gen2 cloud integrations.

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : distanceLocation
Type: object
Read Only: true
A search results of locations.
Show Source
Nested Schema : location
Type: array
Array of Location objects.
Show Source
  • Location
    Title: Location
    A location represents the places of business within a customer's organization. A location can have one or more revenue centers.
Nested Schema : Location
Type: object
Title: Location
A location represents the places of business within a customer's organization. A location can have one or more revenue centers.
Show Source
Example:
{
    "orgShortName":"tfoinc",
    "locRef":"fdmnh144",
    "name":"Fred Dome Stadium",
    "currency":"USD",
    "languages":[
        "en-GB",
        "fr-FR",
        "de-DE"
    ],
    "timezone":{
        "ianaName":"Europe/London",
        "windowsName":"GMT Standard Time",
        "tzIndex":85
    },
    "address":{
        "addressLine1":"144 W 94th St",
        "addressLine2":"Suite 11F",
        "floor":"42A",
        "locality":"New York",
        "region":"NY",
        "postalCode":"10019",
        "country":"USA",
        "notes":"West Entrance"
    },
    "phoneNumber":"(0030) 0456 343 234",
    "geoLocation":{
        "latitude":40.773188,
        "longitude":-73.994835
    },
    "posPlatform":{
        "name":"Oracle.Simphony",
        "version":"19.2.0.1234"
    }
}
Nested Schema : PostalAddress
Type: object
Represents a postal address
Show Source
Nested Schema : ExtensionData
Type: object
Additional Properties Allowed
Show Source
Container for extension data
Nested Schema : GeoLocation
Type: object
Coordinate of a location
Show Source
Nested Schema : languages
Type: array
Array of language culture reference strings configured for the location. First language listed is the default used if a request is made for an undefined language
Show Source
Example:
[
    "en-GB",
    "fr-FR",
    "de-DE"
]
Nested Schema : PosPlatform
Type: object
Identifies the POS Platform running at the location.
Show Source
Nested Schema : Timezone
Type: object
Represents the associated timezone
Show Source

400 Response

400 Bad Request
Body ()
Root Schema : OrganizationApiProblemDetails
Type: object
Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807).
Show Source
  • A human-readable explanation specific to this occurrence of the problem.
  • A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
  • A short, human-readable summary of the problem type.
  • A URI reference [RFC3986](https://tools.ietf.org/html/rfc3986) that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".
Example:
{
    "type":"error:validation",
    "title":"Required value not specified.",
    "details":"The OrgShortName value is required.",
    "instance":"required_value_missing"
}

401 Response

401 Unauthorized

403 Response

403 Forbidden

404 Response

404 Requested resource not found
Back to Top

Examples

Example Request Body

Not applicable for this endpoint.

Example Response Body

The following example shows the contents of the response body in JSON format:


{
  "items": [
    {
      "distance": 0,
      "location": {
        "orgShortName": "tfoinc",
        "locRef": "fdmnh144",
        "name": "The Food Organization Inc",
        "currency": "USD",
        "languages": [
          "en-GB",
          "fr-FR",
          "de-DE"
        ],
        "timezone": {
          "ianaName": "America/New_York",
          "windowsName": "Eastern Standard Time",
          "tzIndex": 23
        },
        "address": {
          "addressLine1": "144 W 54th St",
          "addressLine2": "Suite 11B",
          "floor": "42A",
          "locality": "New York",
          "region": "NY",
          "postalCode": "10019",
          "country": "USA",
          "notes": "West Entrance"
        },
        "phoneNumber": "(0030) 0453 343 234",
        "geoLocation": {
          "latitude": 40.763188,
          "longitude": -73.914835
        },
        "posPlatform": {
          "name": "Oracle.Simphony",
          "version": "19.2.0.1234"
        }
      }
    }
  ]
}
Back to Top