Phase Read Method
The Phase API provides access to Phase of a Resource.
Phase Read allows the user to acquire the Phase data of the Resource that meets the specified conditions.
|
GET |
https://{Request URI Host}/v1/phase?partition=[value]&resource=[value]&resourceId=[value]&id=[value]&count=[value]&start=[value]&field=[value,...]&condition=[field=value,...]&order=[value,...] |
|---|
Scope
The access privilege required for Phase Read is as follows:
phase_r
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:
Each Parameter is an AND condition for search.
| 必須 | 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. |
| ● | resource | Specify the Resource you want to acquire. For information on the values that can be specified, see Resource List. |
| ー | resourceId | The item that Indicates the Id of the of the relevant Resource. The Id of Candidate, Job or other Resources applies to this. To perform OR search by specifying multiple Ids, specify Resource Ids for the condition parameter. |
| ー | id | Specify the Id of the Phase you want to acquire. To perform OR search by specifying multiple Ids, specify Phase Ids for the condition parameter. |
| ー | count | Specify the number of records of data to acquire. The range of the values that can be specified is between 1 and 200. If nothing is specified, 10 is assumed to be specified. |
| ー | start | The start index of the data to acquire. Specify a numerical value of 0 or larger. If nothing is specified, 0 is assumed to be specified. |
| ー | field | Specify items to output. If nothing is specified, Phase.P_Id is assumed to be specified. For details, see Read API - Parameter > Read - Field. For information on the Field that can be specified, see Phase - Field List. |
| ー | condition | Specify the search conditions. For details, see Read API - Parameter > Read - Condition. For information on the Fields that can be specified, see Phase - Field List. |
| ー | order | Specify the sorting order of the data when output. If nothing is specified, Phase.P_Id:asc is assumed to be specified. For details, see Read API - Parameter > Read - Order. For information on the Fields that can be specified, see Phase - 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 |
|---|---|
| Phase | Route element including the Phase that meets the conditions. The number of acquired data is set for Count, and the index of the acquired data is set for Start. Start is the index beginning with 0. Lists every Phase as the Item elements. |
| Total | Attribute of the Phase. Indicates the total number of records that can be acquired under the specified search conditions. |
| Count | Attribute of the Phase. Indicates the number of records of the data acquired this time. |
| Start | Attribute of the Phase. Indicates the start index of the data acquired this time. |
| Code | This is the code that represents the processing result. For details, see Result Code List. |
| Item | Indicates one piece of Phase information. Includes a Field element. |
| Field | Stores the value of the specified item. For the names of the elements, see Phase - Field List. |
Phase Read 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 acquires the history of the phase whose Resume ID = 10001.
|
Input Parameter https://{Request URI Host}/v1/phase?partition=999999&resource=17&resourceId=10001&field=Id,Resource,ResourceId,Phase,Date,Recent |
|
Output XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> |