Sales Write Method
The Sales API provides access to the Sales Resource.
Sales Write enables the user to newly register or update the specified job opening information.
|
POST |
https://{Request URI Host}/v1/sales?partition=[value] |
|---|
Scope
The access privilege required for Sales Write is as follows:
sales_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 |
|---|---|
| Sales | Root element that indicates the Sales data. |
| Item | Indicates one piece of Sales information. |
| Field | Specify the item and value. For information on the Fields that can be specified, see Sales - Field List. |
Notes on new registration and update
- When registering the sales information, the following dependency relation always holds;
P_Job -> Sales.P_Recruiter -> Sales.P_Client <- Sales.P_Contract
A -> B means that A is the lower-level resource of B.
When newly registering or updating a lower-level resource, the upper-level resource of that resource must also be recursively registered
Therefore, when newly registering or updating Sales.P_Recruiter, Sales.P_Client must also be newly registered or updated.
Sales.P_Recruiter itself alone cannot be newly registered or updated.
Similarly, when newly registering or updating Sales.P_Job, Sales.P_Recruiter and Sales.P_Client must also be newly registered or updated.
Note that in the case of clearing the values of these items, when the upper-level resource is cleared, the lower-level resource must also be cleared.
For example, when clearing Sales.P_Recruiter, Sales.P_Job must also be cleared. - When newly registering Sales.P_Candidate and Sales.P_Resume, both of them must be specified and the consistency of them is checked.
If either of them is specified at the time of update, consistency is checked between the value of the specified item and the value of the non-specified item before being updated.
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 |
|---|---|
| Sales | Root element that indicates the Sales data. |
| Item | Indicates one piece of Sales information. |
| Id | The Id of the updated or newly registered Sales. |
| Code | The code that represents the processing result. For details, see Result Code List. |
Sales 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 the Sales Amount of 3000000 and the Record Date of 01/01/2012.
As described in Notes on new registration and update , Client, Recruiter, Job, Candidate, and Resume must be specified.
|
Input XML <?xml version=”1.0” encoding=”UTF-8” standalone=”yes”?> |
|
Output XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> |