07/10/2018 Enhancement of User Read API

• Overview
• Enhancement of User Read API
• Sample

Overview

HRBC Connect API 3.12.31 will enhance functionality by adding [field] to the Parameter that can be specified by the User Read API for users to be able to acquire a desired field.

This function enhancement will affect the behavior only when the Parameter is explicitly specified. The existing apps are not affected.

 

Enhancement of User Read API

[Target API]

User Read

Any Resource API other than the above cannot acquire a desired field by specifying this enhanced optional User Field.

 

[Change details]

field  is added as a Parameter that can be specified by the User Read API so that a desired User Field can be specified.

GET	.../v1/user?partition=[value]&request_type=[value]&user_type=[value]&count=[value]&start=[value]&field=[value]

 

Input Variables

The notes on the Parameters that can be specified and changes in them are as follows:

Required	Parameter	Definition
●	partition	No change
●	request_type	No change
ー	user_type	No change
ー	count	No change
ー	start	No change
ー	field	Specify items to output. For information on the Fields that can be specified, see User - Field List / Timezone List. If nothing is specified, the following four items are assumed to be specified. 　1. User.P_Id 　2. User.P_Type 　3. User.P_Name 　4. User.P_Mail

 

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. No optional Field can be acquired by the User API.

Tag	Definition
User	No change
Total	No change
Count	No change
Start	No change
Code	No change
Item	Indicates one piece of User information. Includes a Field element.
Field	Stores the value of a specified item.

 

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 uses User Read to acquire the name, department, and person who updated the data.

Input Parameter .../v1/user?partition=999999&&request_type=1&field=User.P_Name,User.P_Department,User.P_UpdatedBy

 

Output XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <User Total="1" Count="1" Start="0"> 　<Code>0</Code> 　<Item> 　　<User.P_Name>Consultant 1</User.P_Name> 　　<User.P_Department> 　　　<Department> 　　　　<Department.P_Id>1001</Department.P_Id> 　　　　<Department.P_Name>No department </Department.P_Name> 　　　</Department> 　　</User.P_Department> 　　<User.P_UpdatedBy> 　　　<User> 　　　　<User.P_Id>1</User.P_Id> 　　　　<User.P_Name>Consultant 1</User.P_Name> 　　　</User> 　　</User.P_UpdatedBy> 　</Item> </Client>