View a Location by Code

get

/api/restapi/location/code/{locationCode}

This endpoint returns locations that meet the following requirements:
  • The object has a code that matches the value of the {locationCode} path parameter.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : List<ApiEntityLocation>
Type: array
Title: List<ApiEntityLocation>
Show Source
Nested Schema : ApiEntityLocation
Type: object
Title: ApiEntityLocation
Show Source
  • Minimum Length: 0
    Maximum Length: 200
    The first line of the address of a location.
    This might be the building number and street address.
  • Minimum Length: 0
    Maximum Length: 200
    The second line of the address of a location.
    This might be a neighborhood or town.
  • Allowed Values: [ "OWNED", "INHERITED" ]
    The type of association in the relationship between the location and the workspace. Possible values are Owned and Inherited.
  • Minimum Length: 0
    Maximum Length: 200
    The city name for a location.
  • Minimum Length: 0
    Maximum Length: 3
    The country for a location. The value is expressed as a three letter code.
  • Minimum Length: 0
    Maximum Length: 4000
    Additional details about the location.
  • Minimum Value: -90
    Maximum Value: 90
    The geographical coordinate for the latitude of the location.
    The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
  • Minimum Length: 1
    Maximum Length: 60
    The user-specified unique identifier of the location.
  • The unique identifier for the location.
  • Minimum Length: 1
    Maximum Length: 255
    A name for the location that your users will understand and recognize.
  • Minimum Value: -180
    Maximum Value: 180
    The geographical coordinate for the longitude of the location.
    The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
  • Minimum Length: 0
    Maximum Length: 20
    The postal code, post code, or zip code of a location.
  • Allowed Values: [ "MANUAL", "AUTOMATIC" ]
    The push down type of the location.
  • Minimum Length: 0
    Maximum Length: 2
    A unique identifier for the state or province.
  • Minimum Length: 0
    Maximum Length: 200
    The state, region, or province of a location.
  • Date when the record was last updated.
  • Minimum Length: 0
    Maximum Length: 60
    The user-specified identifier of a workspace.
  • The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

204 Response

Successful operation with no content.

404 Response

The requested location does not exist, or you do not have access to it.
Back to Top