Candidate Write Method
The Candidate API provides access to the Candidate Resource.
Candidate Write enables the user to newly register or update personal contact information.
|
POST |
https://{Request URI Host}/v1/candidate?partition=[value] |
|---|
Scope
The access privilege required for Candidate Write is as follows:
candidate_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:
| Required | 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 |
|---|---|
| Candidate | Root element that indicates the Candidate data. |
| Item | Indicates one piece of Candidate information. |
| Field | Specify the item and value. For information on the Fields that can be specified, see Candidate - 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 |
|---|---|
| Candidate | Root element that indicates the Candidate data. |
| Item | Indicates one piece of Candidate information. |
| Id | The Id of the updated or newly registered Candidate. |
| Code | The code that represents the processing result. For details, see Result Code List. |
Candidate 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 a record with the name: Ichiro Suzuki and the phonetic subscription: ichiro suzuki.
|
Input XML <?xml version=”1.0” encoding=”UTF-8” standalone=”yes”?> |
|
Output XML <?xml version=”1.0” encoding=”UTF-8” standalone=”yes”?> |