WOworkramp

Update Assignment

Update an assignment for a given user

post/api/v1/guide_assignments/{GuideAssignmentID}

Request

  • Base URL
    https://app.workramp.com
  • URL
    https://app.workramp.com/api/v1/guide_assignments/{GuideAssignmentID}
  • Auth
    API key in header Authorization

Path parameters

GuideAssignmentIDstring required

The Guide Assignment ID (a GUID)

Request body

dueDatestring date-time

Flexible date format, with a preference for ISO8601 formats, but can accept number of milliseconds since 1970-01-01 00:00:00 UTC.

isCompletedboolean
completedDatestring date-time

Flexible date format, with a preference for ISO8601 formats, but can accept number of milliseconds since 1970-01-01 00:00:00 UTC.- Providing a "completedDate" does NOT complete a user's assignment.

scorenumber float

A percentage with value from 0-100. Providing a "score" does NOT complete a user's assignment.

dueAtEndOfDayboolean

Specifies whether you want to have the due date set to 23:59:99 of the day chosen.

Response

200

idstring
userIdinteger
titlestring
courseIdstring
trainingSeriesUserAssignmentIdunknown
dueDateinteger
numViewedTasksinteger
numCompletedTasksinteger
numCompletedTestQuestionsinteger
numGradedTestQuestionsinteger
numCorrectTestQuestionsinteger
scoreinteger
isArchivedunknown
isCompletedboolean
createdAtnumber
updatedAtnumber
completedAtinteger

Example response

{
  "id": "80afd844-fc64-11e6-8eb3-02dcdaae3a92",
  "userId": 1144,
  "title": "Guide 1 Title",
  "courseId": "e585fd3e-509d-11e6-9bd0-06d818a6b395",
  "dueDate": 1487900059000,
  "score": 80,
  "createdAt": 1488141926731.2966,
  "updatedAt": 1488141926731.2966,
  "completedAt": 1609416000000
}

Changes

No recorded changes to this operation across all 1 revision of this API.