Example Offering Object

Below is an example of a JSON representation of an Offering object. This illustrates how offerings are represented in server responses.

{
  "id" : "56701a2d2f926674acede4d1ce880692",
  "title" : "Principles of Commercial Property Appraisal 2013",
  "createdDate" : "2011-02-01T00:02:12Z",
  "beginDate" : "2012-05-01T00:00:00Z",
  "endDate" : "2013-12-31T23:59:59Z",
  "registrationBeginDate" : "2012-05-01T00:00:00Z",
  "registrationEndDate" : "2013-12-31T23:59:59Z",
  "catalogDescription" : "This course highlights the differences between commercial and residential appraisals with a focus on 2013 changes to the certification examination.",
  "dashboardDescription" : "Welcome to your commercial property appraisal course",
  "deliveryDescription" : "Commercial Property Appraisal 2013",
  "price" : 500.0,
  "offeringCategoryIds" : [ "7822fec62f926674acede4d1c87ea25f", "ece5f268697213aef78845b221880692" ],
  "tags" : [ "commercial", "appraisal", "realestate" ],
  "orderIndex" : 0
}

Property Details

Property JSON Data Type Description
id string The offering’s unique identifier value. An offering’s URL in the API is composed of /dc/api/v5/offerings/ followed by this identifier.
title string The offering title.
createdDate string This is the date the offering was initially created in DigitalChalk. For more information on the expected date format, see the Date/Time Format reference.
beginDate string This is the date users will be able to begin taking the course. For more information on the expected date format, see the Date/Time Format reference.
endDate string This controls when the offering ends. Any users still taking the course at this time will have their progress halted and a final grade will be calculated and assigned. For more information on the expected date format, see the Date/Time Format reference.
registrationBeginDate string The date the offering will be made available for registration. For more information on the expected date format, see the Date/Time Format reference.
registrationEndDate string The date the offering will cease to be available for registration. For more information on the expected date format, see the Date/Time Format reference.
catalogDescription string The description of this course in the course catalog. Note that this field corresponds to the Override Catalog Description option from the Offerings screen on the web interface. Therefore, an empty value for this property does not mean the offering will not have a catalog description, only that it will inherit the description from the course. A value for this property simply indicates the catalog description has been modified from what is set on the course.
dashboardDescription string The description of this course on the user’s dashboard view. Note that this field corresponds to the Override Dashboard Description option from the Offerings screen on the web interface. Therefore, an empty value for this property does not mean the offering will not have a dashboard description, only that it will inherit the description from the course. A value for this property simply indicates the dashboard description has been modified from what is set on the course.
deliveryDescription string The description of this course on the course delivery screen. Note that this field corresponds to the Override Delivery Description option from the Offerings screen on the web interface. Therefore, an empty value for this property does not mean the offering will not have a delivery description, only that it will inherit the description from the course. A value for this property simply indicates the delivery description has been modified from what is set on the course.
price number The amount charged to users to register for the course.
offeringCategoryIds array This is an array of strings, each of which is an id of an offering category. An offering can belong to many categories, or to no categories at all. For more information, see the Offering Categories documentation.
tags array An array of strings representing the tags applied to this offering. Tags are not visible to end-users, only to administrators.
orderIndex string Determines the order of this offering in the catalog and the user dashboard if custom ordering has been enabled on those screens. The first position has an index value of 0.