スクロール

Candidate - Write

Candidate Write Method

Candidate APIは、Candidate Resourceに対するアクセスを提供します。

Candidate Writeでは、個人連絡先情報を新規に登録、または更新することができます。

POST

https://{Request Host}/v1/candidate?partition=[value]

 

Scope

Candidate Writeを行うために必要なアクセス権は次の通りです。

candidate_w

 

Input Variables

GETやPOST Methodを利用する場合、HTTP Headerのパラメータに値を指定する必要があります。詳細はHTTP Headerを参照してください。

また、指定できるParameterは以下の通りです。

必須 Parameter Definition
partition Partition Idを数値で指定します。
アクセス可能なPartition Idを確認したい場合、Partition Readで取得してください。

 

次の値をXML形式でPOST時のデータブロックに指定できます。

Tag Definition
Candidate Candidateデータを表すルート要素です。
Item 一つのCandidate情報を表します。
 Field 項目と値を指定します。指定できるFieldは、Candidate - Field Listを参照してください。

 

Result Values

処理が成功した場合は、Response HeaderにHTTP Statusとして200が返り、Output Valuesで解説している値が取得できます。

エラーが発生した場合は、200以外の値が返ります。

 

Output Values

出力値はXML形式で取得できます。

Tag Definition
Candidate Candidateデータを表すルート要素です。
Item 一つのCandidate情報を表します。
 Id 更新または新規登録されたCandidateのIdです。
 Code 処理結果を表すcodeです。詳細は、Result Code Listを参照してください。

             

Candidate Write Sample

※本サンプルでは、Encodeを行わずに記載しています。実際のRequest時には内容によってEncode/Decodeが必要です。

次のサンプルは、氏名:鈴木 一郎、フリガナ:すずき いちろうとして新規登録した場合の例です。

Input 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>

 

Output XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Candidate>
 <Item>
  <Id>10001<Id>
  <Code>0</Code>
 </Item>
</Candidate>

 

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