スクロール

Activity - Write

Activity Write Method

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

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

POST

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

 

Scope

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

activity_w

 

Input Variables

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

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

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

 

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

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

 

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

Activity.P_EventParticipantsは、次のフォーマットに従って指定してください。

 例1:ユーザー1のみを指定する場合
    <Activity.P_EventParticipants>
     <User.P_Id>1</User.P_Id>
    </Activity.P_EventParticipants>

 例2:複数指定する場合
    <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>

 

Result Values

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

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

 

Output Values

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

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

             

Activity Write Sample

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

次のサンプルは、JOB ID:10005に紐づけ、MTGのための日時(UTC)、リソースに会議室A、参加者にユーザー1、2、3を設定し新規登録した場合の例です。

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

 

Output XML

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

 

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