Gateway location details.
| address |
| associatedEntityName |
| associatedEntityType |
| country |
| embeddedMetadata |
| entityScope |
| externalID |
| ignoreGeocode |
| lastUpdatedBy |
| latitude |
| locality |
| longitude |
| state |
| timeZoneID |
This object has no members.
Formatted address including property number, street name, suite or office number, ...
Format: free
Max length: 255
SDK attribute: address
Name of the associated entity.
Format: free
SDK attribute: associatedEntityName
Object type of the associated entity.
Format: free
SDK attribute: associatedEntityType
Country
Format: free
Max length: 255
SDK attribute: country
Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.
SDK attribute: embeddedMetadata
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
Request BSS to perform a geocode on the address - If no value passed, requestGeocode will be set to true
SDK attribute: ignoreGeocode
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
Latitude in decimal format.
Format: free
Min value: -90.0
Max value: 90.0
SDK attribute: latitude
Locality/City/County
Format: free
Max length: 255
SDK attribute: locality
Longitude in decimal format.
Format: free
Min value: -180.0
Max value: 180.0
SDK attribute: longitude
State/Province/Region
Format: free
Max length: 255
SDK attribute: state
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)
Format: free
SDK attribute: timeZoneID