Location

Gateway location details.

Overview

address string
associatedEntityID string read only   filterable   orderable  
associatedEntityName string read only   filterable   orderable  
associatedEntityType string read only   filterable   orderable  
country string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
ignoreGeocode boolean
lastUpdatedBy string autogenerated  
latitude float
locality string
longitude float
state string
timeZoneID string

API Resource

/locations/id
get put

Parents

/nsgateways/id/locations
get

Children

/locations/id/metadatas
get post
/locations/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

address string
Discussion

Formatted address including property number, street name, suite or office number, ...


Charateristics

Format: free
Max length: 255
SDK attribute: address

associatedEntityID string read only   filterable   orderable  
Discussion

Associated entity UUID.


Charateristics

Format: free
SDK attribute: associatedEntityID

associatedEntityName string read only   filterable   orderable  
Discussion

Name of the associated entity.


Charateristics

Format: free
SDK attribute: associatedEntityName

associatedEntityType string read only   filterable   orderable  
Discussion

Object type of the associated entity.


Charateristics

Format: free
SDK attribute: associatedEntityType

country string
Discussion

Country


Charateristics

Format: free
Max length: 255
SDK attribute: country

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level


Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems


Charateristics

Format: free
SDK attribute: externalID

ignoreGeocode boolean
Discussion

Request BSS to perform a geocode on the address - If no value passed, requestGeocode will be set to true


Charateristics

SDK attribute: ignoreGeocode

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

latitude float
Discussion

Latitude in decimal format.


Charateristics

Format: free
Min value: -90.0
Max value: 90.0
SDK attribute: latitude

locality string
Discussion

Locality/City/County


Charateristics

Format: free
Max length: 255
SDK attribute: locality

longitude float
Discussion

Longitude in decimal format.


Charateristics

Format: free
Min value: -180.0
Max value: 180.0
SDK attribute: longitude

state string
Discussion

State/Province/Region


Charateristics

Format: free
Max length: 255
SDK attribute: state

timeZoneID string
Discussion

Time zone in which the Gateway is located. This can be in the form of a UTC/GMT offset, continent/city location, or country/region. The available time zones can be found in /usr/share/zoneinfo on a Linux machine or retrieved with TimeZone.getAvailableIDs() in Java. Refer to the IANA (Internet Assigned Numbers Authority) for a list of time zones. URL : http://www.iana.org/time-zones Default value is UTC (translating to Etc/Zulu)


Charateristics

Format: free
SDK attribute: timeZoneID