Oracle Prime Cloud Release 16

Returns the location specified by the location name.

get

/primeapi/restapi/v16.2/location/name/{name}

Request

Path Parameters

name: Type: string

Required: true

Name of the location to be found.

Response

Supported Media Types

application/json

200 Response

successful operation

Body

Root Schema : ApiEntityLocation

Type: object

Properties

addressLine1: Type: string

Allowed Values: [ "Length[1-200]" ]

The first line of the address of a location. This might be the building number and street address.
addressLine2: Type: string

Allowed Values: [ "Length[1-200]" ]

The second line of the address of a location. This might be a neighborhood or town.
cityName: Type: string

Allowed Values: [ "Length[1-200]" ]

The city name for a location.
countryCode: Type: string

Allowed Values: [ "Length[1-3]" ]

The country for a location. The value is expressed as a three letter code.
description: Type: string

Additional details about the location.
latitude: Type: number (double)

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.
locationCode: Type: string

Allowed Values: [ "Length[1-60]" ]

The unique identifier for the location.
locationId: Type: integer (int64)

The unique identifier for the location.
locationName: Type: string

Allowed Values: [ "Length[1-255]" ]

A name for the location that your users will understand and recognize.
longitude: Type: number (double)

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.
postalCode: Type: string

Allowed Values: [ "Length[1-20]" ]

The postal code, post code, or zip code of a location.
stateCode: Type: string

Allowed Values: [ "Length[1-2]" ]

A unique identifier for the state or province.
stateName: Type: string

Allowed Values: [ "Length[1-200]" ]

The state, region, or province of a location.
workspaceId: Type: integer (int64)

404 Response

The Location do not exist or you do not have access to it.