SOAP WebService : addEventLink

 

Creates a link between two events.

Query

 

Parameter

Type

apikey

String

beginUID

String

endUID

String

type

String

behavior

String

mode

String

delayType

String

delay

int

 

apikey

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

beginUID

UID identifier of the start event.

endUID

UID identifier of the end event.

type

Type of link (End to start, Start to start, End to end, Start to end) « END_BEGIN »,« BEGIN_BEGIN »,« END_END »,« BEGIN_END ».

behavior

Behavior of the link (Adjust, Warning, Constraint) « ADJUST »,« WARNING »,« CONSTRAINT ».

mode

Link mode (Strict delay, Maximum delay, Minimum delay) « STRICT »,« ADJUSTMIN »,« ADJUSTMAX ».

delayType

Delay type (Hourly, Daily) « DAY »,« HOUR ».

delay

Delay between the start event and the end event (in minutes or in days)

Response

 

Attribute

Type

addEventLinkResponse

WSResult

 

addEventLinkResponse

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

Begin event must be different of the end event

3

Invalid begin or end event UID

Link already exists

4

Invalid link type : type

5

Invalid link mode : mode

6

Invalid delay type : delayType

7

Invalid link behavior : behavior

8

Create KO

 

 

Data type

 

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!