PORTERS Connect API

https://hrbcapi.porters.jp/hc/ja
Admin
This documentation provides an overview and examples of the PORTERS Connect API, intended for those...
Tokens:115,541
Snippets:1,189
Trust Score:8.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Candidate Read Sample Request

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012006487-Candidate-Read

Example of a GET request to the Candidate Read API, specifying partition, fields to retrieve, and order.

```http
https://_{Request Host}_ /v1/candidate?partition=_999999_ &field=_Person.P_Id,Person.P_Name_ &order=_Person.P_Id:desc_
```

--------------------------------

### Request Example: Get All JOB Field Information

Source: https://hrbcapi.porters.jp/hc/ja/articles/215425667-PORTERS-Connect-API-%E9%96%8B%E7%99%BA%E6%A6%82%E8%A6%81

This example demonstrates how to retrieve all field information for JOB resources. It specifies the resource as JOB (3) and requests all fields, active or inactive (-1).

```HTTP
GET https://api-hrbc-jp.porterscloud.com/api/v1/resource/3/field?partition=1&active=-1
```

--------------------------------

### Client Read Sample Output

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012160348-Client-Read

Example XML output for a successful Client Read API request. The output includes total count, start index, and item details like Client ID and Name.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Client Total="1" Count="1" Start="0">
<Code>0</Code>
<Item>
_** <Client.P_Id>100</Client.P_Id>**_
_** <Client.P_Name>○×商事</Client.P_Name>**_
</Item>
</Client>
```

--------------------------------

### System[Reference] & User Type XML Example

Source: https://hrbcapi.porters.jp/hc/ja/articles/115008172008

Example for System[Reference] or User Type fields, showing the owner 'Suzuki Ichiro' with User ID and Name.

```xml
<Job>
<Item>
**< Job.P_Owner>**
**< User>**
**< User.P_Id>1</User.P_Id>**
**< User.P_Name>鈴木 一郎</User.P_Name>**
**< /User>**
**< /Job.P_Owner>**
</Item>
</Job>
```

--------------------------------

### Recruiter Read Sample Request

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012160428-Recruiter-Read

Sample GET request to the Recruiter Read API. This example retrieves recruiter ID, name, and updated by user information for keywords matching 'テスト'.

```http
https://_**{Request Host}**_ /v1/recruiter?partition=**_999999_** &field=_**Recruiter.P_Id,Recruiter.P_Name,Recruiter.P_UpdatedBy(User.P_Id,User.P_Name)**_ &keywords=**_テスト_**
```

--------------------------------

### OAuth Response Example (code)

Source: https://hrbcapi.porters.jp/hc/ja/articles/115008017487

This is an example of the redirect URL with the 'code' parameter appended after successful authentication.

```http
http://myapplication.com?response_type=code&code=_**aaa**_
```

--------------------------------

### Activity Read Sample Output

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012160528-Activity-Read

This is an example of the XML output returned by the Activity Read API when fetching specific activity details. It includes total count, start index, and individual item details.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Activity Total="12" Count="2" Start="10">
<Code>0</Code>
<Item>
_** <Activity.P_Id>1</Activity.P_Id>**_
_** <Activity.P_Resource>3</Activity.P_Resource>**_
_** <Activity.P_ResourceId>**_
_** <Job>**_
_** <Job.P_Id>10001</Job.P_Id>**_
_** </Job>**_
_** </Activity.P_ResourceId>**_
_** <Activity.P_Title>サンプルアクティビティ1</Activity.P_Id>**_
_** <Activity.P_EventParticipants>**_
_** <User>**_
_** <User.P_Id>1</User.P_Id>**_
_** <User.P_Name>コンサルタント1</User.P_Name>**_
_** </User>**_
_** </Activity.P_EventParticipants>**_
</Item>
<Item>
_** <Activity.P_Id>2</Activity.P_Id>**_
_** <Activity.P_Resource>3</Activity.P_Resource>**_
_** <Activity.P_ResourceId>**_
_** <Job>**_
_** <Job.P_Id>10002</Job.P_Id>**_
_** </Job>**_
_** </Activity.P_ResourceId>**_
_** <Activity.P_Title>サンプルアクティビティ2</Activity.P_Id>**_
_** <Activity.P_EventParticipants>**_
_** <User>**_
_** <User.P_Id>2</User.P_Id>**_
_** <User.P_Name>コンサルタント2</User.P_Name>**_
_** </User>**_
_** <User>**_
_** <User.P_Id>3</User.P_Id>**_
_** <User.P_Name>コンサルタント3</User.P_Name>**_
_** </User> </Activity.P_EventParticipants>**_
</Item>
...
</Activity>
```

--------------------------------

### Process Read Sample Request

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012160488-Process-Read

Sample GET request for the Process Read API. This example retrieves process ID, job details, resume ID, and candidate name for processes matching a specific condition.

```http
https://_**{Request Host}**_ /v1/process?partition=_**999999**_ &field=_**Process.P_Id,Process.P_Job(Job.P_Id,Job.P_Position),Process.P_Resume,Process.P_Candidate(Person.P_Name)**_ &condition=_**Process.P_Phase=Option.P_ProcessSoundOut**_
```

--------------------------------

### OAuth Response Example (code_direct)

Source: https://hrbcapi.porters.jp/hc/ja/articles/115008017487

This is an example of the XML response body when using response_type=code_direct for authentication.

```xml
<Authentication>
<Code>_**aaa**_ </Code>
<Error>0</Error>
<Message>Success</Message>
</Authentication>
```

--------------------------------

### Candidate Read Sample Response

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012006487-Candidate-Read

Example XML output from the Candidate Read API, showing total candidates, count, start index, and individual item details.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Candidate Total="12" Count="2" Start="10">
<Code>0</Code>
<Item>
_** <Person.P_Id>1235</Person.P_Id>**_
_** <Person.P_Name>山田 太郎＜/Person.P_Name>**_
</Item>
<Item>
_** <Person.P_Id>1234</Person.P_Id>**_
_** <Person.P_Name>田中 花子＜/Person.P_Name>**_
</Item>
...
</Candidate>
```

--------------------------------

### OAuth Response Example (remove)

Source: https://hrbcapi.porters.jp/hc/ja/articles/115008017487

This is an example of the URL parameter returned after a successful access権 removal.

```http
http://myapplication.com?response_type=remove&_remove_confirmation=0_
```

--------------------------------

### Request Example: Get Updated JOB Information

Source: https://hrbcapi.porters.jp/hc/ja/articles/215425667-PORTERS-Connect-API-%E9%96%8B%E7%99%BA%E6%A6%82%E8%A6%81

This example shows how to retrieve JOB data updated within a specific date range. It uses 'ge' (greater than or equal to) and 'lt' (less than) operators for date comparison. Note that time is specified in UTC.

```HTTP
GET https://api-hrbc-jp.porterscloud.com/api/v1/resource/3/job?partition=1&condition=Job.P_UpdateDate%20ge%202015/03/24%2015:00%20AND%20Job.P_UpdateDate%20lt%202015/03/31%2015:00
```

--------------------------------

### Image Type XML Output Example

Source: https://hrbcapi.porters.jp/hc/ja/articles/115008172008

Example output XML for a Resume's image field, retrieving FileName and ContentType.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Resume Total="12" Count="2" Start="0">
<Code>0</Code>
<Item>
<Resume.U_XXX>
<FileName>_Image1.jpg_ </FileName>
<ContentType>_image/jpeg_ </ContentType>
</Resume.U_XXX>
</Item>
<Item>
<Resume.U_XXX>
<FileName>_Image3.jpg_ </FileName>
<ContentType>_image/jpeg_ </ContentType>
</Resume.U_XXX>
</Item>
</Resume>
```

--------------------------------

### Resume Read Sample Output XML

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012006527-Resume-Read

This is an example of the XML output returned by the Resume Read API when specific search criteria are met. It includes total count, current count, start index, and individual item details like Resume ID, Name, and Expected Area.

```XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Resume Total="14" Count="10" Start="0">
<Code>0</Code>
<Item>
**_ <Resume.P_Id>1234</Resume.P_Id>_**
**_ <Resume.P_Name>山田 花子(1234)＜/Resume.P_Name>
_**_** <Resume.P_ExpectArea>**_
_** <Option.P_Kanagawa>**_
_** <Option.P_Name>神奈川県</Option.P_Name>**_
_** <Option.P_Id>88</Option.P_Id>**_
_** </Option.P_Kanagawa>**_
_** <Option.P_Tokyo>**_
_** <Option.P_Name>東京都</Option.P_Name>**_
_** <Option.P_Id>87</Option.P_Id>**_
_** </Option.P_Tokyo>**_
_** <Option.P_Saitama>**_
_** <Option.P_Name>埼玉県</Option.P_Name>**_
_** <Option.P_Id>85</Option.P_Id>**_
_** </Option.P_Saitama>**_
_** <Option.P_Chiba>**_
_** <Option.P_Name>千葉県</Option.P_Name>**_
_** <Option.P_Id>86</Option.P_Id>**_
_** </Option.P_Chiba>**_
_** </Resume.P_ExpectArea>**_
</Item>
<Item>
**_ <Resume.P_Id>1235</Resume.P_Id>_**
**_ <Resume.P_Name>鈴木 一郎(1235)＜/Resume.P_Name>_**
**_ <Resume.P_ExpectArea>
<Option.P_Area>
<Option.P_Kanagawa>
<Option.P_Name>神奈川県</Option.P_Name>
<Option.P_Id>88</Option.P_Id>
</Option.P_Kanagawa>
</Option.P_Area>
</Resume.P_ExpectArea>_**
</Item>
...
</Resume>
```

--------------------------------

### User Read Sample Output XML

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012160288

This is an example of the XML output received when retrieving all user information. It includes total count, items, and individual user details.

```XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<User Total="2" Count="2" Start="0">  
<Code>0</Code>  
<Item>  
<User.P_Type>_**0**_ </User.P_Type>  
<User.P_Id>_**1**_ </User.P_Id>  
<User.P_Name>_**ユーザー1**_ </User.P_Name>  
<User.P_Mail>_**user1@xxx.co.jp**_ </User.P_Mail>  
</Item>  
<Item>  
<User.P_Type>_**1**_ </User.P_Type>  
<User.P_Id>_**2**_ </User.P_Id>  
<User.P_Name>_**ユーザー2**_ </User.P_Name>  
<User.P_Mail>_**user2@xxx.co.jp**_ </User.P_Mail>  
</Item>  
</User>
```

--------------------------------

### Sample Phase Write Response

Source: https://hrbcapi.porters.jp/hc/ja/articles/360039307694-2019-12-10-Phase-Read-Phase-Write-API%E3%81%AE%E6%A9%9F%E8%83%BD%E6%8B%A1%E5%BC%B5

Example XML response from the Phase Write API, confirming the registration of an item with a new ID.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Phase>
<Item>
<Id>10018</Id>
<Code>0</Code>
</Item>
</Phase>
```

--------------------------------

### Field Read Sample Request

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012160308

A sample GET request to retrieve two fields from the 'Job' resource, with all fields included.

```http
https://_**{Request Host}**_ /v1/field?partition=**_999999_** &resource=**_3_** &active=**_-1_** &count=**_2_**
```

--------------------------------

### Sample Phase Read Response

Source: https://hrbcapi.porters.jp/hc/ja/articles/360039307694-2019-12-10-Phase-Read-Phase-Write-API%E3%81%AE%E6%A9%9F%E8%83%BD%E6%8B%A1%E5%BC%B5

Example XML response from the Phase Read API, showcasing retrieved item details including Owner and OwnerDepartment.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Phase Total="3" Count="3" Start="0">
<Code>0</Code>
<Item>
<Id>10014</Id>
<Memo>Add Memo</Memo>
<OwnerDepartment>
<Department>
<Department.P_Id>1001</Department.P_Id>
<Department.P_Name>所属なし</Department.P_Name>
</Department>
</OwnerDepartment>
<Owner>
<User>
<User.P_Id>78</User.P_Id>
</User>
</Owner>
<UpdateDate>2019/11/26 21:08:23</UpdateDate>
<RegistrationDate>2019/11/26 20:46:57</RegistrationDate>
<UpdatedBy>
<User>
<User.P_Id>82</User.P_Id>
</User>
</UpdatedBy>
<RegisteredBy>
<User>
<User.P_Id>82</User.P_Id>
</User>
</RegisteredBy>
</Item>
<Item>
<Id>10015</Id>
<Memo>Add Memo</Memo>
<OwnerDepartment>
<Department>
<Department.P_Id>1001</Department.P_Id>
<Department.P_Name>所属なし</Department.P_Name>
</Department>
</OwnerDepartment>
<Owner>
<User>
<User.P_Id>78</User.P_Id>
</User>
</Owner>
<UpdateDate>2019/11/26 21:12:11</UpdateDate>
<RegistrationDate>2019/11/26 21:11:03</RegistrationDate>
<UpdatedBy>
<User>
<User.P_Id>82</User.P_Id>
</User>
</UpdatedBy>
<RegisteredBy>
<User>
<User.P_Id>82</User.P_Id>
</User>
</RegisteredBy>
</Item>
<Item>
<Id>10016</Id>
<Memo>Add Memo</Memo>
<OwnerDepartment>
<Department>
<Department.P_Id>1003</Department.P_Id>
<Department.P_Name>部署１</Department.P_Name>
</Department>
</OwnerDepartment>
<Owner>
<User>
<User.P_Id>1</User.P_Id>
</User>
</Owner>
<UpdateDate>2019/11/26 21:23:04</UpdateDate>
<RegistrationDate>2019/11/26 21:12:26</RegistrationDate>
<UpdatedBy>
<User>
<User.P_Id>1</User.P_Id>
</User>
</UpdatedBy>
<RegisteredBy>
<User>
<User.P_Id>82</User.P_Id>
</User>
</RegisteredBy>
</Item>
</Phase>
```

--------------------------------

### Process Write Sample Input XML

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012160468-Process-Write

This XML sample demonstrates how to structure the input data for registering a new process, including details like owner, client, job, candidate, resume, phase, and phase date.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Process>
<Item>
<Process.P_Id>_-1_ </Process.P_Id>
<Process.P_Owner>_1_ </Process.P_Owner>
<Process.P_Client>_10001_ </Process.P_Client>
<Process.P_Recruiter>_10002_ </Process.P_Recruiter>
<Process.P_Job>_10005_ </Process.P_Job>
<Process.P_Candidate>_10009_ </Process.P_Candidate>
<Process.P_Resume>_10010_ </Process.P_Resume>
<Process.P_Phase>_ < Option.P_ProcessMatching/>_</Process.P_Phase>
<Process.P_PhaseDate>_2012/01/01 00:00:00_ </Process.P_PhaseDate>
</Item>
</Process>
```

--------------------------------

### Activity Write Sample Input XML

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012006567-Activity-Write

This XML sample demonstrates how to structure the input for creating a new activity, including details like owner, resource, title, dates, and participants. Ensure proper encoding for actual requests.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Activity>
<Item>
<Activity.P_Id>_-1_ </Activity.P_Id>
<Activity.P_Owner>_1_ </Activity.P_Owner>
<Activity.P_Resource>_3_ </Activity.P_Resource>
<Activity.P_ResourceId>_10005_ </Activity.P_ResourceId>
<Activity.P_Title>_MTG_ </Activity.P_Title>
<Activity.P_FromDate>_2015/11/15 04:00:00_ </Activity.P_FromDate>
<Activity.P_ToDate>_2015/11/15 05:00:00_ </Activity.P_ToDate>
<Activity.P_EventResources>
 _**< Option.P_DefaultResource1/>**_
</Activity.P_EventResources>
<Activity.P_EventParticipants>
<User.P_Id>_1_ </User.P_Id>
<User.P_Id>_2_ </User.P_Id>
<User.P_Id>_3_ </User.P_Id>
</Activity.P_EventParticipants>
</Item>
</Activity>
```

--------------------------------

### Process Write Sample Output XML

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012160468-Process-Write

This XML sample shows the expected output after successfully registering a new process, including the assigned Process ID and a success code.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Process>
<Item>
<Id>_20002_ </Id>
<Code>_0_ </Code>
</Item>
</Process>
```

--------------------------------

### Contact Read Sample Output

Source: https://hrbcapi.porters.jp/hc/ja/articles/20867963087129

Example XML output for a Contact Read API request. It shows the total count, start index, and details for each contact item, including nested user information.

```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>テストリクルーター１</Contact.P_Position>**_
_** <Contact.P_UpdatedBy>**_
_** <User>**_
_** <User.P_Id>1</User.P_Id>**_
_** <User.P_Name>テストエージェント1</User.P_Name>**_
_** </User>**_
_** </Contact.P_UpdatedBy>**_
</Item>
<Item>
_** <Contact.P_Id>1235</Contact.P_Id>**_
_** <Contact.P_Position>テストリクルーター2</Contact.P_Position>**_
_** <Contact.P_UpdatedBy>**_
_** <User>**_
_** <User.P_Id>2</User.P_Id>**_
_** <User.P_Name>テストエージェント2</User.P_Name>**_
_** </User>**_
_** </Contact.P_UpdatedBy>**_
</Item>
...
</Contact>
```

--------------------------------

### Phase Write Sample Input XML

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012161268-Phase-Write

This XML sample demonstrates how to structure the input data for registering a new phase, including resource ID, phase type, and date. Ensure proper encoding for actual requests.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Phase>
<Item>
<Id>_-1_ </Id>
<Resource>_17_ </Resource>
<ResourceId>_10234_ </ResourceId>
<Phase>
 _< Option.P_ResumeOpen/>_ 
</Phase>
<Date>_2013/11/02 10:00:00_ </Date>
</Item>
</Phase>
```

--------------------------------

### Activity Read API Endpoint

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012160528-Activity-Read

This is the GET endpoint for the Activity Read API. It allows fetching activity data by specifying parameters like partition, count, start, field, condition, itemstate, keywords, and order.

```http
GET |  https://_**{Request Host}**_ /v1/activity?partition=**_[value]_** &count=**_[value]_** &start=**_[value]_** &field=**_[value,...]_** &condition=**_[field=value,...]_** &itemstate=_**[value]**_ &keywords=**_[value,...]_** &order=**_[value,...]_**
```

--------------------------------

### Resume Write Sample Input XML

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012006507-Resume-Write

This XML sample demonstrates how to register or update resume information, specifically setting desired work locations and current salary for a candidate. Ensure proper encoding for actual requests.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Resume>
<Item>
 _**< Resume.P_Id>-1</Resume.P_Id>**_
_** <Resume.P_Owner>1</Resume.P_Owner>**_
_** <Resume.P_Candidate>10001</Resume.P_Candidate>
<Resume.P_ExpectArea><Option.P_Tokyo/><Option.P_Kanagawa/></Resume.P_ExpectArea>
<Resume.P_CurrentSalary>3000000</Resume.P_CurrentSalary>**_
</Item>
</Resume>
```

--------------------------------

### Sales Write Input XML Sample

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012007127-Sales-Write

This XML sample demonstrates how to structure the data for creating a new sales record, including client, recruiter, job, candidate, and resume information. Ensure all dependent resources are correctly specified.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Sales>
<Item>
<Sales.P_Id>_-1_ </Sales.P_Id>
<Sales.P_Owner>_1_ </Sales.P_Owner>
<Sales.P_Client>_10001_ </Sales.P_Client>
<Sales.P_Recruiter>_10002_ </Sales.P_Recruiter>
<Sales.P_Job>_10005_ </Sales.P_Job>
<Sales.P_Candidate>_20009_ </Sales.P_Candidate>
<Sales.P_Resume>_20010_ </Sales.P_Resume>
<Sales.P_SalesAmount>_3000000_ </Sales.P_SalesAmount>
<Sales.P_RecordDate>_2012/01/01_ </Sales.P_RecordDate>
</Item>
</Sales>
```

--------------------------------

### Job Read API Endpoint

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012006447-Job-Read

This is the GET endpoint for the Job Read API. It allows fetching job data by specifying parameters like partition, count, start, field, condition, itemstate, keywords, and order. Ensure proper encoding for actual requests.

```http
GET |  https://_**{Request Host}**_ /v1/job?partition=**_[value]_** &count=**_[value]_** &start=**_[value]_** &field=**_[value,...]_** &condition=**_[field=value,...]_** &itemstate=_**[value]**_ &keywords=**_[value,...]_** &order=**_[value,...]_**
```

--------------------------------

### Job Read Sample Output

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012006447-Job-Read

Example XML output for a Job Read API request, showing job details including ID, position, and the associated user information (ID and name). The output includes total count, items retrieved, and start index.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Job Total="2" Count="2" Start="0">
<Code>0</Code>
<Item>
_** <Job.P_Id>1234</Job.P_Id>**_
_** <Job.P_Position>テストポジション１</Job.P_Position>**_
_** <Job.P_UpdatedBy>**_
_** <User>**_
_** <User.P_Id>1</User.P_Id>**_
_** <User.P_Name>テストエージェント1</User.P_Name>**_
_** </User>**_
_** </Job.P_UpdatedBy>**_
</Item>
<Item>
_** <Job.P_Id>1235</Job.P_Id>**_
_** <Job.P_Position>テストポジション2</Job.P_Position>**_
_** <Job.P_UpdatedBy>**_
_** <User>**_
_** <User.P_Id>2</User.P_Id>**_
_** <User.P_Name>テストエージェント2</User.P_Name>**_
_** </User>**_
_** </Job.P_UpdatedBy>**_
</Item>
</Job>
```

--------------------------------

### Opportunity Write Input XML Sample

Source: https://hrbcapi.porters.jp/hc/ja/articles/21029543509529-Opportunity-Write

Sample XML for the Opportunity Write API. This example demonstrates creating a new opportunity and updating an existing one. Note that encoding may be required for actual requests.

```xml
<?xml version="1.0"encoding="UTF-8"standalone="yes"?>
<Opportunity>
<Item>
<Opportunity.P_Id>_-1_ </Opportunity.P_Id>
<Opportunity.P_Owner>_1_ </Opportunity.P_Owner>
<Opportunity.P_Client>_10002_ </Opportunity.P_Client>
<Opportunity.P_Recruiter>_10010_ </Opportunity.P_Recruiter>
<Opportunity.P_Position>_〇〇商談_ </Opportunity.P_Position>
</Item>
<Item>
<Opportunity.P_Id>_20001_ </Opportunity.P_Id>
<Opportunity.P_Position>_△△商談_ </Opportunity.P_Position>
</Item>
</Opportunity>
```

--------------------------------

### Contact Write Input XML Sample

Source: https://hrbcapi.porters.jp/hc/ja/articles/20868297660953

This XML sample demonstrates how to structure data for creating a new contact and updating an existing one. It includes fields for contact details and associates them with a client ID.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Contact>
<Item>
<Contact.P_Id>-1</Contact.P_Id>
<Contact.P_Name>採用担当者B</Contact.P_Name>
<Contact.P_Reading>サイヨウタントウシャB</Contact.P_Reading>
<Contact.P_Client>10001</Contact.P_Client>
<Contact.P_Owner>1</Contact.P_Owner>
</Item>
<Item>
<Contact.P_Id>20001</Contact.P_Id>
<Contact.P_Name>採用担当者A</Contact.P_Name>
<Contact.P_Reading>サイヨウタントウシャA</Contact.P_Reading>
</Item>
</Contact>
```

--------------------------------

### Client Write Input XML Sample

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012006367-Client-Write

This XML sample demonstrates how to register a new client ('AAA株式会社') and update an existing client (ID: 10022) with a new phone number. Ensure proper encoding for actual requests.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Client>
<Item>
 <Client.P_Id>-1</Client.P_Id>
 <Client.P_Owner>1</Client.P_Owner>
 <Client.P_Name>AAA株式会社</Client.P_Name>
</Item>
<Item>
 <Client.P_Id>10022</Client.P_Id>
 <Client.P_Telephone>0123456789</Client.P_Telephone>
</Item>
</Client>
```

--------------------------------

### Recruiter Write API Input XML Sample

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012006407-Recruiter-Write

This XML sample demonstrates how to structure the data for the Recruiter Write API. It shows how to register a new recruiter and update an existing one by providing their details.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Recruiter>
<Item>
<Recruiter.P_Id>-1</Recruiter.P_Id>
<Recruiter.P_Name>採用担当者B</Recruiter.P_Name>
<Recruiter.P_Reading>サイヨウタントウシャB</Recruiter.P_Reading>
<Recruiter.P_Client>10001</Recruiter.P_Client>
<Recruiter.P_Owner>1</Recruiter.P_Owner>
</Item>
<Item>
<Recruiter.P_Id>20001</Recruiter.P_Id>
<Recruiter.P_Name>採用担当者A</Recruiter.P_Name>
<Recruiter.P_Reading>サイヨウタントウシャA</Recruiter.P_Reading>
</Item>
</Recruiter>
```

--------------------------------

### Link Type Example - Specifying Contact ID

Source: https://hrbcapi.porters.jp/hc/ja/articles/115008171988-Write-API-XML-Format

Example of specifying Contact ID '10001' for the JOB's contact person field.

```xml
<Job>
<Item>
 _**< Job.U_XXX>10001</Job.U_XXX>**_
</Item>
</Job>
```

--------------------------------

### User Read Sample - All Users

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012160288

This sample demonstrates how to retrieve all user information using the User Read API. Note that encoding might be necessary for actual requests depending on the content.

```HTTP
https://_**{Request Host}**_ /v1/user?partition=**_999999_** &request_type=**_1_** &user_type=**_-1_**
```

--------------------------------

### System/User Type Example - Specifying Owner ID

Source: https://hrbcapi.porters.jp/hc/ja/articles/115008171988-Write-API-XML-Format

Example of specifying User ID '1' (Suzuki Ichiro) for the JOB's owner field.

```xml
<Job>
<Item>
 _**< Job.Owner>1</Job.Owner>**_
</Item>
</Job>
```

--------------------------------

### Candidate Write Input XML Sample

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012006467-Candidate-Write

This XML sample demonstrates how to structure the data for creating a new candidate record, including personal details like name and reading. Ensure proper encoding for actual requests.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Candidate>
<Item>
 _**< Person.P_Id>-1</Person.P_Id>**_
_** <Person.P_Owner>1</Person.P_Owner>**_
_** <Person.P_Name>鈴木 一郎</Person.P_Name>
<Person.P_Reading>すずき いちろう</Person.P_Reading>**_
</Item>
</Candidate>
```

--------------------------------

### Option Type XML Example

Source: https://hrbcapi.porters.jp/hc/ja/articles/115008172008

Example of Option Type data where multiple choices are selected. It shows how 'Tokyo' and 'Kanagawa' are represented for a JOB's area.

```xml
<Job>
<Item>
**< Job.P_Area>**
** <Option.P_Tokyo>
** **< Option.P_Name>東京都</Option.P_Name>**
** <Option.P_Id>87</Option.P_Id>**
** </Option.P_Tokyo>**
** <Option.P_Kanagawa>
** **< Option.P_Name>神奈川県</Option.P_Name>**
** <Option.P_Id>88</Option.P_Id>**
** </Option.P_Kanagawa>**
** </Job.P_Area>**
</Item>
</Job>
```

--------------------------------

### Option Type XML Example

Source: https://hrbcapi.porters.jp/hc/ja/articles/115008172008-Read-API-XML-Format

Example of how multiple selections in an Option Type field are represented in XML. Each selected option appears as a distinct 'Option' tag.

```xml
<Job>
<Item>
<Job.P_Area>
<Option.P_Tokyo>
<Option.P_Name>東京都</Option.P_Name>
<Option.P_Id>87</Option.P_Id>
</Option.P_Tokyo>
<Option.P_Kanagawa>
<Option.P_Name>神奈川県</Option.P_Name>
<Option.P_Id>88</Option.P_Id>
</Option.P_Kanagawa>
</Job.P_Area>
</Item>
</Job>
```

--------------------------------

### Option Type Example - Specifying Tokyo and Kanagawa

Source: https://hrbcapi.porters.jp/hc/ja/articles/115008171988-Write-API-XML-Format

Example of specifying 'Tokyo' and 'Kanagawa' for a JOB's area field using the Option Type format.

```xml
<Job>
<Item>
 _**< Job.P_Area>**_
_** <Option.P_Tokyo/>**_
_** <Option.P_Kanagawa/>**_
 _**< /Job.P_Area>**_
</Item>
</Job>
```

--------------------------------

### Request Example: Update Candidate Phone Number

Source: https://hrbcapi.porters.jp/hc/ja/articles/215425667-PORTERS-Connect-API-%E9%96%8B%E7%99%BA%E6%A6%82%E8%A6%81

This example demonstrates how to update the phone number for a specific candidate record. Multiple records can be updated in a single request (up to 200).

```HTTP
PUT https://api-hrbc-jp.porterscloud.com/api/v1/resource/1/candidate?partition=1
<Candidate>
  <Item>
    <Person.P_Id>10001</Person.P_Id>
    <Person.P_Telephone>0123-45-6789</Person.P_Telephone>
  </Item>
</Candidate>
```

--------------------------------

### System[Reference] Type XML Example

Source: https://hrbcapi.porters.jp/hc/ja/articles/115008172008-Read-API-XML-Format

Demonstrates how referenced resources are embedded within the XML for System[Reference] or User Type fields. The referenced resource's data is nested.

```xml
<Job>
<Item>
<Job.P_Owner>
<User>
<User.P_Id>1</User.P_Id>
<User.P_Name>鈴木 一郎</User.P_Name>
</User>
</Job.P_Owner>
</Item>
</Job>
```

--------------------------------

### Example Revoke Company DB Access Rights URL

Source: https://hrbcapi.porters.jp/hc/ja/articles/214942247-PORTERS-Connect-API%E5%88%A9%E7%94%A8%E7%B5%82%E4%BA%86%E7%94%B3%E8%AB%8B

An example of the URL used to revoke Company DB access rights, demonstrating the inclusion of a specific App ID and Redirect URL.

```URL
https://api-hrbc-jp.porterscloud.com/v1/oauth?response_type=remove&app_id=xxxxxx&scope=partition_r,user_r,field_r,option_r,client_r,client_w,recruiter_r,recruiter_w,contact_r,contact_w,job_r,job_w,candidate_r,candidate_w,resume_r,resume_w,process_r,process_w,activity_r,activity_w,contract_r,contract_w,sales_r,sales_w,phase_r,phase_w,attachment_r,attachment_w,opportunity_r,opportunity_w&redirect_url=http://zzzzzz.com
```

--------------------------------

### Example 1-1: Keyword Search with Hyphenated Phone Number (v3.12)

Source: https://hrbcapi.porters.jp/hc/ja/articles/360000456268-2015-12-21-Read%E7%B3%BBAPI%E3%81%AE%E5%8B%95%E4%BD%9C%E3%81%AB%E9%96%A2%E3%81%99%E3%82%8B%E5%A4%89%E6%9B%B4

In version 3.12, a keyword search for a phone number including hyphens will not yield results if the stored data format differs. This example shows the expected response when the keyword contains hyphens.

```xml
<Candidate Total="0" Count="0" Start="0">
<Code>0</Code>
</Candidate>
```

--------------------------------

### Resume Write Sample Output XML

Source: https://hrbcapi.porters.jp/hc/ja/articles/115012006507-Resume-Write

This XML sample shows the expected output after successfully registering or updating resume data using the Resume Write API. It includes the new or updated resume ID and a success code.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Resume>
<Item>
<Id>_**10001**_ <Id>
<Code>_**0**_ </Code>
</Item>
</Resume>
```
Tokens:
Raw