scroll

Partition - Read

Partition Read Method

The Partition API provides access to Partition.

Partition Read allows the user to acquire the list of Partitions for the specified conditions.

GET

https://{Request URI Host}/v1/partition?request_type=[value]&count=[value]&start=[value]

 

Scope

The access privilege required for Partition Read is as follows:

partition_r

 

Input Variables

When using the GET or POST Method, a value must be specified for the parameter of the HTTP Header. For details, see HTTP Header.

The following shows the Parameters that can be specified:

Required Parameter Description
request_type Specify the type of Partition to acquire.
The type that can be specified differs depending on the type of app registration. The following values can be specified.
   0: The information on a Partition that is currently logged in on the same browser can be acquired.
   1: The list of Partitions that can be accessed using the current Access Token can be acquired.
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 be acquired.
Specify a numerical value of 0 or larger. If nothing is specified, 0 is assumed to be specified.

 

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 handled by the Partition API.

Tag Description
Partition Route element including Partition 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.
 Total Attribute of the Partition. Indicates the total number of records that can be acquired under the specified search conditions.
 Count Attribute of the Partition. Indicates the number of records of the data acquired this time.
 Start Attribute of the Partition. 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 Partition.
 Partition.P_Id The Id of the Partition.
 Partition.P_Name The name of the HRBC contract company.
 Partition.P_CompanyId The company ID used for logging in to the HRBC business screen.

 

Partition 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 shows an sample when the Partition that can be accessed using the current Access Token is acquired.

Input Parameter

https://{Request URI Host}/v1/partition?request_type=0&count=1&start=0

 

Output XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Partition Total="1" Count="1" Start="0">
 <Code>0</Code>
 <Item>
  <Partition.P_Id>999999</Partition.P_Id>
  <Partition.P_Name>Company Name</Partition.P_Name>
  <Partition.P_CompanyId>My Company Id</Partition.P_CompanyId>
 </Item>
</Partition>

 

Was this article helpful?
0 out of 0 found this helpful