scroll

Contact - Read

Contact Read Method

The Contact API provides access to Contact.

Contact Read allows the user to acquire the data of the Contact that meets the specified conditions.

GET

https://{Request Host}/v1/Contact?partition=[value]&count=[value]&start=[value]&field=[value,...]&condition=[field=value,...]&itemstate=[value]&keywords=[value,...]&order=[value,...]

 

Scope

The access privilege required for Contact Read is as follow:

contact_r, client_r, user_r, option_r

 

Input Variables

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

The following shows the Parameters that can be specified:

Each Parameter is an AND condition for search.

必須 Parameter Definition
partition Specify a numerical value for the Partition Id.
To check the Partition Id that can be accessed, acquire the information 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, Contact.P_Id is assumed to be specified.
For details, see Read API - Parameter > Read - Field.
For information on the Fields that can be specified, see Contact - 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 Contact - 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.

  1. Contact.P_Id
  2. Contact.P_UpdateDate
    The value that can be specified is a value between the date and time of the Request and the same time 90 days prior. No date and time earlier than this time can be specified. 
    If nothing is specified, the same time 90 days prior to the date and time of the Request is assumed to be specified.
  3. Contact.P_UpdatedBy
itemstate

Specify the status of data to acquire.
The following values can be specified. If nothing is specified, “existing” is assumed to be specified.
 existing: Acquire the undeleted data
 deleted: Acquire the deleted data
 all: Acquire the data in all states

 

※If "all" or "deleted" is specified, the search condition Contact.P_UpdateDate is within 90 days is automatically added.

(If "existing" is specified for itemstate or none is specified, the search criteria above will not be added.)

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, Contact.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 Contact - Field List.

 

Result Values

When 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
Contact Route element including the Recruiter 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 Contact as the Item elements.
 Total

The attribute of Contact. Indicates the total number of records that can be acquired under the specified search conditions.

 Count

The attribute of Contact. Indicates the number of records of the data acquired this time.

 Start

The attribute of Contact. 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 piece of Contact information. Includes a Field element.

 Field

Stores the value of the specified item.
For the names of the elements, see Contact - Field List.

 

Contact 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 sample uses Contact Read to acquire the contact ID, contact name and person who updates the data under the condition that the keyword = test.

Input Parameter

https://{Request Host}/v1/contact?partition=999999&field=Contact.P_Id,Contact.P_Position,Contact.P_UpdatedBy(User.P_Id,User.P_Name)&keywords=test

 

Output XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Contact Total="2" Count="2" Start="0">
 <Code>0</Code>
 <Item>
  <Contact.P_Id>1234</Contact.P_Id>
  <Contact.P_Position>TestRecruiter1</Contact.P_Position>
  <Contact.P_UpdatedBy>
   <User>
    <User.P_Id>1</User.P_Id>
    <User.P_Name>User1</User.P_Name>
   </User>
  </Contact.P_UpdatedBy>
 </Item>
 <Item>
  <Contact.P_Id>1235</Contact.P_Id>
  <Contact.P_Position>TestRecruiter2</Contact.P_Position>
  <Contact.P_UpdatedBy>
   <User>
    <User.P_Id>2</User.P_Id>
    <User.P_Name>User2</User.P_Name>
   </User>
  </Contact.P_UpdatedBy>
 </Item>
 ...
</Contact>

 

 

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