Get Training Queue

Description

This API endpoint can be used to get all module-level information on Awareness Training Mime|OS Training Modules created, both pending and launched.

Pre-requisites

  • In order to successfully use this endpoint the logged in user must be a Mimecast administrator with at least the Awareness Training | Dashboard | Read permission.

URI

To use this endpoint you send a POST request to:

  • /api/awareness-training/queue/get-queue

Request Headers

The following request headers must be included in your request:

Field Description
Authorization Please see the Authorization guide for more information on building the Authorization header.
x-mc-req-id

A randomly generated GUID, for example,

8578FCFC-A305-4D9A-99CB-F4D5ECEFE297
x-mc-app-id The Application ID provided with your Registered API Application.
x-mc-date

The current date and time in the following format, for example,

Tue, 24 Nov 2015 12:50:11 UTC

Request Body

{
 "data": []
}

Response

{
 "fail": [], 
 "meta": {
  "status": 200
 }, 
 "data": [
  {
   "assignToNewUsers": true, 
   "customContentId": "String", 
   "id": "Sting", 
   "numCompleted": 5, 
   "numCorrect": 4, 
   "locked": true, 
   "title": {
    "defaultGifs": {
     "correctGif": "Sting", 
     "incorrectGif": "Sting"
    }, 
    "correctAnswer": 1, 
    "id": "Sting", 
    "title": "Sting"
   }, 
   "customGifs": {
    "correctGif": "Sting", 
    "incorrectGif": "Sting"
   }, 
   "numSent": 5, 
   "emailCustomized": true, 
   "customAnswer": {
    "safetyTip": "String", 
    "correctAnswer": "String"
   }, 
   "launchDate": "Date Sting", 
   "emailMsg": {
    "body": "Sting", 
    "subject": "Sting"
   }, 
   "optionSpread": {
    "option-4": 0, 
    "option-1": 1, 
    "option-2": 0, 
    "option-3": 4
   }
  }
 ]
}
meta object
Field Type Description
status Number The function level status of the request.
meta
Field Type Description
status Number The function level status of the request.
data
Field Type Description
id String The Mimecast secure ID of the campaign.
title Title Object An object containing information about the campaign title
launchDate Date String Timestamp indicating when the campaign was set to be launched, in ISO 8601 format.
emailCustomized Boolean Identifies if the email alert going to assinged users was modified from the template.
emailMsg Email Message Object An object containing the email message sent to assigned users.
numSent Number Count showing the number of emails sent out to assigned users of the campaign.
numCompleted Number Count showing the number of users that have completed the campaign.
locked Boolean Indicates if the campaign has been locked, preventing updates, deletion, rescheduling or launching.
customContentId String Mimecast secure ID of the enterprise-queue.
assignToNewUsers Boolean Indicates if the video module will be assigned to newly created users after the lauch date.
customGifs GIFs Object An object containing links to the correct and incorrect answer images.
customAnswer Custom Answer Object An object containing the custom safety tip and answer.
optionSpread Option Object An object containing counts for each answer option.
Title Object
Field Type Description
id String The Mimecast secure ID of the campaign title.
title String The title name.
titleForCustomerModule Boolean Indicates if the title information is for a custom module.
correctAnswers Answer Count Object An object providing the counts of correct responses to each question.
defaultGifs GIFs Object An object containing links to the correct and incorrect answer images.
Answer Count Object
Field Type Description
forQuestion1 Number Count for the number of users that correctly answered question number one.
forQuestion2 Number Count for the number of users that correctly answered question number two.
forQuestion3 Number Count for the number of users that correctly answered question number 3.
GIFs Object
Field Type Description
correctGif String URL to the image displayed when a user answers the question correctly.
incorrectGif String URL to the image displayed when a user answers the question incorrectly.
Email Message Object
Field Type Description
body String Contents of the message body sent to users.
subject String Contents of the message subject sent to users.
Custom Answer Object
Field Type Description
safetyTip String The safety displayed to the user.
correctAnswer String Text of the correct answer.
Option Object
Field Type Description
option-1 Number Number of users that answered with option 1.
option-2 Number Number of users that answered with option 2.
option-3 Number Number of users that answered with option 3.
option-4 Number Number of users that answered with option 4.

Sample Code

Sample code is provided to demonstrate how to use the API and is not representative of a production application. To use the sample code; complete the required variables as described, populate the desired values in the request body, and execute in your favorite IDE.  Please see the Global Base URL's page to find the correct base URL to use for your account.

POST {base_url}/api/awareness-training/queue/get-queue
Authorization: MC {accesskKey}:{Base64 encoded signed Data To Sign}
x-mc-date: {dateTime}
x-mc-req-id: {unique id}
x-mc-app-id: {applicationId}
Content-Type: application/json
Accept: application/json


{
  "data":[]
}