Retrieve a Specific Offering By Id

Last modified on August 24, 2023 at 6:18 pm

Overview

Retrieves a specific offering with the specified id. The result of this GET request will be JSON-encoded representation of an offering object. The object definition is provided below.

JSON Object Definition

The following is a full definition of all possible properties on the JSON object representing an offering. For details about these properties, see the Offering Object Reference.

  1. {
  2.   "id" : "",
  3.   "title" : "",
  4.   "beginDate" : "",
  5.   "endDate" : "",
  6.   "registrationBeginDate" : "",
  7.   "registrationEndDate" : "",
  8.   "catalogDescription" : "",
  9.   "dashboardDescription" : "",
  10.   "deliveryDescription" : "",
  11.   "price" : 0.0,
  12.   "offeringCategoryIds" : [ "", ... ],
  13.   "tags" : [ "", ... ],
  14.   "orderIndex" : 0
  15. }

Examples

Retrieve Offering by ID

This example shows the retrieval of a single offering by its identifier. Because it has an orderIndex value of 1, it would appear as the second item in a list of your organization’s offerings.

Request
  1. GET /dc/api/v5/offerings/7610000620ac0df0113cb75752dadef HTTP/1.1
  2. Host: api.digitalchalk.com
  3. Accept: application/json
Response
  1. HTTP/1.1 200 OK
  2. Content-type: application/json
  3. Content-length: 456 
  4.  
  5. {
  6.   "id" : "7610000620ac0df0113cb75752dadef",
  7.   "title" : "Sample Offering 2",
  8.   "beginDate" : "2013-08-01T08:00:00Z",
  9.   "endDate" : "2014-01-01T07:59:59Z",
  10.   "registrationBeginDate" : "2013-07-15T00:00:00Z",
  11.   "registrationEndDate" : "2013-08-01T00:00:00Z",
  12.   "catalogDescription" : "Second Sample Offering",
  13.   "dashboardDescription" : "Begin taking Sample Offering 2",
  14.   "deliveryDescription" : "Report Record of Sample Offering 2",
  15.   "price" : 285.0,
  16.   "offeringCategoryIds" : [ "322887559acf003141592653584510e", "31984324731200022dc6f676621398a" ],
  17.   "tags" : [ "sample" ],
  18.   "orderIndex" : 1
  19. }

Failure Cases

Below is a list of the most common failure scenarios your code should be prepared to handle. This list is not exhaustive.

Invalid ID

If there is no offering resource located at the given URL, the server will issue a 404 Not Found response.

Request
  1. GET /dc/api/v5/offerings/INVALID_ID_HERE HTTP/1.1
  2. Host: api.digitalchalk.com
  3. Accept: application/json
Response
  1. HTTP/1.1 404 Not Found
  2. Content-type: application/json
  3. Content-length: 55
  4.  
  5. {
  6. 	"errors": [ "No resource exists with the given id." ]
  7. }

Reference