AnsweredAssumed Answered

Collaborate REST API: All dates should be in ISO

Question asked by njohnson_k12 on Feb 7, 2018

REST API docs don't make it clear that dates should be in ISO format, as Collaborate appears to be using Joda-Time:

DO THIS

{

     "startTime": "2018-02-07T18:42:30+00:00"

}

The Swagger plug in on the API doc (https://community.blackboard.com/community/developers/collaborate/pages/api-documentation) has exploded the Joda DateTime object and shows this for startDate and endDate in the request example JSON, and it's confusing for those of use who haven't been around Swagger+Joda.

DON'T DO THIS

"startTime": {

    "equalNow": true,

    "dayOfYear": 0,

    "year": 0,

    "weekyear": 0,

    "chronology": {

      "zone": {

        "fixed": true,

        "id": "string"

      }

    },

    "weekOfWeekyear": 0,

    "secondOfMinute": 0,

    "millisOfDay": 0,

    "monthOfYear": 0,

    "beforeNow": true,

    "dayOfWeek": 0,

    "minuteOfDay": 0,

    "era": 0,

    "dayOfMonth": 0,

    "zone": {

      "fixed": true,

      "id": "string"

    },

    "yearOfCentury": 0,

    "centuryOfEra": 0,

    "hourOfDay": 0,

    "secondOfDay": 0,

    "millis": 0,

    "yearOfEra": 0,

    "minuteOfHour": 0,

    "afterNow": true,

    "millisOfSecond": 0

  }

Hopefully this comment will help others avoid spending time firing unnecessary and incorrect JSON into the REST API.

 

Apologies if this is answered somewhere, and I didn't find it.

 

Cheers!

Outcomes