SOAP WebService : modifyEvent

 

Edits the characteristics of an event.

Query

 

Parameter

Type

apikey

String

attributes

EntityInfo []

keys

EntityInfo []

parentKeys

EntityInfo []

forceCreate

boolean

 

apikey

The user’s API key (must be sent in all the queries). Accesses the WebService for a given user and planner.

attributes

List of the attributes to be edited.

keys

List of the identification attributes of the event.

parentKeys [optional]

List of the identification attributes of the parent event.

forceCreate

Option to force the creation of the event.

Accepts the values true or false. If the value is true, an event is created if no matching key exists in the planner.

Response

 

Attribute

Type

modifyEventResponse

WSResult

 

modifyEventResponse

The response is made up of a WSResult structure containing an “error” field (error code) and a “message” field (associated message).

In the event of a success, the error code is 0.

In the event of a failure, the error code is >0 and the message indicates the nature of the error encountered.

error

message

0

1

Invalid session: apikey

2

Invalid attribute: entityName

3

Update KO

 

 

Data types

 

The EntityInfo structure is made up of the following two fields:

Field

Type

Description

entityName

String

Attribute name

entityValue

String

Attribute value

The WSResult structure is made up of the following two fields:

Field

Type

Description

error

int

Error code

message

String

Error message

Print Friendly, PDF & Email
1 Etoile2 Etoiles3 Etoiles4 Etoiles5 Etoiles (No vote)
Loading...
Consulting training

Need training?

Use our consulting services!