Project

General

Profile

Actions
History

Wiki »

Event Management - evt

The Event Apis enable the developper to access the event module of the platform, manage, create, delete or update any event of the family and his account based on his associated

access right.

Create an Event- evtcreate

The method evtcreate enables a logged user to create an event.

The method returns the Ievent as a result.

By sending an HTTP request http://testserver/api/evt/evtcreate

Parameters:

Name Type Description
text String event title
description String event description
startDate String Start Date of the event string containing an ISO-8601 formatted date-time.If it contains a time zone (not recommended), it will be converted to user time zone in utc
endDate String End Date of the eventstring containing an ISO-8601 formatted date-time.If it contains a time zone (not recommended), it will be converted to user time zone in utc
type String UNKNOWN;BIRTHDAY
placeId String associated place id information
contactId String associated contact id information for birthday, only available to define the birthday of contacts; for family members, use the method accgsetprofile instead
file binary binary associated photo may be multiple

Response:

{
  "cn":"evtcreate",
  "feed":{
    "startDate":"2011-04-01T08:00:00.00Z",
    "modifDate":"2011-07-28T13:00:36.88Z",
    "text":"test ",
    "pictureURI":"http:\/\/testserver\/media\/144_2987?",
    "accountId":"130",
    "eventId":"144_2151",
    "placeId":"144_123",
    "description":"test event description",
    "eventType":"UNKNOWN",
    "refPersonId":"110",
    "comments":[]
  }
}

The Method response returns the Ievent Feed.

In case, the method encounter any error, the response is an exeception with specific parameters detailed below.

Error:

Error Code Type Value Description
FizMediaQuotaExceededException ex 601 Media Quota exceedded
FizAccountNotFoundInSessionException un 501 Session is invalid
FizApiInvalidParameterException un 502 invalid token
FizApiModelDoesNotExistException un 503 Object does not exists
FizApiModelRightException un 504 Right exception to use this method

Create an Event- evtupdate

The method evtupdate enables a logged user to create an event.

The method returns the Ievent as a result.

By sending an HTTP request http://testserver/api/evt/evtcreate

Parameters:

|*Name*|*Type*|*Description*| |eventid|String|Event id to be updated| |text|String|event title| |description|String|event description| |startDate|String|Start Date of the event string containing an ISO-8601 formatted date/time.If it contains a time zone (not recommended), it will be converted to user time zone

in utc| |endDate|String|End Date of the eventstring containing an ISO-8601 formatted date/time.If it contains a time zone (not recommended), it will be converted to user time zone in

utc|
type String UNKNOWN;BIRTHDAY;BIRTHDAY_ACCOUNT
placeId String associated place id information
accountId String associated contact id information for birthday
file binary binary associated photo may be multiple

Response:

{
  "cn":"evtcreate",
  "feed":{
    "startDate":"2011-04-01T08:00:00.00Z",
    "modifDate":"2011-07-28T13:00:36.88Z",
    "text":"test ",
    "pictureURI":"http:\/\/testserver\/media\/144_2987?",
    "accountId":"130",
    "eventId":"144_2151",
    "placeId":"144_123",
    "description":"test event description",
    "eventType":"UNKNOWN",
    "refPersonId":"110",
    "comments":[]
  }
}

The Method response returns the Ievent Feed.

In case, the method encounter any error, the response is an exeception with specific parameters detailed below.

Error:

Error Code Type Value Description
FizMediaQuotaExceededException ex 601 Media Quota exceedded
FizAccountNotFoundInSessionException un 501 Session is invalid
FizApiInvalidParameterException un 502 invalid token
FizApiModelDoesNotExistException un 503 Object does not exists
FizApiModelRightException un 504 Right exception to use this method

Delete an Event- evtdelete

The method evtdelete enables a logged user to delete an event for a certain eventId.

The method returns a boolean.

By sending an HTTP request http://testserver/api/api/evt/delete?eventId=1234

Parameters:

Name Type Description
eventId String eventid information

Response:

{
  "cn":"evtdelete",
  "feed":"true" 
}

The Method response returns a boolean (TRUE=deleted)

In case, the method encounter any error, the response is an exeception with specific parameters detailed below.

Error:

Error Code Type Value Description
FizAccountNotFoundInSessionException un 501 Session is invalid
FizApiInvalidParameterException un 502 invalid token
FizApiModelDoesNotExistException un 503 Object does not exists
FizApiModelRightException un 504 Right exception to use this method

Comment an Event- evtcomment

The method evtcomment enables a logged user to comment an event for a certain eventId.

The method returns the comment of the event feed.

By sending an HTTP request http://testserver/api/api/evt/comment?eventId=144_2153&text=text_here

Parameters:

Name Type Description
eventId String eventid information
text String comment text string shall be url encoded

Response:

{
  "cn":"evtcomment",
  "feed":{
    "modifDate":"2011-07-28T13:10:10.26Z",
    "text":"élement",
    "accountId":"130",
    "commentId":"144_2011_2153_766" 
  }
}

In case, the method encounter any error, the response is an exeception with specific parameters detailed below.

Error:

Error Code Type Value Description
FizAccountNotFoundInSessionException un 501 Session is invalid
FizApiInvalidParameterException un 502 invalid token
FizApiModelDoesNotExistException un 503 Object does not exists
FizApiModelRightException un 504 Right exception to use this method

Get Event- evtget

The method evtget enables a logged user to get an event for a certain eventId.

The method returns the Ievents feed (note that if a parameter does not appear it shall be consider as empty)

By sending an HTTP request http://testserver/api/api/evt/get?eventId=1234

Parameters:

Name Type Description
eventId String eventid information

Response:

{
  "cn":"evtget",
  "feed":{
    "startDate":"2011-04-01T08:00:00.00Z",
    "modifDate":"2011-07-28T13:12:47.00Z",
    "text":"test ",
    "pictureURI":"http:\/\/testserver\/media\/144_2990?",
    "accountId":"130",
    "eventId":"144_2154",
    "placeId":"144_123",
    "description":"test event description",
    "eventType":"UNKNOWN",
    "refPersonId":"110",
    "comments":[]
  }
}

In case, the method encounter any error, the response is an exeception with specific parameters detailed below.

Error:

Error Code Type Value Description
FizAccountNotFoundInSessionException un 501 Session is invalid
FizApiInvalidParameterException un 502 invalid token
FizApiModelDoesNotExistException un 503 Object does not exists
FizApiModelRightException un 504 Right exception to use this method

Get Event for certain Place- evtgetbyplace

The method evtgetbyplace enables a logged user to get a list of event for a certain placeId.

The method returns the list of Ievents feed corresponding to the placeId(note that if a parameter does not appear it shall be consider as empty)

By sending an HTTP request http://testserver/api/api/evt/getbyplace?placeId=144_123

Parameters:

Name Type Description
placeId String Id of the place

Response:

{
  "cn":"evtgetbyplace",
  "feed":[
    {
      "startDate":"2011-04-01T08:00:00.00Z",
      "modifDate":"2011-07-28T12:58:53.00Z",
      "text":"test ",
      "accountId":"130",
      "eventId":"144_2147",
      "placeId":"144_123",
      "description":"test event description",
      "eventType":"UNKNOWN",
      "comments":[]
    },{
      "startDate":"2011-04-01T08:00:00.00Z",
      "modifDate":"2011-07-28T13:10:10.00Z",
      "text":"test ",
      "pictureURI":"http:\/\/testserver\/media\/144_2988?",
      "accountId":"130",
      "eventId":"144_2153",
      "placeId":"144_123",
      "description":"test event description",
      "eventType":"UNKNOWN",
      "refPersonId":"110",
      "comments":[
        {
          "modifDate":"2011-07-28T13:08:59.00Z",
          "text":"comment text here",
          "accountId":"130",
          "commentId":"144_2011_2153_765" 
        },{
          "modifDate":"2011-07-28T13:10:10.00Z",
          "text":"element text here",
          "accountId":"130",
          "commentId":"144_2011_2153_766" 
        }
      ]
    },{
      "startDate":"2011-04-01T08:00:00.00Z",
      "modifDate":"2011-07-28T13:12:47.00Z",
      "text":"test ",
      "pictureURI":"http:\/\/testserver\/media\/144_2990?",
      "accountId":"130",
      "eventId":"144_2154",
      "placeId":"144_123",
      "description":"test event description",
      "eventType":"UNKNOWN",
      "refPersonId":"110",
      "comments":[]
    }
  ]
}

In case, the method encounter any error, the response is an exeception with specific parameters detailed below.

Error:

Error Code Type Value Description
FizAccountNotFoundInSessionException un 501 Session is invalid
FizApiInvalidParameterException un 502 invalid token
FizApiModelDoesNotExistException un 503 Object does not exists
FizApiModelRightException un 504 Right exception to use this method

Get Event List- evtlist

The method evtlist enables a logged user to get a list of events.

The method returns the list of Ievents feed.

By sending an HTTP request http://testserver/api/api/evt/list?

Parameters:

No parameters in this method

Response:

{
  "cn":"evtlist",
  "feed":[
    {
      "startDate":"2011-04-11T17:00:00.00Z",
      "modifDate":"2011-06-09T13:10:54.00Z",
      "text":"Dinner at Gran Pa",
      "accountId":"130",
      "eventId":"144_95",
      "description":"",
      "endDate":"2011-04-11T21:00:00.00Z",
      "eventType":"UNKNOWN",
      "comments":[]
    },{
      "startDate":"2011-07-07T03:31:38.00Z",
      "modifDate":"2011-07-07T03:31:59.00Z",
      "text":"text here",
      "accountId":"131",
      "eventId":"144_607",
      "description":"",
      "endDate":"2011-07-07T04:31:38.00Z",
      "eventType":"UNKNOWN",
      "comments":[]
    },{
      "startDate":"2011-07-07T03:37:55.00Z",
      "modifDate":"2011-07-07T03:38:16.00Z",
      "text":"test event",
      "accountId":"131",
      "eventId":"144_617",
      "description":"",
      "endDate":"2011-07-07T04:37:55.00Z",
      "eventType":"UNKNOWN",
      "comments":[]
    },{
      "startDate":"2011-07-11T14:56:52.00Z",
      "modifDate":"2011-07-28T06:59:25.00Z",
      "text":"test event2",
      "accountId":"131",
      "eventId":"144_743",
      "description":"description here",
      "endDate":"2011-07-12T15:56:52.00Z",
      "eventType":"UNKNOWN",
      "comments":[
        {
          "modifDate":"2011-07-11T10:12:21.00Z",
          "text":"text here",
          "accountId":"131",
          "commentId":"144_2011_743_182" 
        }
      ]
    },{
      "startDate":"2011-07-11T12:59:18.00Z",
      "modifDate":"2011-07-11T12:59:27.00Z",
      "text":"text here",
      "accountId":"131",
      "eventId":"144_753",
      "description":"",
      "endDate":"2011-07-11T13:59:18.00Z",
      "eventType":"UNKNOWN",
      "comments":[]
    },{
      "startDate":"2011-07-26T03:49:17.00Z",
      "modifDate":"2011-07-26T03:50:00.00Z",
      "text":"",
      "accountId":"130",
      "eventId":"144_1866",
      "description":"",
      "endDate":"2011-07-26T04:49:17.00Z",
      "eventType":"UNKNOWN",
      "comments":[]
    },{
      "startDate":"2011-04-01T08:00:00.00Z",
      "modifDate":"2011-07-28T13:12:47.00Z",
      "text":"text here",
      "pictureURI":"http:\/\/testserver\/media\/144_2990?",
      "accountId":"130",
      "eventId":"144_2154",
      "placeId":"144_123",
      "description":"test event description",
      "eventType":"UNKNOWN",
      "refPersonId":"110",
      "comments":[]
    }
  ]
}

In case, the method encounter any error, the response is an exeception with specific parameters detailed below.

Error:

Error Code Type Value Description
FizApiUnattendedException un 500 Unexpected Server Error
FizAccountNotFoundInSessionException un 501 Session is invalid
FizApiInvalidParameterException un 502 invalid token
FizApiModelDoesNotExistException un 503 Object does not exists
FizApiModelRightException un 504 Right exception to use this method

Get Event List for specific interval- evtlistinterval

The method evtlistinterval enables a logged user to get a list of events for a certain interval.

The method returns the list of Ievents feed.

By sending an HTTP request http://testserver/api/api/evt/listinterval?from=2011-04-01T08%3A00&to=2011-05-01T08%3A00

Parameters:

Name Type Description
from String Start Date of the interval containing an ISO-8601 formatted date/time
to String End Date of the interval containing an ISO-8601 formatted date/time

Response:

{
  "cn":"evtlistinterval",
  "feed":[
    {
      "startDate":"2011-04-01T08:00:00Z",
      "modifDate":"2011-07-28T08:30:07Z",
      "text":"test event title",
      "accountId":"130",
      "eventId":"144_2135",
      "description":"test event description",
      "endDate":"2011-04-01T09:00:00Z",
      "eventType":"UNKNOWN",
      "comments":[]
    },{
      "startDate":"2011-04-01T08:00:00Z",
      "modifDate":"2011-07-28T08:40:32Z",
      "text":"test event title",
      "accountId":"130",
      "eventId":"144_2136",
      "description":"test event description",
      "eventType":"UNKNOWN",
      "comments":[]
    },
    }
  ]
}

In case, the method encounter any error, the response is an exeception with specific parameters detailed below.

Error:

Error Code Type Value Description
FizApiUnattendedException un 500 Unexpected Server Error
FizAccountNotFoundInSessionException un 501 Session is invalid
FizApiInvalidParameterException un 502 invalid token
FizApiModelDoesNotExistException un 503 Object does not exists
FizApiModelRightException un 504 Right exception to use this method

Get Event List for specific month- evtlistmonth

The method evtlistmonth enables a logged user to get a list of events for a certain month.

The method returns the list of Ievents feed.

By sending an HTTP request http://testserver/api/api/evt/listmonth?date=2011-06-01T08%3A00

Parameters:

Name Type Description
from String Current Date of the selected month (if empty current month)

Response:

{
  "cn":"evtlistmonth",
  "feed":[
    {
      "startDate":"2011-07-01T14:06:15.000Z",
      "modifDate":"2011-07-01T14:06:45.000Z",
      "text":"Working",
      "accountId":"130",
      "eventId":"144_383",
      "placeId":"144_84",
      "description":"",
      "endDate":"2011-07-01T15:06:15.000Z",
      "eventType":"UNKNOWN",
      "comments":[]
    },{
      "startDate":"2011-07-01T14:07:21.000Z",
      "modifDate":"2011-07-01T14:07:56.000Z",
      "text":"text here",
      "accountId":"130",
      "eventId":"144_384",
      "description":"",
      "endDate":"2011-07-02T15:07:21.000Z",
      "eventType":"UNKNOWN",
      "comments":[]
    },
    }
  ]
}

In case, the method encounter any error, the response is an exeception with specific parameters detailed below.

Error:

Error Code Type Value Description
FizApiUnattendedException un 500 Unexpected Server Error
FizAccountNotFoundInSessionException un 501 Session is invalid
FizApiInvalidParameterException un 502 invalid token
FizApiModelDoesNotExistException un 503 Object does not exists
FizApiModelRightException un 504 Right exception to use this method

Get Event List for specific week- evtlistweek

The method evtlistweek enables a logged user to get a list of events for a certain week.

The method returns the list of Ievents feed.

By sending an HTTP request http://testserver/api/api/evt/listweek?date=2011-07-01T08%3A00

Parameters:

Name Type Description
from String Current Date of the selected month (if empty current week)

Response:

{
  "cn":"evtlistmonth",
  "feed":[
    {
      "startDate":"2011-07-01T14:06:15.000Z",
      "modifDate":"2011-07-01T14:06:45.000Z",
      "text":"Working",
      "accountId":"130",
      "eventId":"144_383",
      "placeId":"144_84",
      "description":"",
      "endDate":"2011-07-01T15:06:15.000Z",
      "eventType":"UNKNOWN",
      "comments":[]
    },{
      "startDate":"2011-07-01T14:07:21.000Z",
      "modifDate":"2011-07-01T14:07:56.000Z",
      "text":"text here",
      "accountId":"130",
      "eventId":"144_384",
      "description":"",
      "endDate":"2011-07-02T15:07:21.000Z",
      "eventType":"UNKNOWN",
      "comments":[]
    },{
      "startDate":"2011-07-05T16:00:00.000Z",
      "modifDate":"2011-07-06T02:56:04.000Z",
      "text":"text here",
      "accountId":"133",
      "eventId":"144_535",
      "description":"",
      "endDate":"2011-07-06T16:00:00.000Z",
      "eventType":"UNKNOWN",
      "comments":[]
    },
    }
  ]
}

In case, the method encounter any error, the response is an exeception with specific parameters detailed below.

Error:

Error Code Type Value Description
FizApiUnattendedException un 500 Unexpected Server Error
FizAccountNotFoundInSessionException un 501 Session is invalid
FizApiInvalidParameterException un 502 invalid token
FizApiModelDoesNotExistException un 503 Object does not exists
FizApiModelRightException un 504 Right exception to use this method

List a number of X events from a certain event- evtnavigate

The method evtlistnavigate enables a logged user to get a list of X events from a certain event id .

The method returns the list of Ievents feed.

By sending an HTTP request http://testserver/api/api/evt/navigate?eventId=144_383&offset=10

Parameters:

Name Type Description
eventid String Start Event Id from the list
offset String Number of subsequent additional event from the start evend id. Offset may be negative to display X previous events

Response:

"cn":"evtnavigate",
  "feed":[
    {
      "startDate":"2011-07-01T14:07:21.000Z",
      "modifDate":"2011-07-01T14:07:56.000Z",
      "text":"text here",
      "accountId":"130",
      "eventId":"144_384",
      "description":"",
      "endDate":"2011-07-02T15:07:21.000Z",
      "eventType":"UNKNOWN",
      "comments":[]
    },{
      "startDate":"2011-07-05T16:00:00.000Z",
      "modifDate":"2011-07-06T02:56:04.000Z",
      "text":"text here",
      "accountId":"133",
      "eventId":"144_535",
      "description":"",
      "endDate":"2011-07-06T16:00:00.000Z",
      "eventType":"UNKNOWN",
      "comments":[]
    },{
      "startDate":"2011-07-05T22:00:00.000Z",
      "modifDate":"2011-07-05T16:41:21.000Z",
      "text":"Work",
      "accountId":"130",
      "eventId":"144_534",
      "description":"",
      "endDate":"2011-07-05T22:00:00.000Z",
      "eventType":"UNKNOWN",
      "comments":[]
    },
    }
  ]
}

In case, the method encounter any error, the response is an exeception with specific parameters detailed below.

Error:

Error Code Type Value Description
FizApiUnattendedException un 500 Unexpected Server Error
FizAccountNotFoundInSessionException un 501 Session is invalid
FizApiInvalidParameterException un 502 invalid token
FizApiModelDoesNotExistException un 503 Object does not exists
FizApiModelRightException un 504 Right exception to use this method

Updated by Eric Vieillevigne over 10 years ago · 1 revisions