The formats of XML to be output by the Read API are classified into the following types:
- Standard Format
- Data Type：Number
- Data Type：Option
- Data Type：System[Reference] & User
- Data Type：link
- Data Type：Image
For details on the Field Type and Data Type, see Field Type & Data Type List.
Standard Format
The standard format of XML to be output by the Read API is as follows:
|
<Resource Name Total=N Count=N Start=N> |
The <Item> tag indicates one data that belongs to the Resource. Zero or more <Item> tags are output according to the condition.
In the <Item> tag, one or multiple <Alias> tags are output.
Data Type：Number
When multiple options are selected, multiple Aliases are output between the Option Alias (Root) tags.
The Alias to be output is the end Alias. The parent-child relationship is not expressed here.
Data Type：Option
When multiple options are selected, multiple Aliases are output between the Option Alias (Root) tags.
The Alias to be output is the end Alias. The parent-child relationship is not expressed here.
|
<Field Alias (Option Type)> |
The following shows the output sample when “Tokyo” and “Kanagawa” are specified for the region of the JOB.
|
<Job> |
Data Type：System[Reference] & User
For the System[Reference] and User Type items, the items that belong to the Resource to be referred to will be output.
For how to set the output Field, see Parameter > Read – Field.
|
<Field Alias (System[Reference] Type)> |
The following shows the output sample when “Ichiro Suzuki” is specified for the owner of the JOB.
|
<Job> *The parts in blue are the tag of the Resource to be referred to. *The parts in green are the items that belong to the Resource to be referred to. |
Data Type：link
Link Type can output the ID of the Contact or information of the User type or User Department type.
* For Contact, unlike System[Reference] and User Type, information such as Contact.P_Name cannot be retrieved.
* Information such as Contact.P_Name can be obtained separately through the Contact API.
* For User type and User Department type fields, the items belonging to the referenced Resource will be output according to the settings of the output Field.
For the method of setting the output Field, refer to Parameter Read – Field.
Data Type：Image
The tags that can be output by Image type are only FileName, ContentType, and Content.
By default, only FileName is output. To output Content Type and Content, enclose the tags to output with ( ) after the field alias of the Image Type in the following format:
field_alias(FileName,ContentType,Content)
Delimit multiple tags, if specified, with a comma.
Note that the image type items cannot be specified for the “condition” of the Resource API. Also, the image type items in an upper-level Resource cannot be referred to nor acquired.
Output Values
The output value can be acquired in the XML format.
| Tag | Definition |
|---|---|
| Content | Bease64 encoded image file. |
| ContentType | Specifies the type of the data that are specified for Content. Usually, this type is the same as the Mime Type. The types that can be handled for the Image Type are image/jpeg (jpg, jpeg), image/gif (gif), image/png (png), and image/bmp (bmp). |
| FileName | The file name the image. |
Sample
The following shows an example when specifying the image type item Resume.U_XXX at the time of Resume Read to acquire FileName,ContentType.
|
Input Parameter https://{Request URI Host}/v1/resume?partition=999999&field=Resume.U_XXX(FileName,ContentType) |
|
Output XML <?xml version=”1.0” encoding=”UTF-8” standalone=”yes”?> |