Getting All Information

You can get all the information of the previous secondary account for Browser Transfer settings.

Request Interface

HTTP Request

GET /secondary-account/definition

Parameter

There is no individual parameter for this request.

For details on common request parameters for Site API, refer to Common Parameter.

Authorization

In the API Key Management screen in Management Console, 'Previous secondary account for Browser Transfer Settings' under the 'Scopes' field must be selected as 'Get'.

Response Interface

If the request is processed successfully, the following response is returned in JSON format.

{
  "totalSize": 10,
  "fetchSize": 10,
  "startIndex": 0,
  "maxResults": 30,
  "existUnavailableMail": false,
  "secondaryAccounts": [
    {
      "secondaryAccountId": "xxxxxxxxxxxxxxxxxxxxxx",
      "secondaryAccount": "xxxxxxxxxxxxxxxxxxxxxxx",
      "passwordPolicy": {
        "passwordManagement": 1,
        "passwordExpireOn": 30
      },
      "browserToHulftDefinitions": [
        {
          "id": "foo",
          "description": ".."
        },
        {
          "id": "bar",
          "description": ".."
        }
      ],
      "hulftToBrowserDefinitions": [
        {
          "id": "hoge",
          "description": ".."
        },
        {
          "id": "fuga",
          "description": ".."
        }
      ],
      "ipFilterGroupName": "xxxxxxxxxxxxxxxxxxxxxxx",
      "memo": "xxxxxxxxxxxxxxxxxxxxxxx",
      "isAvailableMail": true,
      "statusCode": 1
    },
    {
      "secondaryAccountId": "xxxxxxxxxxxxxxxxxxxxxx",
      "secondaryAccount": "xxxxxxxxxxxxxxxxxxxxxxx",
      "passwordPolicy": {
        "passwordManagement": 0,
        "passwordExpireOn": 0
      },
      "browserToHulftDefinitions": [],
      "hulftToBrowserDefinitions": [],
      " ipFilterGroupName": "xxxxxxxxxxxxxxxxxxxxxxx",
      "memo": "xxxxxxxxxxxxxxxxxxxxxxx",
      "isAvailableMail": false,
      "statusCode": 0
    }
  ]
}

Property Name	Value	Description
totalSize	integer	The total number of data
fetchSize	integer	The number of the obtained data
startIndex	integer	Index of the first row of a data to retrieve
maxResults	integer	The maximum number of indexes included in a response data
existUnavailableMail	boolean	Whether there is an email address for which sending an email is stopping now
secondaryAccountId	string	ID to specify a previous secondary account for Browser Transfer
secondaryAccount	string	Previous secondary account for Browser Transfer (email address)
passwordPolicy	object	The password policy
passwordManagement	integer	Password Management Method (0: Management by a user with a previous secondary account for Browser Transfer, 1: Management by the contractor)
passwordExpireOn	integer	The password validity period (0 (the password never expires) or 30 to 365 days)
browserToHulftDefinitions	array	Transfer settings (for Send File)
id	string	Transfer Settings ID (for Send File)
description	string	Description of the transfer settings (for Send File)
hulftToBrowserDefinitions	array	Transfer settings (for Send Request)
id	string	Transfer Settings ID (for Send Request)
description	string	Description of the transfer settings (for Send Request)
ipFilterGroupName	string	IP Filter Group Name
memo	string	Note for the previous secondary account for Browser Transfer
isAvailableMail	boolean	Whether or not to send an email to the email address
statusCode	integer	The status of the previous secondary account for Browser Transfer (0: New creation, 1: In use, 2: While changing Password Management Method, 3: While changing the email address)

Examples

Java JavaScript

public static void main(String[] args) {
    String host = "https://www.webconnect.hulft.com";
    String apiKey = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
    try {
        URL url = new URL(host + "/api/v2/secondary-account/definition");
        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';
$.ajax({
  type: 'GET',
  url: host + '/api/v2/secondary-account/definition',
  headers: {
    Authorization: 'Bearer ' + apiKey
  }
}).done(function(data, status, xhr) {
  console.log(data);
}).fail(function(data, status, xhr) {
  console.log(data);
});