scroll

Client - Write

Client Write Method

The Client API provides access to the Client Resource.

Client Write enables the user to newly register or update job opening information.

POST

https://{Request URI Host}/v1/client?partition=[value]

 

Scope

The access privilege required for Client Write is as follows:

client_w

 

Input Variables

When using the GET or POST Method, the parameter of the HTTP Header must be specified with a value. For details, see HTTP Header.

The following shows the Parameters that can be specified:

必須 Parameter Definition
partition Specify a numerical value for the Partition Id.
To check the Partition Id that can be accessed, acquire the information using Partition Read.

 

The following value can be specified in the XML format for the data block for POST.

Tag Definition
Client Root element that indicates the Client data.
Item Indicates one piece of Client information.
 Field Specify the item and value. For information on the Fields that can be specified, see Client - Field List.

 

Result Values

When the processing is successfully completed, “200” is returned to the Response Header as the HTTP status, and the value that is described in Output Values can be acquired.

If an error occurs, a value other than 200 is returned.

 

Output Values

The output value can be acquired in the XML format.

Tag Definition
Client Root element that indicates the Client data.
Item Indicates one piece of Client information.
 Id The Id of the updated or newly registered Client.
 Code The code that represents the processing result. For details, see Result Code List.

             

Client Write Sample

This sample code shown below is not encoded. In the case of an actual Request, encoding/decoding may be necessary depending on the content.

The following shows a sample when newly registering “AAA Corporation” and updating the phone number of the company whose Company ID is 10022.

Input XML

<?xml version=”1.0” encoding=”UTF-8” standalone=”yes”?>
<Client>
 <Item>
  <Client.P_Id>-1</Client.P_Id>
  <Client.P_Owner>1</Client.P_Owner>
  <Client.P_Name>AAA Corporation</Client.P_Name>
 </Item>
 <Item>
  <Client.P_Id>10022</Client.P_Id>
  <Client.P_Telephone>0123456789</Client.P_Telephone>
 </Item>
</Client>

 

Output XML

<?xml version=”1.0” encoding=”UTF-8” standalone=”yes”?>
<Client>
 <Item>
  <Id>10023<Id>
  <Code>0</Code>
 </Item>
 <Item>
  <Id>10022<Id>
  <Code>0</Code>
 </Item>
</Client >

 

 

Was this article helpful?
0 out of 0 found this helpful