Retrieving user account information 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.
Understanding How The API Works »
REST Syntax
Click to view all REST Resources |
User/ GET — If no user_name is specified, a list of available users will be returned. Otherwise, the information specific to the given user will be returned.
HTTP Action — GET
URIs:
Get one User — https://api.dynect.net/REST/User/<user_name>/
Get Users — https://api.dynect.net/REST/User/
|
Arguments:
No Arguments.
|
Response:
Get one User — Click for More Info
- string
address — The user’s street address.
- string
address_2 — The user’s street address, line 2.
- string
city — The user’s city.
- string
country — The user’s country.
- string
email — The user’s Email address.
- string
fax — The user’s fax number.
- string
first_name — First name of the user.
- string
last_name — Last name of the user.
- string
nickname — The nickname for the contact associated with the user.
- string
notify_email — Email address where the user should receive notifications.
- string
pager_email — Email address where the user should receive messages destined for a pager.
- string
organization — The user’s organization.
- string
phone — The user’s phone number. A phone number can have the form:
( 0 ) ( country-code ) ( local number ) ( ext extension )
Only the country-code (1-3 digits) and local number (at least 7 digits) are required. The extension can be up to 4 digits. Any non-digits are ignored.
- string
post_code — The user’s postal (zip) code.
- array
group_name — A list of permissions groups where the member belongs.
- string
status — Current user status.
- string
user_name — The user’s system name; used for logging-in.
- string
website — The URL of the user’s website.
Get Users — array of individual user resources.
|
SOAP Syntax
Click to view all SOAP Commands |
GetOneUser — Retrieves information about the specified user.
GetUsers — Retrieves all existing users in the account.
|
Arguments:
GetOneUser Arguments:
- string
token — Required. The session identifier.
- string
user_name — The user’s system username used for logging in.
GetUsers Arguments:
- string
token — Required. The session identifier.
|
Response:
GetOneUser — Click for More Info
- hash
data
- string
address — The user’s street address.
- string
address_2 — The user’s street address, line 2.
- string
city — The user’s city.
- string
country — The user’s country.
- string
email — The user’s Email address.
- string
fax — The user’s fax number.
- string
first_name — First name of the user.
- string
last_name — Last name of the user.
- string
nickname — The nickname for the contact associated with the user.
- string
notify_email — Email address where the user should receive notifications.
- string
pager_email — Email address where the user should receive messages destined for a pager.
- string
organization — The user’s organization.
- string
phone — The user’s phone number. A phone number can have the form:
( 0 ) ( country-code ) ( local number ) ( ext extension )
Only the country-code (1-3 digits) and local number (at least 7 digits) are required. The extension can be up to 4 digits. Any non-digits are ignored.
- string
post_code — The user’s postal (zip) code.
- array
group_name — A list of permissions groups where the member belongs.
- string
status — Current user status.
- string
user_name — The user’s system name; used for logging-in.
- string
website — The URL of the user’s website.
GetUsers — Click for More Info
- array
data
- string
address — The user’s street address.
- string
address_2 — The user’s street address, line 2.
- string
city — The user’s city.
- string
country — The user’s country.
- string
email — The user’s Email address.
- string
fax — The user’s fax number.
- string
first_name — First name of the user.
- string
last_name — Last name of the user.
- string
nickname — The nickname for the contact associated with the user.
- string
notify_email — Email address where the user should receive notifications.
- string
pager_email — Email address where the user should receive messages destined for a pager.
- string
organization — The user’s organization.
- string
phone — The user’s phone number. A phone number can have the form:
( 0 ) ( country-code ) ( local number ) ( ext extension )
Only the country-code (1-3 digits) and local number (at least 7 digits) are required. The extension can be up to 4 digits. Any non-digits are ignored.
- string
post_code — The user’s postal (zip) code.
- array
group_name — A list of permissions groups where the member belongs.
- string
status — Current user status.
- string
user_name — The user’s system name; used for logging-in.
- string
website — The URL of the user’s website.
|
Example Request (GetOneUser) — Click for More Info
{
'user_name'=>'userx',
'token'=> 'zaq12wsxcDe34rf89gt56nh',
}
|
Example Request (GetUsers) — Click for More Info
{
'token'=> 'zaq12wsxcDe34rf89gt56nh',
}
|
<< DNS API Knowledge Base