Contact Write Method
The Contact API provides access to Contact.
Contact Write enables the user to newly register or update the company recruiter information.
|
POST |
https://{Request Host}/v1/contact?partition=[value] |
|---|
Scope
The access privilege required for Contact Write is as follows:
contact_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 accessible Partition Id, acquire the information using Partition Read. |
The following value can be specified in the XML format for the data block for POST.
| Tag | Definition |
|---|---|
| Contact | Root element that indicates the Contact data. |
| Item | Indicates one piece of Contact information. |
| Field | Specify the item and value. For information on the Fields that can be specified, see Contact - 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 |
|---|---|
| Contact | Root element that indicates the Contact data. |
| Item | Indicates one piece of Contact information. |
| Id | The Id of the updated or newly registered Contact. |
| Code | he code that represents the processing result. For details, see Result Code List. |
Contact 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 sample newly registers “Recruiter B” by associating it with the Client ID: 10001 and also updates the name of the Contact ID: 20001.
|
Input XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> |
|
Output XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> |