Client Read Method
The Client API provides access to the Client Resource.
Client Read allows the user to acquire the data of the Client that meets the specified conditions.
|
GET |
https://{Request URI Host}/v1/client?partition=[value]&count=[value]&start=[value]&field=[value,...]&condition=[field=value,...]&itemstate=[value]&keywords=[value,...]&order=[value,...] |
|---|
Scope
The access privilege required for Client Read is as follows:
client_r, user_r, option_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:
Each Parameter is an AND condition for search.
| Required | Parameter | Definition |
|---|---|---|
| ● | partition | Specify a numerical value for the Partition Id. To check the Partition Id that can be accessed, acquire it using Partition Read. |
| ー | 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. |
| ー | field | Specify items to output. If nothing is specified, Client.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 Client - 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 Client - Field List. Note that when “deleted” or “all” is specified for the itemstate, the following three types of Fields and conditions can be specified for “condition.” More than one of these three conditions can be specified.
|
| ー | itemstate |
Specify the status of data to acquire. When “deleted” or “all” is specified, the conditions that can be specified for “condition” are limited. |
| ー | keywords | Specify the keywords for the conditions for the data to acquire. For details, see Read API - Parameter > Read - Keywords. |
| ー | order | Specify the sorting order of the data when output. If nothing is specified, Client.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 Client - 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 |
|---|---|
| Client | Route element including the Client 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 Client as the Item elements. |
| Total | Attribute of the Client. Indicates the total number of records that can be acquired under the specified search conditions. |
| Count | Attribute of the Client. Indicates the number of records of the data acquired this time. |
| Start | Attribute of the Client. Indicates the start index of the data acquired this time. |
| Code | The code that represents the processing result. For details, see Result Code List. |
| Item | Indicates one piece of Client information. Includes a Field element. |
| Field | Stores the value of the specified item. For the names of the elements, see Client - Field List. |
Client 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 sample below uses Client Read to acquire the company ID and company name under the condition that the company ID = 100.
|
Input Parameter https://{Request URI Host}/v1/client?partition=999999&field=Client.P_Id,Client.P_Name&condition=Client.P_Id:eq=100 |
|
Output XML <?xml version=”1.0” encoding=”UTF-8” standalone=”yes”?> |