スクロール

Sales - Write

Sales Write Method

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

Sales Writeでは、指定した求人情報を新規に登録、または更新することができます。

POST

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

 

Scope

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

sales_w

 

Input Variables

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

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

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

 

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

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

 

新規登録および更新における注意点

  1. 売上情報を登録する際、次の依存関係は常に成り立っています。

      Sales.P_Job -> Sales.P_Recruiter -> Sales.P_Client <- Sales.P_Contract

    A -> BはAはBの下位リソースを意味します。
    下位リソースを新規登録・更新する際、再帰的にそのリソースの上位リソースも登録しなければなりません。
    したがって、Sales.P_Recruiterを新規登録・更新する場合は、Sales.P_Clientも同時に新規登録・更新しなければなりません。
    Sales.P_Recruiterだけでは新規登録・更新できません。
    同じようにSales.P_Jobを新規登録・更新する場合はSales.P_RecruiterとSales.P_Clientの新規登録・更新も必要になります。
    なお、これらの項目の値をクリアする場合、上位リソースをクリアすると、下位リソースも合わせてクリアする必要があります。
    例えば、Sales.P_Recruiterをクリアする際、Sales.P_Jobもクリアしなければなりません。

  2. Sales.P_CandidateとSales.P_Resumeを新規登録する際、両方指定する必要があり、整合性がチェックされます。
    更新する際で、片方しか指定されなかった場合、指定された項目の値と未指定の項目の更新される前の値で整合性がチェックされます。

 

Result Values

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

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

 

Output Values

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

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

 

Sales Write Sample

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

次のサンプルは、売上金額3000000、売上日付2012/01/01新規登録した場合の例です。

新規登録および更新における注意点の通り、Client、Recruiter、Job、Candidate、Resumeの指定が必要です。

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

 

Output XML

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

 

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