Pearson
Always Learning

Overview

When a user deletes a message from a Dropbox basket.

Message Type ID

Use this message type id to subscribe to this event and identify incoming instances of it: pearson.ls.dropbox.submission.deleted

What Triggers This Event

This event is triggered when a user deletes a message from a Dropbox in the LearningStudio User Interface, or via the Messages in Dropbox Basket by Course API:

  • DELETE /courses/{courseId}/dropboxBaskets/{dropboxBasketId}/messages/{messageId}

See Dropbox for the resources, use cases, and concepts for the Dropbox API resources.

Event Payload

Here is the structure of the event's payload. Text directly surrounded by curly brackets (e.g., {eventId}) are parameters that are defined in the table below.

{
  "eventId": "{eventId}",
  "eventDate": "{eventDate}",
  "eventType": "{eventType}",
  "object": {
    "id": "{objectId}",
    "type": "{parentEventType}",
    "submissionId": {SubmissionId},
    "userBasketId": {UserBasketId},
    "dropboxBasketId":{DropboxBasketId},
    "text": "{MessageText}",
    "submitDate": "{SubmitDate}",
    "isFirstSubmissionInUserBasket": {IsFirstSubmissionInUserBasketFlag},
    "submitterId": {SubmitterId},
    "submitterFirstName": "{SubmitterFirstName}",
    "submitterLastName": "{SubmitterLastName}",
    "submitterEmail": "{SubmitterEmail}"
  },
  "actor": {
    "id": "{actorId}",
    "type": "{actorType}",
    "firstName": "{firstName}",
    "lastName": "{lastName}",
    "emailAddress": "{emailAddress}",
    "userName": "{username}"
  },
  "contexts": {
    "course": {
      "id": "{courseId}",
      "title": "{courseTitle}",
      "displayCourseCode": "{displayCourseCode}",
      "callNumbers": [{courseCallNumbers}],
      "nodes": ["{courseNode}"]
    },
    "ep": {
      "id": "{epId}",
      "clientString": "{clientString}"
    }
  }
}

Event Payload Parameter Descriptions

Name Description Valid Values
{eventId} Unique ID assigned to the specific event.
{eventDate} Date and time when the event was published to the eventing message queue. Time is in UTC (no timezone offset). Format is
YYYY-MM-DDTHH:MM:SS.SSSZ
.
{eventType} Event type of the event object.
pearson.ls.dropbox.
↳ submission.deleted
{objectId} Unique object ID for the specific event contract data.
pearson.ls.dropbox.
↳ submission_{objectSubmissionId}
.
{parentEventType} An ID that represents the category of events, less specific than this event message type.
pearson.ls.dropbox.
↳ submission
{submissionId} The ID of the message that was deleted.
{UserBasketId} Course or user dropbox basket ID for the dropbox basked in which the dropbox message was deleted.  
{DropboxBasketId} Dropbox basket ID for the dropbox basked in which the dropbox message was deleted.  
{MessageText} Body of the dropbox message that was deleted.
{SubmitDate} Date and time when the message was deleted in the dropbox basket. Time is in UTC (no timezone offset). Format is
YYYY-MM-DDTHH:MM:SS.SSSZ
.
{IsFirstSubmissionInUserBasketFlag} Designates whether message is the first message created in the user basket. Each user basket is created only after a message has been submitted to it.
true
Message was the first message created in the user basket.
false
User basket already contained messages when this message was created.
{submitterId} ID of the original message author.
{submitterFirstName} First name of the original message author.
{sSubmitterLastName} Last name of the original message author.
{SubmitterEmail} Email address of the original message author.
{actorId} LearningStudio user ID of the user who deleted the topic.
{actorType} Type of user that generated the event.
user
Event was generated by the user action of deleting a message in a dropbox basket.
{firstName} First name of the user who deleted the message.
{lastName} Last name of the user who deleted the message.
{emailAddress} Email address of the user who deleted the message.
{username} LearningStudio username (login ID) of the user who deleted the message.
{courseId} LearningStudio course ID of the course that contained the dropbox basket where the message was deleted.
{courseTitle} Title of the course that contained the dropbox basket where the message was deleted.
{displayCourseCode} Display code for the course that contained the dropbox basket where the message was deleted.
{courseCallNumbers} Array of institution's call numbers assigned to the course that contained the dropbox basket where the message was deleted. Zero or more IDs written as strings.
{courseNode} Array of IDs of the nodes for which this course is associated. Zero or more IDs written as strings.
{epId} The numeric ID of the institution (the LearningStudio campus or instance).
{clientString} The institution's client string (primary identifier for campuses).

Example

{
  "eventId": "ec721be6-f4a2-4100-ba3f-a16228856569",
  "eventDate": "2013-05-13T21:02:31.448Z",
  "eventType": "pearson.ls.dropbox.submission.deleted",
  "object": {
    "id": "pearson.ls.dropbox.submission_1535",
    "type": "pearson.ls.dropbox.submission",
    "submissionId": 153512314,
    "userBasketId": 12351511,
    "dropboxBasketId": 141468,
    "text": "Sample text of submitted message",
    "submitDate": "2013-05-13T21:01:41.280Z",
    "isFirstSubmissionInUserBasket": false,
    "submitterId": 9876543,
    "submitterFirstName": "John",
    "submitterLastName": "Smith",
    "submitterEmail": "jsmith@domain.com"
  },
  "actor": {
    "id": "1313130",
    "type": "user",
    "firstName": "Terry",
    "lastName": "Potts",
    "emailAddress": "tpotts@domain.edu"
  },
  "contexts": {
    "course": {
      "id": "2026902",
      "title": "World History in the New Century",
      "displayCourseCode": "SELA1A1",
      "callNumbers": [],
      "nodes": ["123123"]
    },
    "ep": {
      "id": "54678",
      "clientString": "epsamplestring"
    }
  }
}   
2483 reads
Always Learning
Pearson