Skip to main content

Events

An Event can be an appointment, a task to be done or simply a note. It can be linked to a Contact or a Project, and can be assigned to several resources.

Event methods​

Returns a list of all Events matching some specified search criteria.

Method​

GET/api/externals/v1/events

Arguments​

  • winLangID (long): Windows Language Identifier of the resulting data
  • storeID (long): ID of the Store owning the searched Events
  • contactID (long): ID of the Contact owning the searched Events
  • projectID (long): ID of the Project owning the searched Events
  • eventTypeActionKind (int): Kind of the Event Type of the searched Events
  • keyword (string): Searched keyword
  • minDate (datetime): Minimum date of the searched Events
  • maxDate (datetime): Maximum date of the searched Events
  • dateKind (string): Type of date used by the minDate and/or maxDate arguments. Allowed values: "CreationDate", "LastModificationDate"
  • idsOnly (boolean, true): If true, returns only a set of Event IDs
  • detailedView (boolean, false): If true, returns additional information about the matching Events

Body​

(none)

Response​

The search service returns a JSON message with the list of items matching the specified search criteria:

{
  "events": [
    {
      "id": long,
      "eventType": {
        "id": long,
        "description": string,
        "kind": int,
        "actionKind": int		// 0: Appointment, 1: To do, 2: Notes
      },
      "storeID": long,
      "contactID": long,
      "projectID": long,
      "title": string,
      "location": string,
      "startingDate": datetime,
      "endingDate": datetime,
      "isOnWholeDay": boolean,
      "priority": {
        "id": long,
        "description": string
      },
      "status": {
        "id": long,
        "description": string
      },
      "reminder": {
        "isActive": boolean,
        "reminderDate": datetime
      },
      "notes": string,
      "isCancelled": boolean,
      "cancelledOnDate": datetime,
      "resources": [
        {
          "id": long,
          "description": string,
          "internalCode": string,
          "isRead": boolean,
          "readOnDate": datetime,
          "isDone": boolean,
          "doneOnDate": datetime
        }
      ],
      "creationDate": datetime,
      "modificationDate": datetime
    }
  ],
  "winLangID": long,
  "success": boolean,
  "message": string,
  "rowCount": long
}

Details​

Returns the details of the Event which eventID is provided in the URL.

Method​

GET/api/externals/v1/events/{eventID}

Arguments​

  • eventID (long): (provided in the path): ID of the Event to be returned
  • winLangID (long): Windows Language Identifier of the resulting data
  • detailedView (boolean, false): If true, returns additional information about the matching Event

Body​

(none)

Response​

Same format as the one returned by the « Event search » method.