スクロール

2015/07/01 Read系APIのfieldパラメータがセットされなかった場合の挙動(緩和措置あり)

概要

PORTERS HR-Business Cloud API v3.11にてAPIの挙動を一部変更しました。

変更内容:Read系APIのfieldパラメータがセットされなかった際の挙動

     変更前:全ての項目が出力される

     変更後:{Resource}.P_Idのみ出力される

既に開発済みのアプリケーション等への影響を配慮し、App IDの発行日が2015年6月30日以前のアプリケーションに対して緩和措置を実施しております。

緩和措置対象企業様は事前にv3.11以降の挙動で問題ないかご確認いただき、必要に応じてサイトの仕様変更等を行って頂くようお願いします。

緩和措置の終了時期は確定次第(終了日の30日前頃)お知らせ致します。

(「HRBC」は「PORTERS」の旧名称です。)

 

App IDの発行日が2015年6月30日以前のアプリ(緩和措置対象)

Read系APIのfieldパラメータがセットされなかった際の挙動は下記の通りです。

[対象となるAPI]

Client、Recruiter、Job、Candidate、Resume及びProcessのRead

[挙動]

リクエストにfieldパラメータがセットされなかった場合、全ての項目が出力されます。

[例]

次のリクエストを送った場合

Input Parameter

.../v1/client?partition=999999&count=1&condition=Client.P_Owner:eq=7

次のレスポンスが返されます。

Output XML

<Client Total="1" Count="1" Start="0">
<Code>0</Code>
 <Item>
  <Client.P_Id>207675</Client.P_Id>
  <Client.P_Name>ポーターズスタッフィング</Client.P_Name>
  <Client.P_Owner>
   <User>
    <User.P_Id>7</User.P_Id>
   </User>
  </Client.P_Owner>
  <Client.P_Memo>This is a memo</Client.P_Memo>
  <Client.P_Zipcode>123-0056</Client.P_Zipcode>
  <Client.P_Street>東京都港区青山1-2-3</Client.P_Street>
  <Client.P_Telephone>03-3456-7890</Client.P_Telephone>
  <Cient.P_Fax>03-34560-7891</Cient.P_Fax>
  <Client.P_Phase/>
  <Client.P_PhaseDate/>
  <Client.P_PhaseMemo/>
  <Client.P_RegistrationDate>2014-02-01 12:03:44</Client.P_RegistrationDate>
  <Client.P_RegisteredBy>
   <User>
    <User.P_Id>3</User.P_Id>
   </User>
  </Client.P_RegisteredBy>
  <Client.P_UpdateDate>2014-04-07 15:32:01</Client.P_UpdateDate>
  <Client.P_UpdatedBy>
   <User>
    <User.P_Id>4</User.P_Id>
   </User>
  </Client.P_UpdatedBy>
  <Client.P_Country/>
  <Client.P_Prefecture/>
  <Client.P_City/>
  <Client.U_C63956A2C6D09C95D2004490D141BF/>
 </Item>
</Client>

 

 

APPIDの発行日が2015年7月1日以降のアプリ(v3.11以降の仕様書に準じる)

Read系APIのfieldパラメータがセットされなかった場合の挙動は下記の通りです。

[対象となるAPI]

Client、Recruiter、Job、Candidate、Resume及びProcessのRead

[挙動]

リクエストにfieldパラメータがセットされなかった場合、{Resource}.P_Idのみ出力されます。

これはfieldパラメータに{Resource}.P_Idだけがセットされた場合と同じ挙動です。

必要な項目はすべて明示的にfieldパラメータに指定する必要があります。

※{Resource}はJob, Processなどリソースの名前

[例]

HRBC v3.11以降では、fieldパラメータを省略した場合、リクエストに対するレスポンスが次のように、Client.P_Idだけが出力されます。

Input Parameter

.../v1/client?partition=999999&count=1&condition=Client.P_Owner:eq=7

 

Output XML

<Client Total="1" Count="1" Start="0">
<Code>0</Code>
 <Item>
  <Client.P_Id>207675</Client.P_Id>
 </Item>
</Client>

 

以前と同じようにデータを取得するには、fieldパラメータを明示的に指定します。

Input Parameter

.../v1/client?partition=999999&count=1&condition=Client.P_Owner:eq=7&field=Client.P_Id,Client.P_Name,Client.P_Owner,Client.P_Memo.....

 

この記事は役に立ちましたか?
0人中0人がこの記事が役に立ったと言っています