Field Type & Data Type List
The following shows the list of Field Types that the HRBC API can handle and their values.
The XML format differs depending on the Data Type. For details, see Read API - XML Format and Write API - XML Format.
*{Resource} is replaced with a Resource name such as Client, Job, and Resume.
Value | Field Type Name | Data Type | Description |
---|---|---|---|
1 | SinglelineText | SinglelineText | Indicates a one-line string. |
2 | MultilineText | MultilineText | Indicates a multiple-line string including newline codes. |
3 | Number | Number | Indicates a numerical value. |
4 | Date | Date | Indicates the date (year, month, date). Only the [yyyy/mm/dd] format is supported. |
5 | Option[Checbox] | Option | Select a value from the defined options (check boxes). For details on the XML format, see Read API - XML Format > Data Type : Option orWrite API - XML Format > Data Type : Option. |
6 | Option[Radiobutton] | Option | Select a value from the defined options (radio buttons). For details on the XML format, see Read API - XML Format > Data Type : Option orWrite API - XML Format > Data Type : Option. |
7 | Option[Drowdown] | Option | Select a value from the defined options (drop-down menu). For details on the XML format, see Read API - XML Format > Data Type : Option orWrite API - XML Format > Data Type : Option. |
8 | Age | Age | Indicates the birth date (age). Only the [yyyy/mm/dd] format is supported. The value is the Date type, but the age is automatically calculated from the current date when the information is displayed on the HRBC screen. |
9 | URL | URL | The character string type that indicates the URL. |
10 | The character string type that indicates the email address. | ||
11 | System | System[Id] | Indicates numerically the ID of the record. For the supported Field, see System Field List. |
System[DateTime] | Indicates the date (year, month, day, hour, minutes). The specified time is handled as UTC. Only the [yyyy/mm/dd HH:MM:SS] format is supported. No desired date and time can be specified for Write. For the supported Field, see System Field List. |
||
System[Reference] | Indicates the relevant upper-level Resource. For the supported Field, see System Field List. In the case of Read, the Field of an upper-level Resource can be referred to by following Read API - Parameter > Read - Field to specify this item. In the case of Write, only the value of the {Resource}.P_Id of an upper-level Resource can be specified. |
||
System[Department] | The Field Type that is used only for the User API. For details on the supported Field, see System Field List. |
||
12 | DateTime | DateTime | Indicates the date (year, month, day, hour, minutes). The specified time is handled as UTC. Only the [yyyy/mm/dd HH:MM:SS] format is supported. |
14 | Currency | Number | Indicates the currency. |
15 | Telephone | Telephone | The character string type that indicates the phone number. |
16 | Reference | ー | The item that refers to the data of another Resource and displays them. This item itself does not have any data. |
17 | User | User | The user type used for a value selected from the list of defined users. For details on the supported Field, see System Field List. In the case of Read, the defined User information can be referred to by following Read API - Parameter > Read - Field to specify this item. In the case of Write, only the value of the User.P_Id can be specified. |
18 | Image | Image | Indicates the image. Base64 Encode/Decode is required for the Content. For details on the XML format, see Read API - XML Format > Data Type : Image orWrite API - XML Format > Data Type : Image. |
20 | Link | Link |
Represents any of the following: |
System Field List
The Fields of System Type and User Type are shown below. For details on Alias or other items, see the Field List of each Resource.
*{Resource} is replaced with a Resource name such as Client, Job, and Resume.
Field Type | Field | Description |
---|---|---|
System[Id] | {Resource}.P_Id | The ID of the record. |
{Resource}.P_RegistrationDate | The data registration date of the record. No desired date and time can be specified for Write. |
|
{Resource}.P_UpdateDate | The data update date of the record. No desired date and time can be specified for Write. |
|
System[Reference] | {Resource}.P_Client | The item that indicates the relevant Client (company). In the case of Read, the Field of the Client Resource can be referred to. In the case of Write, only the value of the Client.P_Id can be specified. |
{Resource}.P_Recruiter | The item that indicates the relevant Recruiter (company representative). In the case of Read, the Field of the Recruiter Resource can be referred to. In the case of Write, only the value of the Recruiter.P_Id can be specified. |
|
{Resource}.P_Job | The item that indicates the relevant Job. In the case of Read, the Field of the Job Resource can be referred to. In the case of Write, only the value of the Job.P_Id can be specified. |
|
{Resource}.P_Candidate | The item that indicates the relevant Candidate. In the case of Read, the Field of the Candidate Resource can be referred to. In the case of Write, only the value of the Person.P_Id can be specified. |
|
{Resource}.P_Resume | The item that indicates the relevant Resume. In the case of Read, the Field of the Resume Resource can be referred to. In the case of Write, only the value of the Resume.P_Id can be specified. |
|
Sales.P_Contract | The item that indicates the relevant Contract. In the case of Read, the Field of the Contract Resource can be referred to. In the case of Write, only the value of the Contract.P_Id can be specified. |
|
Activity.P_ResourceId | The item that Indicates the relevant upper-level Resource. | |
System[Department] | User.P_Department | The item that indicates the department of the user. |
User | {Resource}.P_Owner | Indicates the owner of the record. This item is usually required when creating a new record. |
{Resource}.P_RegisteredBy | Indicates the registrant of the record. When this item is not specified for Write (new creation), the app user who is currently accessing the record is automatically assigned. |
|
{Resource}.P_UpdatedBy | Indicates the registrant of the record. When this item is not specified for Write, the app user who is currently accessing the record is automatically assigned. |
|
Activity.P_EventParticipants | The participant in the activity. |