Activity Write Method
The Activity API provides access to the Activity Resource.
Activity Write enables the user to newly register or update job opening information.
|
POST |
https://{Request URI Host}/v1/activity?partition=[value] |
|---|
Scope
The access privilege required for Activity Write is as follows:
activity_w
Input Variables
When using the GET or POST Method, the parameter of the HTTP Header must be specified with a value. For details, see HTTP Header.
The following shows the Parameters that can be specified:
| Required | Parameter | Definition |
|---|---|---|
| ● | partition | Specify a numerical value for the Partition Id. To check the Partition Id that can be accessed, acquire the information using Partition Read. |
The following value can be specified in the XML format for the data block for POST.
| Tag | Definition |
|---|---|
| Activity | Root element that indicates the Activity data. |
| Item | Indicates one piece of Activity information. |
| Field | Specify the item and value. For information on the Fields that can be specified, see Activity - Field List. |
新規登録および更新における注意点
Specify Activity.P_EventParticipants in the following format.
Example 1: When specifying only User 1
<Activity.P_EventParticipants>
<User.P_Id>1</User.P_Id>
</Activity.P_EventParticipants>
Example 2: When specifying multiple users
<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
When the processing is successfully completed, “200” is returned to the Response Header as the HTTP status, and the value that is described in Output Values can be acquired.
If an error occurs, a value other than 200 is returned.
Output Values
The output value can be acquired in the XML format.
| Tag | Definition |
|---|---|
| Activity | Root element that indicates the Activity data. |
| Item | Indicates one piece of Activity information. |
| Id | The Id of the updated or newly registered Activity. |
| Code | The code that represents the processing result. For details, see Result Code List. |
Activity Write Sample
This sample code shown below is not encoded. In the case of an actual Request, encoding/decoding may be necessary depending on the content.
The following sample newly registers the date and time (UTC) for MTG, resource that is set to Meeting room A, and participants that are set to User 1, 2, and 3 while associating these information with JOB ID: 10005.
|
Input XML <?xml version=”1.0” encoding=”UTF-8” standalone=”yes”?> |
|
Output XML <?xml version=”1.0” encoding=”UTF-8” standalone=”yes”?> |