Retrieving one or all LOC Records using the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.
See RFC 1876 for more information about LOC records.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
/REST/KXRecord/ GET — Retrieves one or all existing LOC Records on the zone/node indicated.
HTTP Action — GET
URIs:
Get one LOC Record — https://api.dynect.net/REST/LOCRecord/<zone>/<fqdn>/<record_id>/
Get LOC Records — https://api.dynect.net/REST/LOCRecord/<zone>/<fqdn>/ |
Arguments:
No Arguments. |
Response:
Get One LOC Record — Click for More Info
- string
fqdn — Fully qualified domain name of a node in the zone.
- hash
rdata — RData defining the record to add.
- string
altitude — Measured in meters above sea level.
- string
horiz_pre — Defaults to 10,000 meters.
- string
latitude — Measured in degrees, minutes, and seconds with N/S indicator for North and South. Example: 45 24 15 N, where 45 = degrees, 24 = minutes, 15 = seconds.
- string
longitude — Measured in degrees, minutes, and seconds with E/W indicator for East and West. Example 89 23 18 W, where 89 = degrees, 23 = minutes, 18 = seconds.
- string
size — Defaults to 1 meter.
- string
version — Number of the representation. Must be zero (0).
- string
vert_pre — Defaults to 10 meters.
- string
record_type — The RRType of the record.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
Get All LOC Records — Array of individual LOC record resources. |
SOAP Syntax
Click to view all SOAP Commands |
GetOneLOCRecord — Retrieves one existing LOC Record on the zone/node indicated.
GetLOCRecords — Retrieves all existing LOC Record on the zone/node indicated. |
Arguments:
GetOneLOCRecord — Click for More Info
- string
fqdn — Required. Name of the node where the record resides.
- string
record_id — Identifying record number for the record to retrieve.
- hash
rdata — RData defining the record to retrieve.
- string
altitude — Required. Measured in meters above sea level.
- string
horiz_pre — Required. Defaults to 10,000 meters.
- string
latitude — Required. Measured in degrees, minutes, and seconds with N/S indicator for North and South. Example: 45 24 15 N, where 45 = degrees, 24 = minutes, 15 = seconds.
- string
longitude — Required. Measured in degrees, minutes, and seconds with E/W indicator for East and West. Example 89 23 18 W, where 89 = degrees, 23 = minutes, 18 = seconds.
- string
size — Required. Defaults to 1 meter.
- string
version — Required. Number of the representation. Must be zero (0).
- string
vert_pre — Required. Defaults to 10 meters.
- string
token — Required. The session identifier.
- string
zone — Required. Name of the zone where the record resides.
GetLOCRecords — Click for More Info
string fqdn — Required. Name of node where the records will be replaced.
string token — Required. The session identifier.
string zone — Required. Name of zone where the records will be replaced.
|
Response:
GetOneLOCRecord — Click for More Info
- hash
data
- string
fqdn — Fully qualified domain name of a node in the zone.
- hash
rdata — RData defining the record
- string
altitude — Measured in meters above sea level.
- string
horiz_pre — Defaults to 10,000 meters.
- string
latitude — Measured in degrees, minutes, and seconds with N/S indicator for North and South. Example: 45 24 15 N, where 45 = degrees, 24 = minutes, 15 = seconds.
- string
longitude — Measured in degrees, minutes, and seconds with E/W indicator for East and West. Example 89 23 18 W, where 89 = degrees, 23 = minutes, 18 = seconds.
- string
size — Defaults to 1 meter.
- string
version — Number of the representation. Must be zero (0).
- string
vert_pre — Defaults to 10 meters.
- string
record_id — A numeric identifier for the record.
- string
record_type — The RRType of the record.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
GetLOCRecords — Click for More Info
- array
data
- string
fqdn — Fully qualified domain name of a node in the zone.
- hash
rdata — RData defining the record
- string
altitude — Measured in meters above sea level.
- string
horiz_pre — Defaults to 10,000 meters.
- string
latitude — Measured in degrees, minutes, and seconds with N/S indicator for North and South. Example: 45 24 15 N, where 45 = degrees, 24 = minutes, 15 = seconds.
- string
longitude — Measured in degrees, minutes, and seconds with E/W indicator for East and West. Example 89 23 18 W, where 89 = degrees, 23 = minutes, 18 = seconds.
- string
size — Defaults to 1 meter.
- string
version — Number of the representation. Must be zero (0).
- string
vert_pre — Defaults to 10 meters.
- string
record_id — A numeric identifier for the record.
- string
record_type — The RRType of the record.
- string
ttl — TTL for the record.
- string
zone — Name of the zone.
|
Example Request (GetOneLOCRecord) — Click for More Info
{
'fqdn' => 'www.example.com',
'rdata' => {
'latitude' => '42 21 43.528 N',
'longitude' => '42 21 43.428 E',
'altitude' => '63',
'horiz_pre' => '20',
'vert_pre' => '20',
'size' => '20',
'version' => '0',
},
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
or
{
'fqdn' => 'www.example.com',
'record_id' => '32',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
Example Request (GetLOCRecords) — Click for More Info
{
'fqdn' => 'www.example.com',
'token' => 'asdlkfjasl23j4879afa',
'zone' => 'example.com',
}
|
DNS API Knowledge Base