CampusAPI Calendaring Services API documentation version 0.1.0
Based on OSID version 3.0.0

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "location", "sponsors", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleEventType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleEventType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleEventType%40campusapi.org

• fromDate: (string)

  Get all events from this date inclusive. Use with toDate to define date range query.

  Example:

  2020-10-03

• toDate: (string)

  Get all events up to this date inclusive. Use with fromDate to define date range query.

  Example:

  2020-12-18

• calendarId: (string)

  The id string to match a calendar

  Example:

  calendaring.Calendar%3A8374%40base.url

Query Parameters

• calendarId: (string)

  specify in which calendar to create this event

  Example:

  calendaring.Calendar%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Event",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this event. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this event. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this event for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this event.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this event. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this event. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this event.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this event.",
      "type": "string",
      "format": "date-time"
    },
    "sequestered": {
      "description": "Whether this event is sequestered in that it should not appear outside of its aggregation.",
      "type": "boolean"
    },
    "locationDescription": {
      "description": "A descriptive location.",
      "type": "string"
    },
    "locationId": {
      "description": "The Location.",
      "type": "string",
      "format": "osid-id"
    },
    "sponsorIds": {
      "description": "The Sponsors.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    }
  }
}

Example:

{
  "displayName": "Display Name of this Event",
  "description": "The description of this Event",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "sequestered": false,
  "locationDescription": "This is the LocationDescription",
  "locationId": "mapping.Location:3666@base.url",
  "sponsorIds": [ "resource.Resource:9273@base.url", "..." ]
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "location", "sponsors", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "EventQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchEffective": {
      "description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
      "type": "boolean"
    },
    "matchStartDate": {
      "description": "Matches temporals whose start date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndDate": {
      "description": "Matches temporals whose end date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchSequestered": {
      "description": "Match containables that are sequestered.  true to match any sequestered containables, false to match non-sequestered containables",
      "type": "boolean"
    },
    "matchLocationDescription": {
      "description": "List of LocationDescription strings to match. Boolean OR performed among multiple locationDescriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "locationDescriptions": {
            "description": "locationDescriptions to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyLocationDescription": {
      "description": "Match locationDescriptions with any value. true to match Events with any location description, false to match ProgramOfferings with no location description",
      "type": "boolean"
    },
    "matchLocationIds": {
      "description": "List of Location Ids for this query to match location.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "locationId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "locationQueries": {
      "description": "mapping.LocationQueries to match the Location. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "location-query"
      }
    },
    "matchAnyLocation": {
      "description": "Match location with any value. true to match Events with any location, false to match Events with no location",
      "type": "boolean"
    },
    "matchSponsorIds": {
      "description": "List of Resource Ids for this query to match sponsor.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "sponsorQueries": {
      "description": "resource.ResourceQueries to match the Sponsor. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchAnySponsor": {
      "description": "Match sponsor with any value. true to match Events with any sponsor, false to match Events with no sponsor",
      "type": "boolean"
    },
    "matchCalendarIds": {
      "description": "List of Calendar Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "calendarId": {
            "description": "Calendar id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "calendarQueries": {
      "description": "CalendarQueries to match Calendar. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "calendar-query"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• calendarId: (string)

  specify in which calendar to create this event

  Example:

  calendaring.Calendar%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "EventBatch",
    "type": "array",
    "Items": {
        "type": "event"
    }
}

Example:

[
  {
    "displayName": "Display Name of this Event",
    "description": "The description of this Event",
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "sequestered": false,
    "locationDescription": "This is the LocationDescription",
    "locationId": "mapping.Location:1880@base.url",
    "sponsorIds": [ "resource.Resource:9625@base.url", "..." ]
  },
  {
    "...": "..."
  }
]

Query Parameters

• genusType: (string)

  specify a particular event type to create

  Example:

  type.Type%3AexampleEventType%40dxtera.org

• recordType: (array of )

  specify support for one or more event record types

  Example:

  [
    "type.Type%3AexampleEventRecordType%40campusapi.org",
    "..."
  ]

• calendarId: (string)

  specify in which calendar to create this event

  Example:

  calendaring.Calendar%3A8374%40base.url

URI Parameters

• eventId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "location", "sponsors", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• eventId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "EventItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this event. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this event. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this event for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this event.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this event. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this event. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this event.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this event.",
      "type": "string",
      "format": "date-time"
    },
    "sequestered": {
      "description": "Whether this event is sequestered in that it should not appear outside of its aggregation.",
      "type": "boolean"
    },
    "locationDescription": {
      "description": "A descriptive location.",
      "type": "string"
    },
    "locationId": {
      "description": "The Location.",
      "type": "string",
      "format": "osid-id"
    },
    "sponsorIds": {
      "description": "The Sponsors.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    }
  }
}

Example:

{
  "displayName": "Display Name of this Event",
  "description": "The description of this Event",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "sequestered": false,
  "locationDescription": "This is the LocationDescription",
  "locationId": "mapping.Location:9248@base.url",
  "sponsorIds": [ "resource.Resource:8754@base.url", "..." ]
}

URI Parameters

• eventId: required(string)

URI Parameters

• eventId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "sponsors", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleRecurringEventType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleRecurringEventType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleRecurringEventType%40campusapi.org

• calendarId: (string)

  The id string to match a calendar

  Example:

  calendaring.Calendar%3A8374%40base.url

Query Parameters

• calendarId: (string)

  specify in which calendar to create this recurringEvent

  Example:

  calendaring.Calendar%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "RecurringEvent",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this recurring event. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this recurring event. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this recurring event for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this recurring event.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this recurring event. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this recurring event. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this recurring event is active. Active is true if operational is true and disabled is false, or enabled is true.",
      "type": "boolean",
      "readOnly": true
    },
    "enabled": {
      "description": "Whether this recurring event is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this recurring event is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this recurring event is operational. This recurring event is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this recurring event.",
      "type": "string",
      "format": "osid-id"
    },
    "sequestered": {
      "description": "Whether this recurring event is sequestered in that it should not appear outside of its aggregation.",
      "type": "boolean"
    },
    "sponsorIds": {
      "description": "The Sponsors.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    }
  }
}

Example:

{
  "displayName": "Display Name of this RecurringEvent",
  "description": "The description of this RecurringEvent",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "sequestered": false,
  "sponsorIds": [ "resource.Resource:3079@base.url", "..." ]
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "sponsors", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "RecurringEventQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchRuleIds": {
      "description": "List of rule Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSequestered": {
      "description": "Match containables that are sequestered.  true to match any sequestered containables, false to match non-sequestered containables",
      "type": "boolean"
    },
    "matchSponsorIds": {
      "description": "List of Resource Ids for this query to match sponsor.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "sponsorQueries": {
      "description": "resource.ResourceQueries to match the Sponsor. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchAnySponsor": {
      "description": "Match sponsor with any value. true to match RecurringEvents with any sponsor, false to match RecurringEvents with no sponsor",
      "type": "boolean"
    },
    "matchCalendarIds": {
      "description": "List of Calendar Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "calendarId": {
            "description": "Calendar id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "calendarQueries": {
      "description": "CalendarQueries to match Calendar. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "calendar-query"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• calendarId: (string)

  specify in which calendar to create this recurringEvent

  Example:

  calendaring.Calendar%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "RecurringEventBatch",
    "type": "array",
    "Items": {
        "type": "recurring-event"
    }
}

Example:

[
  {
    "displayName": "Display Name of this RecurringEvent",
    "description": "The description of this RecurringEvent",
    "active": true,
    "enabled": true,
    "disabled": false,
    "operational": true,
    "ruleId": "rules.Rule:123@base.url",
    "sequestered": false,
    "sponsorIds": [ "resource.Resource:1503@base.url", "..." ]
  },
  {
    "...": "..."
  }
]

Query Parameters

• genusType: (string)

  specify a particular recurringEvent type to create

  Example:

  type.Type%3AexampleRecurringEventType%40dxtera.org

• recordType: (array of )

  specify support for one or more recurringEvent record types

  Example:

  [
    "type.Type%3AexampleRecurringEventRecordType%40campusapi.org",
    "..."
  ]

• calendarId: (string)

  specify in which calendar to create this recurringEvent

  Example:

  calendaring.Calendar%3A8374%40base.url

URI Parameters

• recurringEventId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "sponsors", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• recurringEventId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "RecurringEventItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this recurring event. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this recurring event. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this recurring event for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this recurring event.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this recurring event. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this recurring event. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this recurring event is active. Active is true if operational is true and disabled is false, or enabled is true.",
      "type": "boolean",
      "readOnly": true
    },
    "enabled": {
      "description": "Whether this recurring event is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this recurring event is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this recurring event is operational. This recurring event is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this recurring event.",
      "type": "string",
      "format": "osid-id"
    },
    "sequestered": {
      "description": "Whether this recurring event is sequestered in that it should not appear outside of its aggregation.",
      "type": "boolean"
    },
    "sponsorIds": {
      "description": "The Sponsors.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    }
  }
}

Example:

{
  "displayName": "Display Name of this RecurringEvent",
  "description": "The description of this RecurringEvent",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "sequestered": false,
  "sponsorIds": [ "resource.Resource:2655@base.url", "..." ]
}

URI Parameters

• recurringEventId: required(string)

URI Parameters

• recurringEventId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "supersedingEvent", "supersededEvent", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleSupersedingEventType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleSupersedingEventType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleSupersedingEventType%40campusapi.org

• supersededEventId: (string)

  the id string to match a superseded-event.

  Example:

  calendaring.Event%3A2816%40base.url

• supersedingEventId: (string)

  the id string to match a superseding-event.

  Example:

  calendaring.Event%3A2992%40base.url

• calendarId: (string)

  The id string to match a calendar

  Example:

  calendaring.Calendar%3A8374%40base.url

Query Parameters

• calendarId: (string)

  specify in which calendar to create this supersedingEvent

  Example:

  calendaring.Calendar%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "SupersedingEvent",
  "type": "object",
  "required": ["supersededEventId", "supersedingEventId"],
  "properties": {
    "id": {
      "description": "The unique id of this superseding event. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this superseding event. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this superseding event for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this superseding event.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this superseding event. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this superseding event. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this superseding event is active. Active is true if operational is true and disabled is false, or enabled is true.",
      "type": "boolean",
      "readOnly": true
    },
    "enabled": {
      "description": "Whether this superseding event is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this superseding event is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this superseding event is operational. This superseding event is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this superseding event.",
      "type": "string",
      "format": "osid-id"
    },
    "supersededEventId": {
      "description": "The superseded event associated with this superseding event.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "supersedingEventId": {
      "description": "The superseding event associated with this superseding event.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "supersededDate": {
      "description": "The date of an event to replace if a recurring event is offered on that date.",
      "type": "string",
      "format": "date-time"
    },
    "supersededEventPosition": {
      "description": "The position in the denormalized recurring series of the event to replace.",
      "type": "integer"
    }
  }
}

Example:

{
  "displayName": "Display Name of this SupersedingEvent",
  "description": "The description of this SupersedingEvent",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "supersededEventId": "calendaring.Event:5201@base.url",
  "supersededDate": "2021-07-21T23:15:30.000Z",
  "supersedingEventId": "calendaring.Event:3402@base.url",
  "supersededEventPosition": 19
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "supersedingEvent", "supersededEvent", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "SupersedingEventQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchRuleIds": {
      "description": "List of rule Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSupersededEventIds": {
      "description": "List of supersededEvent Ids for this query to match superseding event that have a related supersededEvent.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "supersededEventQueries": {
      "description": "SupersededEventQueries to match the supersededEvent. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "event-query"
      }
    },
    "matchSupersedingEventIds": {
      "description": "List of supersedingEvent Ids for this query to match superseding event that have a related supersedingEvent.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "supersedingEventQueries": {
      "description": "SupersedingEventQueries to match the supersedingEvent. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "event-query"
      }
    },
    "matchSupersededDate": {
      "description": "Matches supersededDates between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnySupersededDate": {
      "description": "Match supersededDates with any value. true to match SupersedingEvents with any superseded date, false to match ProgramOfferings with no superseded date",
      "type": "boolean"
    },
    "matchSupersededEventPosition": {
      "description": "Match SupersedingEvents with supersededEventPositions between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnySupersededEventPosition": {
      "description": "Match supersededEventPositions with any value. true to match SupersedingEvents with any superseded event position, false to match ProgramOfferings with no superseded event position",
      "type": "boolean"
    },
    "matchCalendarIds": {
      "description": "List of Calendar Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "calendarId": {
            "description": "Calendar id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "calendarQueries": {
      "description": "CalendarQueries to match Calendar. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "calendar-query"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• calendarId: (string)

  specify in which calendar to create this supersedingEvent

  Example:

  calendaring.Calendar%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "SupersedingEventBatch",
    "type": "array",
    "Items": {
        "type": "superseding-event"
    }
}

Example:

[
  {
    "displayName": "Display Name of this SupersedingEvent",
    "description": "The description of this SupersedingEvent",
    "active": true,
    "enabled": true,
    "disabled": false,
    "operational": true,
    "ruleId": "rules.Rule:123@base.url",
    "supersededDate": "2021-07-21T23:15:30.000Z",
    "supersededEventPosition": 19
  },
  {
    "...": "..."
  }
]

Query Parameters

• supersededEventId: required(string)

  the superseded-event of this metadatum.

  Example:

  calendaring.Event%3A2816%40base.url

• supersedingEventId: required(string)

  the superseding-event of this metadatum.

  Example:

  calendaring.Event%3A2992%40base.url

• genusType: (string)

  specify a particular supersedingEvent type to create

  Example:

  type.Type%3AexampleSupersedingEventType%40dxtera.org

• recordType: (array of )

  specify support for one or more supersedingEvent record types

  Example:

  [
    "type.Type%3AexampleSupersedingEventRecordType%40campusapi.org",
    "..."
  ]

• calendarId: (string)

  specify in which calendar to create this supersedingEvent

  Example:

  calendaring.Calendar%3A8374%40base.url

URI Parameters

• supersedingEventId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "supersedingEvent", "supersededEvent", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• supersedingEventId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "SupersedingEventItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this superseding event. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this superseding event. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this superseding event for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this superseding event.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this superseding event. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this superseding event. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this superseding event is active. Active is true if operational is true and disabled is false, or enabled is true.",
      "type": "boolean",
      "readOnly": true
    },
    "enabled": {
      "description": "Whether this superseding event is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this superseding event is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this superseding event is operational. This superseding event is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this superseding event.",
      "type": "string",
      "format": "osid-id"
    },
    "supersededEventId": {
      "description": "The superseded event associated with this superseding event.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "supersedingEventId": {
      "description": "The superseding event associated with this superseding event.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "supersededDate": {
      "description": "The date of an event to replace if a recurring event is offered on that date.",
      "type": "string",
      "format": "date-time"
    },
    "supersededEventPosition": {
      "description": "The position in the denormalized recurring series of the event to replace.",
      "type": "integer"
    }
  }
}

Example:

{
  "displayName": "Display Name of this SupersedingEvent",
  "description": "The description of this SupersedingEvent",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "supersededDate": "2021-07-21T23:15:30.000Z",
  "supersededEventPosition": 19
}

URI Parameters

• supersedingEventId: required(string)

URI Parameters

• supersedingEventId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "startReferenceEvent", "endReferenceEvent", "location", "sponsors", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleOffsetEventType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleOffsetEventType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleOffsetEventType%40campusapi.org

• calendarId: (string)

  The id string to match a calendar

  Example:

  calendaring.Calendar%3A8374%40base.url

Query Parameters

• calendarId: (string)

  specify in which calendar to create this offsetEvent

  Example:

  calendaring.Calendar%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "OffsetEvent",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this offset event. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this offset event. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this offset event for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this offset event.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this offset event. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this offset event. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this offset event is active. Active is true if operational is true and disabled is false, or enabled is true.",
      "type": "boolean",
      "readOnly": true
    },
    "enabled": {
      "description": "Whether this offset event is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this offset event is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this offset event is operational. This offset event is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this offset event.",
      "type": "string",
      "format": "osid-id"
    },
    "fixedStartTime": {
      "description": "The fixed start time for this event.",
      "type": "string",
      "format": "date-time"
    },
    "startReferenceEventId": {
      "description": "The Event to which the start of this event is offset.",
      "type": "string",
      "format": "osid-id"
    },
    "fixedStartOffset": {
      "description": "The fixed starting time offset.",
      "type": "string",
      "format": "duration"
    },
    "relativeWeekdayStartOffset": {
      "description": "The starting offset as the nth weekday from the relative event.",
      "type": "integer"
    },
    "relativeStartWeekday": {
      "description": "The starting weekday number.",
      "type": "integer",
      "minimum": 1
    },
    "fixedDuration": {
      "description": "The duration of the offset event.",
      "type": "string",
      "format": "duration"
    },
    "endReferenceEventId": {
      "description": "The Event to which the end of this event is offset.",
      "type": "string",
      "format": "osid-id"
    },
    "fixedEndOffset": {
      "description": "The fixed ending time offset.",
      "type": "string",
      "format": "duration"
    },
    "relativeWeekdayEndOffset": {
      "description": "The ending offset as the nth weekday from the relative event.",
      "type": "integer"
    },
    "relativeEndWeekday": {
      "description": "The ending weekday number.",
      "type": "integer",
      "minimum": 1
    },
    "locationDescription": {
      "description": "A descriptive location.",
      "type": "string"
    },
    "locationId": {
      "description": "The Location.",
      "type": "string",
      "format": "osid-id"
    },
    "sponsorIds": {
      "description": "The Sponsors.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    }
  }
}

Example:

{
  "displayName": "Display Name of this OffsetEvent",
  "description": "The description of this OffsetEvent",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "fixedStartTime": "2020-10-03T08:00:00.000Z",
  "startReferenceEventId": "calendaring.Event:4601@base.url",
  "fixedStartOffset": "P3DT3H",
  "relativeWeekdayStartOffset": 19,
  "relativeStartWeekday": 19,
  "fixedDuration": "P3DT3H",
  "endReferenceEventId": "calendaring.Event:1465@base.url",
  "fixedEndOffset": "P3DT3H",
  "relativeWeekdayEndOffset": 19,
  "relativeEndWeekday": 19,
  "locationDescription": "This is the LocationDescription",
  "locationId": "mapping.Location:7339@base.url",
  "sponsorIds": [ "resource.Resource:1483@base.url", "..." ]
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "startReferenceEvent", "endReferenceEvent", "location", "sponsors", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "OffsetEventQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchActive": {
      "description": "Matches active. true to match active, false to match inactive",
      "type": "boolean"
    },
    "matchEnabled": {
      "description": "Matches administratively enabled. true to match administratively enabled, false otherwise",
      "type": "boolean"
    },
    "matchDisabled": {
      "description": "Matches administratively disabled. true to match administratively disabled, false otherwise",
      "type": "boolean"
    },
    "matchOperational": {
      "description": "Matches operational operables. true to match operational, false to match not operational",
      "type": "boolean"
    },
    "matchRuleIds": {
      "description": "List of rule Ids to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchFixedStartTime": {
      "description": "Matches fixedStartTimes between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyFixedStartTime": {
      "description": "Match fixedStartTimes with any value. true to match OffsetEvents with any fixed start time, false to match ProgramOfferings with no fixed start time",
      "type": "boolean"
    },
    "matchStartReferenceEventIds": {
      "description": "List of Event Ids for this query to match startReferenceEvent.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "startReferenceEventId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "startReferenceEventQueries": {
      "description": "calendaring.EventQueries to match the Start Reference Event. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "event-query"
      }
    },
    "matchAnyStartReferenceEvent": {
      "description": "Match start reference event with any value. true to match OffsetEvents with any start reference event, false to match OffsetEvents with no start reference event",
      "type": "boolean"
    },
    "matchFixedStartOffset": {
      "description": "Matches fixedStartOffsets in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyFixedStartOffset": {
      "description": "Match fixedStartOffsets with any value. true to match OffsetEvents with any fixed start offset, false to match ProgramOfferings with no fixed start offset",
      "type": "boolean"
    },
    "matchRelativeWeekdayStartOffset": {
      "description": "Match OffsetEvents with relativeWeekdayStartOffsets between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyRelativeWeekdayStartOffset": {
      "description": "Match relativeWeekdayStartOffsets with any value. true to match OffsetEvents with any relative weekday start offset, false to match ProgramOfferings with no relative weekday start offset",
      "type": "boolean"
    },
    "matchRelativeStartWeekday": {
      "description": "Match OffsetEvents with relativeStartWeekdays between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyRelativeStartWeekday": {
      "description": "Match relativeStartWeekdays with any value. true to match OffsetEvents with any relative start weekday, false to match ProgramOfferings with no relative start weekday",
      "type": "boolean"
    },
    "matchFixedDuration": {
      "description": "Matches fixedDurations in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyFixedDuration": {
      "description": "Match fixedDurations with any value. true to match OffsetEvents with any fixed duration, false to match ProgramOfferings with no fixed duration",
      "type": "boolean"
    },
    "matchEndReferenceEventIds": {
      "description": "List of Event Ids for this query to match endReferenceEvent.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "endReferenceEventId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "endReferenceEventQueries": {
      "description": "calendaring.EventQueries to match the End Reference Event. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "event-query"
      }
    },
    "matchAnyEndReferenceEvent": {
      "description": "Match end reference event with any value. true to match OffsetEvents with any end reference event, false to match OffsetEvents with no end reference event",
      "type": "boolean"
    },
    "matchFixedEndOffset": {
      "description": "Matches fixedEndOffsets in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyFixedEndOffset": {
      "description": "Match fixedEndOffsets with any value. true to match OffsetEvents with any fixed end offset, false to match ProgramOfferings with no fixed end offset",
      "type": "boolean"
    },
    "matchRelativeWeekdayEndOffset": {
      "description": "Match OffsetEvents with relativeWeekdayEndOffsets between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyRelativeWeekdayEndOffset": {
      "description": "Match relativeWeekdayEndOffsets with any value. true to match OffsetEvents with any relative weekday end offset, false to match ProgramOfferings with no relative weekday end offset",
      "type": "boolean"
    },
    "matchRelativeEndWeekday": {
      "description": "Match OffsetEvents with relativeEndWeekdays between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyRelativeEndWeekday": {
      "description": "Match relativeEndWeekdays with any value. true to match OffsetEvents with any relative end weekday, false to match ProgramOfferings with no relative end weekday",
      "type": "boolean"
    },
    "matchLocationDescription": {
      "description": "List of LocationDescription strings to match. Boolean OR performed among multiple locationDescriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "locationDescriptions": {
            "description": "locationDescriptions to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyLocationDescription": {
      "description": "Match locationDescriptions with any value. true to match OffsetEvents with any location description, false to match ProgramOfferings with no location description",
      "type": "boolean"
    },
    "matchLocationIds": {
      "description": "List of Location Ids for this query to match location.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "locationId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "locationQueries": {
      "description": "mapping.LocationQueries to match the Location. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "location-query"
      }
    },
    "matchAnyLocation": {
      "description": "Match location with any value. true to match OffsetEvents with any location, false to match OffsetEvents with no location",
      "type": "boolean"
    },
    "matchSponsorIds": {
      "description": "List of Resource Ids for this query to match sponsor.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "sponsorQueries": {
      "description": "resource.ResourceQueries to match the Sponsor. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchAnySponsor": {
      "description": "Match sponsor with any value. true to match OffsetEvents with any sponsor, false to match OffsetEvents with no sponsor",
      "type": "boolean"
    },
    "matchCalendarIds": {
      "description": "List of Calendar Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "calendarId": {
            "description": "Calendar id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "calendarQueries": {
      "description": "CalendarQueries to match Calendar. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "calendar-query"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• calendarId: (string)

  specify in which calendar to create this offsetEvent

  Example:

  calendaring.Calendar%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "OffsetEventBatch",
    "type": "array",
    "Items": {
        "type": "offset-event"
    }
}

Example:

[
  {
    "displayName": "Display Name of this OffsetEvent",
    "description": "The description of this OffsetEvent",
    "active": true,
    "enabled": true,
    "disabled": false,
    "operational": true,
    "ruleId": "rules.Rule:123@base.url",
    "fixedStartTime": "2020-10-03T08:00:00.000Z",
    "startReferenceEventId": "calendaring.Event:5830@base.url",
    "fixedStartOffset": "P3DT3H",
    "relativeWeekdayStartOffset": 19,
    "relativeStartWeekday": 19,
    "fixedDuration": "P3DT3H",
    "endReferenceEventId": "calendaring.Event:4245@base.url",
    "fixedEndOffset": "P3DT3H",
    "relativeWeekdayEndOffset": 19,
    "relativeEndWeekday": 19,
    "locationDescription": "This is the LocationDescription",
    "locationId": "mapping.Location:3002@base.url",
    "sponsorIds": [ "resource.Resource:8874@base.url", "..." ]
  },
  {
    "...": "..."
  }
]

Query Parameters

• genusType: (string)

  specify a particular offsetEvent type to create

  Example:

  type.Type%3AexampleOffsetEventType%40dxtera.org

• recordType: (array of )

  specify support for one or more offsetEvent record types

  Example:

  [
    "type.Type%3AexampleOffsetEventRecordType%40campusapi.org",
    "..."
  ]

• calendarId: (string)

  specify in which calendar to create this offsetEvent

  Example:

  calendaring.Calendar%3A8374%40base.url

URI Parameters

• offsetEventId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "rule", "startReferenceEvent", "endReferenceEvent", "location", "sponsors", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• offsetEventId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "OffsetEventItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this offset event. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this offset event. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this offset event for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this offset event.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this offset event. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this offset event. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "active": {
      "description": "Whether this offset event is active. Active is true if operational is true and disabled is false, or enabled is true.",
      "type": "boolean",
      "readOnly": true
    },
    "enabled": {
      "description": "Whether this offset event is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "disabled": {
      "description": "Whether this offset event is administravely enabled. Administratively enabling overrides any applied enabler.",
      "type": "boolean"
    },
    "operational": {
      "description": "Whether this offset event is operational. This offset event is operational if any of the applied enablers are true.",
      "type": "boolean",
      "readOnly": true
    },
    "ruleId": {
      "description": "An explicit Rule for this offset event.",
      "type": "string",
      "format": "osid-id"
    },
    "fixedStartTime": {
      "description": "The fixed start time for this event.",
      "type": "string",
      "format": "date-time"
    },
    "startReferenceEventId": {
      "description": "The Event to which the start of this event is offset.",
      "type": "string",
      "format": "osid-id"
    },
    "fixedStartOffset": {
      "description": "The fixed starting time offset.",
      "type": "string",
      "format": "duration"
    },
    "relativeWeekdayStartOffset": {
      "description": "The starting offset as the nth weekday from the relative event.",
      "type": "integer"
    },
    "relativeStartWeekday": {
      "description": "The starting weekday number.",
      "type": "integer",
      "minimum": 1
    },
    "fixedDuration": {
      "description": "The duration of the offset event.",
      "type": "string",
      "format": "duration"
    },
    "endReferenceEventId": {
      "description": "The Event to which the end of this event is offset.",
      "type": "string",
      "format": "osid-id"
    },
    "fixedEndOffset": {
      "description": "The fixed ending time offset.",
      "type": "string",
      "format": "duration"
    },
    "relativeWeekdayEndOffset": {
      "description": "The ending offset as the nth weekday from the relative event.",
      "type": "integer"
    },
    "relativeEndWeekday": {
      "description": "The ending weekday number.",
      "type": "integer",
      "minimum": 1
    },
    "locationDescription": {
      "description": "A descriptive location.",
      "type": "string"
    },
    "locationId": {
      "description": "The Location.",
      "type": "string",
      "format": "osid-id"
    },
    "sponsorIds": {
      "description": "The Sponsors.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    }
  }
}

Example:

{
  "displayName": "Display Name of this OffsetEvent",
  "description": "The description of this OffsetEvent",
  "active": true,
  "enabled": true,
  "disabled": false,
  "operational": true,
  "ruleId": "rules.Rule:123@base.url",
  "fixedStartTime": "2020-10-03T08:00:00.000Z",
  "startReferenceEventId": "calendaring.Event:5362@base.url",
  "fixedStartOffset": "P3DT3H",
  "relativeWeekdayStartOffset": 19,
  "relativeStartWeekday": 19,
  "fixedDuration": "P3DT3H",
  "endReferenceEventId": "calendaring.Event:3061@base.url",
  "fixedEndOffset": "P3DT3H",
  "relativeWeekdayEndOffset": 19,
  "relativeEndWeekday": 19,
  "locationDescription": "This is the LocationDescription",
  "locationId": "mapping.Location:5190@base.url",
  "sponsorIds": [ "resource.Resource:9487@base.url", "..." ]
}

URI Parameters

• offsetEventId: required(string)

URI Parameters

• offsetEventId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "scheduleSlot", "timePeriod", "location", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleScheduleType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleScheduleType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleScheduleType%40campusapi.org

• calendarId: (string)

  The id string to match a calendar

  Example:

  calendaring.Calendar%3A8374%40base.url

Query Parameters

• calendarId: (string)

  specify in which calendar to create this schedule

  Example:

  calendaring.Calendar%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Schedule",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this schedule. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this schedule. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this schedule for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this schedule.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this schedule. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this schedule. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "scheduleSlotId": {
      "description": "The schedule slot included inside this one.",
      "type": "string",
      "format": "osid-id"
    },
    "timePeriodId": {
      "description": "The TimePeriod for this recurring event.",
      "type": "string",
      "format": "osid-id"
    },
    "scheduleStart": {
      "description": "The start date of this schedule.",
      "type": "string",
      "format": "date-time"
    },
    "scheduleEnd": {
      "description": "The end date of this schedule.",
      "type": "string",
      "format": "date-time"
    },
    "limit": {
      "description": "The limit of the number of occurences of this schedule.",
      "type": "array",
      "minimum": 1
    },
    "locationId": {
      "description": "The Location.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Schedule",
  "description": "The description of this Schedule",
  "scheduleSlotId": "calendaring.ScheduleSlot:8082@base.url",
  "timePeriodId": "calendaring.TimePeriod:7682@base.url",
  "scheduleStart": "2020-10-03T08:00:00.000Z",
  "scheduleEnd": "2020-12-18T17:00:00.000Z",
  "limit": [ "..cardinal[]..", "..." ],
  "locationDescription": "This is the LocationDescription",
  "locationId": "mapping.Location:2527@base.url"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "scheduleSlot", "timePeriod", "location", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ScheduleQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchScheduleSlotIds": {
      "description": "List of ScheduleSlot Ids for this query to match scheduleSlot.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "scheduleSlotId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "scheduleSlotQueries": {
      "description": "calendaring.ScheduleSlotQueries to match the Schedule Slot. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "schedule-slot-query"
      }
    },
    "matchAnyScheduleSlot": {
      "description": "Match schedule slot with any value. true to match Schedules with any schedule slot, false to match Schedules with no schedule slot",
      "type": "boolean"
    },
    "matchTimePeriodIds": {
      "description": "List of TimePeriod Ids for this query to match timePeriod.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "timePeriodId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "timePeriodQueries": {
      "description": "calendaring.TimePeriodQueries to match the Time Period. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "time-period-query"
      }
    },
    "matchAnyTimePeriod": {
      "description": "Match time period with any value. true to match Schedules with any time period, false to match Schedules with no time period",
      "type": "boolean"
    },
    "matchScheduleStart": {
      "description": "Matches scheduleStarts between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyScheduleStart": {
      "description": "Match scheduleStarts with any value. true to match Schedules with any schedule start, false to match ProgramOfferings with no schedule start",
      "type": "boolean"
    },
    "matchScheduleEnd": {
      "description": "Matches scheduleEnds between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyScheduleEnd": {
      "description": "Match scheduleEnds with any value. true to match Schedules with any schedule end, false to match ProgramOfferings with no schedule end",
      "type": "boolean"
    },
    "matchLimit": {
      "description": "Match Schedules with limits between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyLimit": {
      "description": "Match limits with any value. true to match Schedules with any limit, false to match ProgramOfferings with no limit",
      "type": "boolean"
    },
    "matchLocationIds": {
      "description": "List of Location Ids for this query to match location.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "locationId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "locationQueries": {
      "description": "mapping.LocationQueries to match the Location. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "location-query"
      }
    },
    "matchAnyLocation": {
      "description": "Match location with any value. true to match Schedules with any location, false to match Schedules with no location",
      "type": "boolean"
    },
    "matchCalendarIds": {
      "description": "List of Calendar Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "calendarId": {
            "description": "Calendar id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "calendarQueries": {
      "description": "CalendarQueries to match Calendar. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "calendar-query"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• calendarId: (string)

  specify in which calendar to create this schedule

  Example:

  calendaring.Calendar%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "ScheduleBatch",
    "type": "array",
    "Items": {
        "type": "schedule"
    }
}

Example:

[
  {
    "displayName": "Display Name of this Schedule",
    "description": "The description of this Schedule",
    "scheduleSlotId": "calendaring.ScheduleSlot:4392@base.url",
    "timePeriodId": "calendaring.TimePeriod:9031@base.url",
    "scheduleStart": "2020-10-03T08:00:00.000Z",
    "scheduleEnd": "2020-12-18T17:00:00.000Z",
    "limit": [ "..cardinal[]..", "..." ],
    "locationDescription": "This is the LocationDescription",
    "locationId": "mapping.Location:1162@base.url"
  },
  {
    "...": "..."
  }
]

Query Parameters

• genusType: (string)

  specify a particular schedule type to create

  Example:

  type.Type%3AexampleScheduleType%40dxtera.org

• recordType: (array of )

  specify support for one or more schedule record types

  Example:

  [
    "type.Type%3AexampleScheduleRecordType%40campusapi.org",
    "..."
  ]

• calendarId: (string)

  specify in which calendar to create this schedule

  Example:

  calendaring.Calendar%3A8374%40base.url

URI Parameters

• scheduleId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "scheduleSlot", "timePeriod", "location", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• scheduleId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ScheduleItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this schedule. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this schedule. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this schedule for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this schedule.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this schedule. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this schedule. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "scheduleSlotId": {
      "description": "The schedule slot included inside this one.",
      "type": "string",
      "format": "osid-id"
    },
    "timePeriodId": {
      "description": "The TimePeriod for this recurring event.",
      "type": "string",
      "format": "osid-id"
    },
    "scheduleStart": {
      "description": "The start date of this schedule.",
      "type": "string",
      "format": "date-time"
    },
    "scheduleEnd": {
      "description": "The end date of this schedule.",
      "type": "string",
      "format": "date-time"
    },
    "limit": {
      "description": "The limit of the number of occurences of this schedule.",
      "type": "array",
      "minimum": 1
    },
    "locationId": {
      "description": "The Location.",
      "type": "string",
      "format": "osid-id"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Schedule",
  "description": "The description of this Schedule",
  "scheduleSlotId": "calendaring.ScheduleSlot:2839@base.url",
  "timePeriodId": "calendaring.TimePeriod:2943@base.url",
  "scheduleStart": "2020-10-03T08:00:00.000Z",
  "scheduleEnd": "2020-12-18T17:00:00.000Z",
  "limit": [ "..cardinal[]..", "..." ],
  "locationDescription": "This is the LocationDescription",
  "locationId": "mapping.Location:2451@base.url"
}

URI Parameters

• scheduleId: required(string)

URI Parameters

• scheduleId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleScheduleSlotType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleScheduleSlotType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleScheduleSlotType%40campusapi.org

• calendarId: (string)

  The id string to match a calendar

  Example:

  calendaring.Calendar%3A8374%40base.url

Query Parameters

• calendarId: (string)

  specify in which calendar to create this scheduleSlot

  Example:

  calendaring.Calendar%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ScheduleSlot",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this schedule slot. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this schedule slot. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this schedule slot for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this schedule slot.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this schedule slot. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this schedule slot. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "sequestered": {
      "description": "Whether this schedule slot is sequestered in that it should not appear outside of its aggregation.",
      "type": "boolean"
    },
    "weekday": {
      "description": "-- could someone please write a description for this --",
      "type": "array",
      "minimum": 1
    },
    "weeklyInterval": {
      "description": "The number of weeks of the interval.",
      "type": "integer"
    },
    "weekOfMonth": {
      "description": "The week of the month for the interval.",
      "type": "integer"
    },
    "weekdayTime": {
      "description": "The time of this recurring schedule.",
      "type": "string",
      "format": "time"
    },
    "fixedInterval": {
      "description": "The repeating interval.",
      "type": "string",
      "format": "duration"
    },
    "duration": {
      "description": "The duration of the schedule slot.",
      "type": "string",
      "format": "duration"
    }
  }
}

Example:

{
  "displayName": "Display Name of this ScheduleSlot",
  "description": "The description of this ScheduleSlot",
  "sequestered": false,
  "weekdays": [ "..cardinal[]..", "..." ],
  "weeklyInterval": 19,
  "weekOfMonth": 19,
  "weekdayTime": "..Time..",
  "fixedInterval": "P3DT3H",
  "duration": "P3DT3H"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ScheduleSlotQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchSequestered": {
      "description": "Match containables that are sequestered.  true to match any sequestered containables, false to match non-sequestered containables",
      "type": "boolean"
    },
    "matchWeekday": {
      "description": "Match ScheduleSlots with weekdays between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyWeekday": {
      "description": "Match weekdays with any value. true to match ScheduleSlots with any weekday, false to match ProgramOfferings with no weekday",
      "type": "boolean"
    },
    "matchWeeklyInterval": {
      "description": "Match ScheduleSlots with weeklyIntervals between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyWeeklyInterval": {
      "description": "Match weeklyIntervals with any value. true to match ScheduleSlots with any weekly interval, false to match ProgramOfferings with no weekly interval",
      "type": "boolean"
    },
    "matchWeekOfMonth": {
      "description": "Match ScheduleSlots with weekOfMonths between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyWeekOfMonth": {
      "description": "Match weekOfMonths with any value. true to match ScheduleSlots with any week of month, false to match ProgramOfferings with no week of month",
      "type": "boolean"
    },
    "matchWeekdayTime": {
      "description": "Matches weekdayTimes between the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "time"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyWeekdayTime": {
      "description": "Match weekdayTimes with any value. true to match ScheduleSlots with any weekday time, false to match ProgramOfferings with no weekday time",
      "type": "boolean"
    },
    "matchFixedInterval": {
      "description": "Matches fixedIntervals in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyFixedInterval": {
      "description": "Match fixedIntervals with any value. true to match ScheduleSlots with any fixed interval, false to match ProgramOfferings with no fixed interval",
      "type": "boolean"
    },
    "matchDuration": {
      "description": "Matches durations in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyDuration": {
      "description": "Match durations with any value. true to match ScheduleSlots with any duration, false to match ProgramOfferings with no duration",
      "type": "boolean"
    },
    "matchCalendarIds": {
      "description": "List of Calendar Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "calendarId": {
            "description": "Calendar id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "calendarQueries": {
      "description": "CalendarQueries to match Calendar. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "calendar-query"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• calendarId: (string)

  specify in which calendar to create this scheduleSlot

  Example:

  calendaring.Calendar%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "ScheduleSlotBatch",
    "type": "array",
    "Items": {
        "type": "schedule-slot"
    }
}

Example:

[
  {
    "displayName": "Display Name of this ScheduleSlot",
    "description": "The description of this ScheduleSlot",
    "sequestered": false,
    "weekdays": [ "..cardinal[]..", "..." ],
    "weeklyInterval": 19,
    "weekOfMonth": 19,
    "weekdayTime": "..Time..",
    "fixedInterval": "P3DT3H",
    "duration": "P3DT3H"
  },
  {
    "...": "..."
  }
]

Query Parameters

• genusType: (string)

  specify a particular scheduleSlot type to create

  Example:

  type.Type%3AexampleScheduleSlotType%40dxtera.org

• recordType: (array of )

  specify support for one or more scheduleSlot record types

  Example:

  [
    "type.Type%3AexampleScheduleSlotRecordType%40campusapi.org",
    "..."
  ]

• calendarId: (string)

  specify in which calendar to create this scheduleSlot

  Example:

  calendaring.Calendar%3A8374%40base.url

URI Parameters

• scheduleSlotId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• scheduleSlotId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ScheduleSlotItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this schedule slot. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this schedule slot. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this schedule slot for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this schedule slot.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this schedule slot. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this schedule slot. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "sequestered": {
      "description": "Whether this schedule slot is sequestered in that it should not appear outside of its aggregation.",
      "type": "boolean"
    },
    "weekday": {
      "description": "-- could someone please write a description for this --",
      "type": "array",
      "minimum": 1
    },
    "weeklyInterval": {
      "description": "The number of weeks of the interval.",
      "type": "integer"
    },
    "weekOfMonth": {
      "description": "The week of the month for the interval.",
      "type": "integer"
    },
    "weekdayTime": {
      "description": "The time of this recurring schedule.",
      "type": "string",
      "format": "time"
    },
    "fixedInterval": {
      "description": "The repeating interval.",
      "type": "string",
      "format": "duration"
    },
    "duration": {
      "description": "The duration of the schedule slot.",
      "type": "string",
      "format": "duration"
    }
  }
}

Example:

{
  "displayName": "Display Name of this ScheduleSlot",
  "description": "The description of this ScheduleSlot",
  "sequestered": false,
  "weekdays": [ "..cardinal[]..", "..." ],
  "weeklyInterval": 19,
  "weekOfMonth": 19,
  "weekdayTime": "..Time..",
  "fixedInterval": "P3DT3H",
  "duration": "P3DT3H"
}

URI Parameters

• scheduleSlotId: required(string)

URI Parameters

• scheduleSlotId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "event", "resource", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleCommitmentType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCommitmentType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCommitmentType%40campusapi.org

• fromDate: (string)

  Get all commitments from this date inclusive. Use with toDate to define date range query.

  Example:

  2020-10-03

• toDate: (string)

  Get all commitments up to this date inclusive. Use with fromDate to define date range query.

  Example:

  2020-12-18

• eventId: (string)

  the id string to match a event.

  Example:

  calendaring.Event%3A550%40base.url

• resourceId: (string)

  the id string to match a resource.

  Example:

  resource.Resource%3A640%40base.url

• calendarId: (string)

  The id string to match a calendar

  Example:

  calendaring.Calendar%3A8374%40base.url

Query Parameters

• calendarId: (string)

  specify in which calendar to create this commitment

  Example:

  calendaring.Calendar%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Commitment",
  "type": "object",
  "required": ["eventId", "resourceId"],
  "properties": {
    "id": {
      "description": "The unique id of this commitment. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this commitment. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this commitment for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this commitment.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this commitment. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this commitment. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this commitment.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this commitment.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this commitment ended.",
      "type": "string",
      "format": "osid-id"
    },
    "eventId": {
      "description": "The event associated with this commitment.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "resourceId": {
      "description": "The resource associated with this commitment.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    }
  }
}

Example:

{
  "displayName": "Display Name of this Commitment",
  "description": "The description of this Commitment",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:179@base.url",
  "eventId": "calendaring.Event:6484@base.url",
  "resourceId": "resource.Resource:5549@base.url"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "event", "resource", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CommitmentQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchEffective": {
      "description": "Match effective objects where the current date falls within the start and end dates inclusive. true to match any effective, false to match ineffective",
      "type": "boolean"
    },
    "matchStartDate": {
      "description": "Matches temporals whose start date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndDate": {
      "description": "Matches temporals whose end date falls in between the given dates inclusive.",
      "type": "object",
      "properties": {
        "start": {
          "description": "start of date range",
          "type": "string",
          "format": "date-time"
        },
        "end": {
          "description": "end of date range",
          "type": "string",
          "format": "date-time"
        },
        "match": {
          "description": "true if a positive match, false for negative match",
          "type": "boolean"
        }
      }
    },
    "matchEndReasonIds": {
      "description": "List of end reason Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "stateId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "endReasonQueries": {
      "description": "process.StateQueries to match end reason state. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchAnyEndReason": {
      "description": "Match end reasons with any value. true to match Commitments with any end reason, false to match Commitments with no end reason",
      "type": "boolean"
    },
    "matchEventIds": {
      "description": "List of event Ids for this query to match commitment that have a related event.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "eventQueries": {
      "description": "EventQueries to match the event. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "event-query"
      }
    },
    "matchResourceIds": {
      "description": "List of resource Ids for this query to match commitment that have a related resource.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ruleId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "resourceQueries": {
      "description": "ResourceQueries to match the resource. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "resource-query"
      }
    },
    "matchCalendarIds": {
      "description": "List of Calendar Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "calendarId": {
            "description": "Calendar id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "calendarQueries": {
      "description": "CalendarQueries to match Calendar. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "calendar-query"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• calendarId: (string)

  specify in which calendar to create this commitment

  Example:

  calendaring.Calendar%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "CommitmentBatch",
    "type": "array",
    "Items": {
        "type": "commitment"
    }
}

Example:

[
  {
    "displayName": "Display Name of this Commitment",
    "description": "The description of this Commitment",
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "endReasonId": "process.State:9000@base.url"
  },
  {
    "...": "..."
  }
]

Query Parameters

• eventId: required(string)

  the event of this metadatum.

  Example:

  calendaring.Event%3A550%40base.url

• resourceId: required(string)

  the resource of this metadatum.

  Example:

  resource.Resource%3A640%40base.url

• genusType: (string)

  specify a particular commitment type to create

  Example:

  type.Type%3AexampleCommitmentType%40dxtera.org

• recordType: (array of )

  specify support for one or more commitment record types

  Example:

  [
    "type.Type%3AexampleCommitmentRecordType%40campusapi.org",
    "..."
  ]

• calendarId: (string)

  specify in which calendar to create this commitment

  Example:

  calendaring.Calendar%3A8374%40base.url

URI Parameters

• commitmentId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "endReason", "event", "resource", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• commitmentId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "CommitmentItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this commitment. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this commitment. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this commitment for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this commitment.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this commitment. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this commitment. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "startDate": {
      "description": "The starting date of this commitment.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this commitment.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this commitment ended.",
      "type": "string",
      "format": "osid-id"
    },
    "eventId": {
      "description": "The event associated with this commitment.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "resourceId": {
      "description": "The resource associated with this commitment.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    }
  }
}

Example:

{
  "displayName": "Display Name of this Commitment",
  "description": "The description of this Commitment",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:400@base.url"
}

URI Parameters

• commitmentId: required(string)

URI Parameters

• commitmentId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleTimePeriodType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleTimePeriodType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleTimePeriodType%40campusapi.org

• calendarId: (string)

  The id string to match a calendar

  Example:

  calendaring.Calendar%3A8374%40base.url

Query Parameters

• calendarId: (string)

  specify in which calendar to create this timePeriod

  Example:

  calendaring.Calendar%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "TimePeriod",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this time period. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this time period. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this time period for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this time period.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this time period. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this time period. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "start": {
      "description": "The start time of the time period.",
      "type": "string",
      "format": "date-time"
    },
    "end": {
      "description": "The end time of the time period.",
      "type": "string",
      "format": "date-time"
    }
  }
}

Example:

{
  "displayName": "Display Name of this TimePeriod",
  "description": "The description of this TimePeriod",
  "start": "2020-10-03T08:00:00.000Z",
  "end": "2020-12-18T17:00:00.000Z"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "TimePeriodQuery",
  "type": "object",
  "properties": {
    "matchIds": {
      "description": "List of Ids to match. Boolean OR performed among multiple Ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchKeywords": {
      "description": "List keywords to match. Multiple keywords can be added to perform a boolean OR among them. A keyword may be applied to any of the elements defined in this object such as the display name, description or any attribute defined in or implemented by this object.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyword": {
            "description": "keyword to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDisplayNames": {
      "description": "List of displayName strings to match. Boolean OR performed among multiple displayNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "description": "displayName to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchDescriptions": {
      "description": "List of discription strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "description to match",
            "type": "string"
          },
          "stringMatchType": {
            "description": "the string match type",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchGenusTypeIds": {
      "description": "List of genus type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "genus type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRecordTypeIds": {
      "description": "List of record type ids to match. Boolean OR performed among multiple ids.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "genusTypeid": {
            "description": "record type id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchSubjectIds": {
      "description": "List of Ids to match an object with a relationships to the given subjects.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchJournalEntryIds": {
      "description": "List of Ids match objects that have the given journal entries.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sponsorId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "journalEntryQueries": {
      "description": "journaling.JournalEntryQueries to match journaling information. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "journal-entry-query"
      }
    },
    "matchStart": {
      "description": "Matches starts between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyStart": {
      "description": "Match starts with any value. true to match TimePeriods with any start, false to match ProgramOfferings with no start",
      "type": "boolean"
    },
    "matchEnd": {
      "description": "Matches ends between the given date range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "low": {
            "description": "low date range",
            "type": "string",
            "format": "date-time"
          },
          "high": {
            "description": "high date range",
            "type": "string",
            "format": "date-time"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyEnd": {
      "description": "Match ends with any value. true to match TimePeriods with any end, false to match ProgramOfferings with no end",
      "type": "boolean"
    },
    "matchCalendarIds": {
      "description": "List of Calendar Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "calendarId": {
            "description": "Calendar id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "calendarQueries": {
      "description": "CalendarQueries to match Calendar. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "calendar-query"
      }
    }
  }
}

Example:

{
  "matchDisplayNames": [
    {
      "displayName": "string to exclude",
      "match": false
    }
  ]
}

Query Parameters

• calendarId: (string)

  specify in which calendar to create this timePeriod

  Example:

  calendaring.Calendar%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "TimePeriodBatch",
    "type": "array",
    "Items": {
        "type": "time-period"
    }
}

Example:

[
  {
    "displayName": "Display Name of this TimePeriod",
    "description": "The description of this TimePeriod",
    "start": "2020-10-03T08:00:00.000Z",
    "end": "2020-12-18T17:00:00.000Z"
  },
  {
    "...": "..."
  }
]

Query Parameters

• genusType: (string)

  specify a particular timePeriod type to create

  Example:

  type.Type%3AexampleTimePeriodType%40dxtera.org

• recordType: (array of )

  specify support for one or more timePeriod record types

  Example:

  [
    "type.Type%3AexampleTimePeriodRecordType%40campusapi.org",
    "..."
  ]

• calendarId: (string)

  specify in which calendar to create this timePeriod

  Example:

  calendaring.Calendar%3A8374%40base.url

URI Parameters

• timePeriodId: required(string)

Query Parameters

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

URI Parameters

• timePeriodId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "TimePeriodItem",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this time period. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this time period. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this time period for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this time period.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this time period. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this time period. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "start": {
      "description": "The start time of the time period.",
      "type": "string",
      "format": "date-time"
    },
    "end": {
      "description": "The end time of the time period.",
      "type": "string",
      "format": "date-time"
    }
  }
}

Example:

{
  "displayName": "Display Name of this TimePeriod",
  "description": "The description of this TimePeriod",
  "start": "2020-10-03T08:00:00.000Z",
  "end": "2020-12-18T17:00:00.000Z"
}

URI Parameters

• timePeriodId: required(string)

URI Parameters

• timePeriodId: required(string)

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• keyword: (string)

  The match string for keyword query

  Example:

  Hello%20World

• displayName: (string)

  The match string for displayName query

  Example:

  Hello%20World

• description: (string)

  The match string for description query

  Example:

  Hello%20World

• genusTypeId: (string)

  The id string to match a genusType

  Example:

  type.Type%3AexampleCalendarType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleCalendarType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleCalendarType%40campusapi.org

• providerId: (string)

  Id string to match provider.

  Example:

  resource.Resource%3A3007%40demo.dxtera.org

• eventId: (string)

  Get calendars mapped to this event.

  Example:

  calendaring.Event%3A440%40demo.dxtera.org

• recurringEventId: (string)

  Get calendars mapped to this recurring-event.

  Example:

  calendaring.RecurringEvent%3A1320%40demo.dxtera.org

• supersedingEventId: (string)

  Get calendars mapped to this superseding-event.

  Example:

  calendaring.SupersedingEvent%3A1496%40demo.dxtera.org

• offsetEventId: (string)

  Get calendars mapped to this offset-event.

  Example:

  calendaring.OffsetEvent%3A1056%40demo.dxtera.org

• scheduleId: (string)

  Get calendars mapped to this schedule.

  Example:

  calendaring.Schedule%3A704%40demo.dxtera.org

• scheduleSlotId: (string)

  Get calendars mapped to this schedule-slot.

  Example:

  calendaring.ScheduleSlot%3A1144%40demo.dxtera.org

• timePeriodId: (string)

  Get calendars mapped to this time-period.

  Example:

  calendaring.TimePeriod%3A968%40demo.dxtera.org

• commitmentId: (string)

  Get calendars mapped to this commitment.

  Example:

  calendaring.Commitment%3A880%40demo.dxtera.org

Query Parameters

• genusType: (string)

  specify a particular calendar type to create

  Example:

  type.Type%3AexampleCalendarType%40dxtera.org

• recordType: (array of )

  specify support for one or more calendar record types

  Example:

  [
    "type.Type%3AexampleCalendarRecordType%40campusapi.org",
    "..."
  ]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Calendar",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this calendar. This id is provided solely by the underlying implementation and is not set on POST and cannot be changed. An id included on POST will result in an error.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this calendar. This URI is provided solely by the underlying implementation and is not set on POST and cannot be changed. A uri included on POST will result in an error.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this calendar for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this calendar.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this calendar. Default type set by system unless specified in query parameter.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "recordTypeIds": {
      "description": "Type Ids of record types available on this calendar. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      },
      "readOnly": true
    },
    "providerId": {
      "description": "The provider of this calendar.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this calendar. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this calendar.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Calendar",
  "description": "The description of this Calendar",
  "providerId": "resource.Resource:123@base.url",
  "brandingId": "asset.Asset:Calendar@base.url",
  "license": "The license that applies to this Calendar"
}

Query Parameters

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 10)

  Limit the number of elements on the response

  Example:

  80

• expand: (string)

  Expand object or type for named attribute: "genusType", "recordType", "provider", "branding", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all