Getting One Piece of Information
You can get one piece of account information.
Request Interface
HTTP Request
GET /accounts/definition/{accountId}
Parameter
Path Parameter |
Value |
Required |
Description |
Default Value |
---|---|---|---|---|
accountId |
string |
true |
ID of the account to get(32 alphanumeric characters) |
- |
Response Interface
If the request is processed successfully, the following response is returned in JSON format.
{ "id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "mailAddress": "sample@example.com", "statusCode": 0, "isVerifiedMailAddress": true, "passwordValidityPeriod": 0, "ipFilterGroupName": null, "memo": "xxxxxxxxxxxxxxxxxxxxxx" }
Property Name |
Value |
Description |
---|---|---|
id |
string |
ID of the registered account. |
mailAddress |
string |
Email address |
statusCode |
number |
Status code of the account. (0: New, 1: In use, 2: Changing password management method, 3: Changing email address) |
isVerifiedMailAddress | boolean | Whether the email address is verified or not. True if it is verified. |
passwordValidityPeriod |
number |
Password validity period. The unit is days. |
ipFilterGroupName | string | IP filter group name that is used to restrict access based on source IP address. |
memo | string | Note for the account. |
Examples
public static void main(String[] args) { String host = "https://www.webconnect.hulft.com"; String apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"; String accountId = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"; try { URL url = new URL(host + "/api/v2/accounts/definition/" + accountId); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("GET"); connection.setRequestProperty("Authorization", "Bearer " + apiKey); try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) { String line; while((line = reader.readLine()) != null) { System.out.println(line); } } } catch (IOException ex) { // error } }
// load jquery var host = 'https://www.webconnect.hulft.com'; var apiKey = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'; var accountId = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'; $.ajax({ type: 'GET', url: host + '/api/v2/accounts/definition/' + accountId, headers: { Authorization: 'Bearer ' + apiKey } }).done(function(data, status, xhr) { console.log(data); }).fail(function(data, status, xhr) { console.log(data); });