Contract Write Method
The Contract API provides access to Contract.
Contract Write enables the user to newly register or update company recruiter information.
|
POST |
https://{Request URI Host}/v1/contract?partition=[value] |
|---|
Scope
The access privilege required for Contract Write is as follows:
contract_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 |
|---|---|
| Contract | Root element that indicates the Contract data. |
| Item | Indicates one piece of Contract information. |
| Field | Specify the item and value. For information on the Fields that can be specified, see Contract - Field List. |
Notes on new registration and update
- Specify Contract.P_StartDate and Contract.P_EndDate as needed so that the following relational expression holds.
P_StartDate <= Contract.P_EndDate - Specify Contract.P_ContractorStartDate and Contract.P_ContractorEndDate as needed so that the following relational expression holds.
P_ContractorStartDate <= Contract.P_ContractorEndDate
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 |
|---|---|
| Contract | Root element that indicates the Contract data. |
| Item | Indicates one piece of Contract information. |
| Id | The Id of the updated or newly registered Contract. |
| Code | The code that represents the processing result. For details, see Result Code List. |
Contract 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 Contractor Type and updates the Contract End Date of the Contract ID: 10004 as the basic contract information associated with Client ID: 10001.
|
Input XML <?xml version=”1.0” encoding=”UTF-8” standalone=”yes”?> |
|
Output XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> |