登録

D-Client設定を新規登録します。

Request Interface

HTTP Request

POST /dclient/definition

Parameter

Request Parameter	Value	Required	Description	Default Value
dclientId	string	true	D-Client ID	-
connectionId	string	true	Connection ID	-
accountId	string	false	Account ID (UUID of the account)	Blank
memo	string	false	Note (Character string)	Blank
useable	boolean	false	Availability (true/false)	false

Response Interface

リクエストが正常に処理された場合、以下の JSON フォーマットでレスポンスを返却します。

{
	"id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	"dclientId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	"connectionId": "xxxxxxxxxxxxxxxx",
		"account":
		{
			"id":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
			"mailAddress":"sample@example.com"
		},
	"memo": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	"useable": true,
	"clientVersion": "1,0,0",
	"connectionStatus": "online"
}

Property Name	Value	Description
id	string	D-Client UUID (UUID)
dclientId	string	D-Client ID
connectionId	string	Connection ID
account	object	Accounts that is assigned to the D-Client settings.
memo	string	Note (Character string)
useable	boolean	Availability (true/false)
clientVersion	string	Client version (Version information in x.y.z. format)
connectionStatus	string	Connection status (online/offline)

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/dclient/definition");
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();
        String postData = "{\"dclientId\": \"sample\","
                    + "\"connectionId\": \"connectionId\","
                    + "\"accountId\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\","
                    + "\"memo\": \"memo\","
                    + "\"useable\": true}";
        connection.setRequestMethod("POST");
        connection.setDoOutput(true);
        connection.setDoInput(true);
        connection.setRequestProperty("Authorization", "Bearer " + apiKey);
        connection.setRequestProperty("Content-Type", "application/json");
        connection.setRequestProperty("Content-Length", Integer.toString(postData.length()));
        try (BufferedWriter writer = 
	     new BufferedWriter(new OutputStreamWriter(connection.getOutputStream()))) {
            writer.write(postData);
        }
        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: 'POST',
  url: host + '/api/v2/dclient/definition',
  headers: {
    Authorization: 'Bearer ' + apiKey
  },
  contentType: 'application/json',
  data: JSON.stringify({
            "dclientId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "connectionId": "connectionId",
            "accountId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "memo": "memo",
            "useable": true
  })
}).done(function(data, status, xhr) {
  console.log(data);
}).fail(function(data, status, xhr) {
  console.log(data);
});