CampusAPI Recognition Services API documentation version 0.1.2
Based on OSID version 3.0.0
https://base.url/recognition
Overview
The Recognition services confer Awards onto Resources. The Recognition service may be orchestrated with the Voting service for managing nominees.
This package includes the following entities:
Conferrals
A Conferral is an relationship describing an Award given to one or more recipient Resources.
The award may be for something such as a body of work represnted by an external entity.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this conferral, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this conferral, provided by system. | string(uri) |
| displayName | The name of this conferral for display. | string |
| description | The description of this conferral. | string |
| genusTypeId (read‑only) | Id of the immutable type of this conferral. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this conferral. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| startDate | The starting date of this conferral. | string(date‑time) |
| endDate | The ending date of this conferral. | string(date‑time) |
| endReasonId | The reason this conferral ended. References a process.State object. | string(osid‑id) |
| awardId (read‑only) | The award associated with this conferral. References a recognition.Award object. | string(osid‑id) |
| recipientId (read‑only) | The recipient associated with this conferral. References a resource.Resource object. | string(osid‑id) |
| referenceId | -- could someone please write a description for this -- References an id.Id object | string(osid‑id) |
| convocationId | The convocation (e. References a recognition.Convocation object | string(osid‑id) |
Awards
An Award represents something conferred on to recipient Resources (typically people).
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this award, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this award, provided by system. | string(uri) |
| displayName | The name of this award for display. | string |
| description | The description of this award. | string |
| genusTypeId (read‑only) | Id of the immutable type of this award. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this award. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
Convocations
A Convocation represents an issuing of Conferrals for a managed set of Awards. Convocations also serve to relate the Conferrals to a TimePeriod.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this convocation, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this convocation, provided by system. | string(uri) |
| displayName | The name of this convocation for display. | string |
| description | The description of this convocation. | string |
| genusTypeId (read‑only) | Id of the immutable type of this convocation. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this convocation. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| providerId | The provider of this convocation. References a resource.Resource object. | string(osid‑id) |
| brandingIds | The branding of this convocation. References repository.Asset objects. | string(osid‑id)[] |
| license | The licensing that applies to this convocation. | string |
| active (read‑only) | Whether this convocation is active. Active is true if operational is true and disabled is false, or enabled is true. | boolean |
| enabled | Whether this convocation is administravely enabled. Administratively enabling overrides any applied enabler. | boolean |
| disabled | Whether this convocation is administravely disabled. Administratively disabling overrides any applied enabler. | boolean |
| operational (read‑only) | Whether this convocation is operational. This convocation is operational if any of the applied enablers are true. | boolean |
| awardIds | The awards. References an array of recognition.Award objects. | string(osid‑id)[] |
| date | The date the awards in this convocation are to be conferred. | string(date‑time) |
| timePeriodId | . References a calendaring.TimePeriod object | string(osid‑id) |
Academies
Awards, Conferrals, and Convocations can be organized into federateable Academy catalogs.
| Field | Description | Type |
|---|---|---|
| id(read‑only) | The unique id of this academy, provided by system. | string(osid‑id) |
| uri(read‑only) | The uri of this academy, provided by system. | string(uri) |
| displayName | The name of this academy for display. | string |
| description | The description of this academy. | string |
| genusTypeId (read‑only) | Id of the immutable type of this academy. Default type set by system unless specified in query parameter. | string(osid‑id) |
| recordTypeIds (read‑only) | Type Ids of record types available on this academy. Record types define special attributes available on an object to support specific applications or classes of applications and are documented elsewhere. | string(osid‑id)[] |
| providerId | The provider of this academy. References a resource.Resource object. | string(osid‑id) |
| brandingIds | The branding of this academy. References repository.Asset objects. | string(osid‑id)[] |
| license | The licensing that applies to this academy. | string |
License
CampusAPI REST Documentation Copyright 2020 DXtera Institute. Based on the Open Service Interface Defitions: http://osid.org
/conferrals
Collection of conferrals in a system, federation of systems, or in a default academy.
get
Get all conferrals in the system or default academy.
post
Create a new conferral in the default academy.
get /conferrals
Get all conferrals in the system or default academy.
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 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleConferralType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleConferralType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleConferralType%40campusapi.org - fromDate: (string)
Get all conferrals from this date inclusive. Use with toDate to define date range query.
Example:
2020-10-03 - toDate: (string)
Get all conferrals up to this date inclusive. Use with fromDate to define date range query.
Example:
2020-12-18 - awardId: (string)
the id string to match a award.
Example:
recognition.Award%3A495%40base.url - recipientId: (string)
the id string to match a recipient.
Example:
resource.Resource%3A648%40base.url - referenceId: (string)
Id string to match reference.
Example:
resource.Resource%3A4496%40demo.dxtera.org - convocationId: (string)
Id string to match convocation.
Example:
recognition.Convocation%3A3048@demo.dxtera.org - academyId: (string)
The id string to match a academy
Example:
recognition.Academy%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "recognition.Conferral:8668@base.url",
"uri": "http://base.url/open/campusapi/recognition/conferral/recognition.Conferral%3A8668%40base.url",
"displayName": "Display Name of this Conferral",
"description": "The description of this Conferral",
"genusTypeId": "type.Type:defaultConferralType@base.url",
"recordTypeIds": [ "type.Type:exampleConferralRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:8668@base.url",
"awardId": "recognition.Award:9638@base.url",
"recipientId": "resource.Resource:7067@base.url",
"referenceId": "id.Id:3297@base.url",
"convocationId": "recognition.Convocation:2224@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /conferrals
Create a new conferral in the default academy.
Query Parameters
- awardId: required(string)
the award of this conferral.
Example:
recognition.Award%3A495%40base.url - recipientId: required(string)
the recipient of this conferral.
Example:
resource.Resource%3A648%40base.url - genusType: (string)
specify a particular conferral type to create
Example:
type.Type%3AexampleConferralType%40dxtera.org - recordType: (array of )
specify support for one or more conferral record types
Example:
[ "type.Type%3AexampleConferralRecordType%40campusapi.org", "..." ] - academyId: (string)
specify in which academy to create this conferral
Example:
recognition.Academy%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Conferral",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this conferral, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this conferral, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this conferral for display.",
"type": "string"
},
"description": {
"description": "The description of this conferral.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this conferral. 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 conferral. 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 conferral.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this conferral.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this conferral ended.",
"type": "string",
"format": "osid-id"
},
"awardId": {
"description": "The award associated with this conferral.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recipientId": {
"description": "The recipient associated with this conferral.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"referenceId": {
"description": "-- could someone please write a description for this --",
"type": "string",
"format": "osid-id"
},
"convocationId": {
"description": "The convocation (e.",
"type": "string",
"format": "osid-id"
}
}
}Example:
{
"displayName": "Display Name of this Conferral",
"description": "The description of this Conferral",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:4318@base.url",
"referenceId": "id.Id:7616@base.url",
"convocationId": "recognition.Convocation:7855@base.url"
}
Entity representing a conferral form metadata.
get
Get form metadata for creating a new conferral.
get /conferrals/metadata
Get form metadata for creating a new conferral.
Query Parameters
- awardId: required(string)
the award of this metadatum.
Example:
recognition.Award%3A495%40base.url - recipientId: required(string)
the recipient of this metadatum.
Example:
resource.Resource%3A648%40base.url - genusType: (string)
specify a particular conferral type to create
Example:
type.Type%3AexampleConferralType%40dxtera.org - recordType: (array of )
specify support for one or more conferral record types
Example:
[ "type.Type%3AexampleConferralRecordType%40campusapi.org", "..." ] - academyId: (string)
specify in which academy to create this conferral
Example:
recognition.Academy%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Conferral",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this conferral, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this conferral, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this conferral for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Conferral.Conferral:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this conferral",
"linked": false
},
"description": {
"description": "The description of this conferral.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Conferral.Conferral:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this conferral",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this conferral. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this conferral. 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 conferral.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Conferral.Conferral:startDate@base.url",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this conferral",
"linked": false
},
"endDate": {
"description": "The ending date of this conferral.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Conferral.Conferral:endDate@base.url",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this conferral",
"linked": false
},
"endReasonId": {
"description": "The reason this conferral ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Conferral.Conferral:endReason@base.url",
"existingValue": "process.State:1860@base.url",
"elementLabel": "End Reason",
"instructions": "Select the reason this conferral ended",
"linked": false
},
"referenceId": {
"description": "-- could someone please write a description for this --",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "recognition.Conferral:reference@dxtera.org",
"existingValue": null,
"elementLabel": "Reference",
"instructions": "Enter the Id of the reference for this conferral.",
"linked": false
},
"convocationId": {
"description": "The convocation (e.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "recognition.Conferral:convocation@dxtera.org",
"existingValue": null,
"elementLabel": "Convocation",
"instructions": "Enter the Id of the convocation for this conferral.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a conferral
get
Get a conferral given its id.
put
Update a given conferral.
delete
Delete a given conferral.
get /conferrals/{conferralId}
Get a conferral given its id.
URI Parameters
- conferralId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "recognition.Conferral:8668@base.url",
"uri": "http://base.url/open/campusapi/recognition/conferral/recognition.Conferral%3A8668%40base.url",
"displayName": "Display Name of this Conferral",
"description": "The description of this Conferral",
"genusTypeId": "type.Type:defaultConferralType@base.url",
"recordTypeIds": [ "type.Type:exampleConferralRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:8668@base.url",
"awardId": "recognition.Award:9638@base.url",
"recipientId": "resource.Resource:7067@base.url",
"referenceId": "id.Id:3297@base.url",
"convocationId": "recognition.Convocation:2224@base.url"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "conferral not found" }
put /conferrals/{conferralId}
Update a given conferral.
URI Parameters
- conferralId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Conferral",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this conferral, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this conferral, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this conferral for display.",
"type": "string"
},
"description": {
"description": "The description of this conferral.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this conferral. 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 conferral. 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 conferral.",
"type": "string",
"format": "date-time"
},
"endDate": {
"description": "The ending date of this conferral.",
"type": "string",
"format": "date-time"
},
"endReasonId": {
"description": "The reason this conferral ended.",
"type": "string",
"format": "osid-id"
},
"awardId": {
"description": "The award associated with this conferral.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recipientId": {
"description": "The recipient associated with this conferral.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"referenceId": {
"description": "-- could someone please write a description for this --",
"type": "string",
"format": "osid-id"
},
"convocationId": {
"description": "The convocation (e.",
"type": "string",
"format": "osid-id"
}
}
}Example:
{
"displayName": "Display Name of this Conferral",
"description": "The description of this Conferral",
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:4318@base.url",
"referenceId": "id.Id:7616@base.url",
"convocationId": "recognition.Convocation:7855@base.url"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The conferral has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "conferral not found" }
delete /conferrals/{conferralId}
Delete a given conferral.
URI Parameters
- conferralId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The conferral has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "conferral not found" }
Entity representing a conferral form metadata for update
get
Get form metadata for updating an existing conferral.
get /conferrals/{conferralId}/metadata
Get form metadata for updating an existing conferral.
URI Parameters
- conferralId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Conferral",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this conferral, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this conferral, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this conferral for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Conferral.Conferral:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this conferral",
"linked": false
},
"description": {
"description": "The description of this conferral.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Conferral.Conferral:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this conferral",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this conferral. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this conferral. 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 conferral.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Conferral.Conferral:startDate@base.url",
"existingValue": "2020-10-03T08:00:00.000Z",
"elementLabel": "Start Date",
"instructions": "Enter a starting date for this conferral",
"linked": false
},
"endDate": {
"description": "The ending date of this conferral.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Conferral.Conferral:endDate@base.url",
"existingValue": "2020-12-18T17:00:00.000Z",
"elementLabel": "End Date",
"instructions": "Enter an ending date for this conferral",
"linked": false
},
"endReasonId": {
"description": "The reason this conferral ended. A process/State object.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Conferral.Conferral:endReason@base.url",
"existingValue": "process.State:1860@base.url",
"elementLabel": "End Reason",
"instructions": "Select the reason this conferral ended",
"linked": false
},
"referenceId": {
"description": "-- could someone please write a description for this --",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "recognition.Conferral:reference@dxtera.org",
"existingValue": null,
"elementLabel": "Reference",
"instructions": "Enter the Id of the reference for this conferral.",
"linked": false
},
"convocationId": {
"description": "The convocation (e.",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "recognition.Conferral:convocation@dxtera.org",
"existingValue": null,
"elementLabel": "Convocation",
"instructions": "Enter the Id of the convocation for this conferral.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "conferral not found" }
/awards
Collection of awards in a system, federation of systems, or in a default academy.
get
Get all awards in the system or default academy.
post
Create a new award in the default academy.
get /awards
Get all awards in the system or default academy.
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 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleAwardType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleAwardType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleAwardType%40campusapi.org - academyId: (string)
The id string to match a academy
Example:
recognition.Academy%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "recognition.Award:6063@base.url",
"uri": "http://base.url/open/campusapi/recognition/award/recognition.Award%3A6063%40base.url",
"displayName": "Display Name of this Award",
"description": "The description of this Award",
"genusTypeId": "type.Type:defaultAwardType@base.url",
"recordTypeIds": [ "type.Type:exampleAwardRecordType@campusapi.org", "..."]
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /awards
Create a new award in the default academy.
Query Parameters
- genusType: (string)
specify a particular award type to create
Example:
type.Type%3AexampleAwardType%40dxtera.org - recordType: (array of )
specify support for one or more award record types
Example:
[ "type.Type%3AexampleAwardRecordType%40campusapi.org", "..." ] - academyId: (string)
specify in which academy to create this award
Example:
recognition.Academy%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Award",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this award, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this award, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this award for display.",
"type": "string"
},
"description": {
"description": "The description of this award.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this award. 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 award. 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
}
}
}Example:
{
"displayName": "Display Name of this Award",
"description": "The description of this Award"
}
Entity representing a award form metadata.
get
Get form metadata for creating a new award.
get /awards/metadata
Get form metadata for creating a new award.
Query Parameters
- genusType: (string)
specify a particular award type to create
Example:
type.Type%3AexampleAwardType%40dxtera.org - recordType: (array of )
specify support for one or more award record types
Example:
[ "type.Type%3AexampleAwardRecordType%40campusapi.org", "..." ] - academyId: (string)
specify in which academy to create this award
Example:
recognition.Academy%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Award",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this award, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this award, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this award for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Award.Award:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this award",
"linked": false
},
"description": {
"description": "The description of this award.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Award.Award:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this award",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this award. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this award. 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
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a award
get
Get a award given its id.
put
Update a given award.
delete
Delete a given award.
get /awards/{awardId}
Get a award given its id.
URI Parameters
- awardId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "recognition.Award:6063@base.url",
"uri": "http://base.url/open/campusapi/recognition/award/recognition.Award%3A6063%40base.url",
"displayName": "Display Name of this Award",
"description": "The description of this Award",
"genusTypeId": "type.Type:defaultAwardType@base.url",
"recordTypeIds": [ "type.Type:exampleAwardRecordType@campusapi.org", "..."]
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "award not found" }
put /awards/{awardId}
Update a given award.
URI Parameters
- awardId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Award",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this award, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this award, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this award for display.",
"type": "string"
},
"description": {
"description": "The description of this award.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this award. 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 award. 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
}
}
}Example:
{
"displayName": "Display Name of this Award",
"description": "The description of this Award"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The award has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "award not found" }
delete /awards/{awardId}
Delete a given award.
URI Parameters
- awardId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The award has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "award not found" }
Entity representing a award form metadata for update
get
Get form metadata for updating an existing award.
get /awards/{awardId}/metadata
Get form metadata for updating an existing award.
URI Parameters
- awardId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Award",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this award, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this award, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this award for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Award.Award:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this award",
"linked": false
},
"description": {
"description": "The description of this award.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Award.Award:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this award",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this award. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this award. 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
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "award not found" }
/convocations
Collection of convocations in a system, federation of systems, or in a default academy.
get
Get all convocations in the system or default academy.
post
Create a new convocation in the default academy.
get /convocations
Get all convocations in the system or default academy.
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 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleConvocationType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleConvocationType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleConvocationType%40campusapi.org - providerId: (string)
Id string to match provider.
Example:
resource.Resource%3A3690%40demo.dxtera.org - awardId: (string)
Id string to match award.
Example:
recognition.Award%3A3690%40demo.dxtera.org - fromDate: (string)
Get all convocations from this date inclusive. Use with toDate to define date range query.
Example:
2020-10-03 - toDate: (string)
Get all convocations up to this date inclusive. Use with fromDate to define date range query.
Example:
2020-12-18 - academyId: (string)
The id string to match a academy
Example:
recognition.Academy%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "recognition.Convocation:1381@base.url",
"uri": "http://base.url/open/campusapi/recognition/convocation/recognition.Convocation%3A1381%40base.url",
"displayName": "Display Name of this Convocation",
"description": "The description of this Convocation",
"genusTypeId": "type.Type:defaultConvocationType@base.url",
"recordTypeIds": [ "type.Type:exampleConvocationRecordType@campusapi.org", "..."],
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Convocation@base.url",
"license": "The license that applies to this Convocation",
"awardIds": [ "recognition.Award:7158@base.url", "..." ],
"date": "2021-07-21T23:15:30.000Z",
"timePeriodId": "calendaring.TimePeriod:3611@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /convocations
Create a new convocation in the default academy.
Query Parameters
- genusType: (string)
specify a particular convocation type to create
Example:
type.Type%3AexampleConvocationType%40dxtera.org - recordType: (array of )
specify support for one or more convocation record types
Example:
[ "type.Type%3AexampleConvocationRecordType%40campusapi.org", "..." ] - academyId: (string)
specify in which academy to create this convocation
Example:
recognition.Academy%3A8374%40base.url
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Convocation",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this convocation, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this convocation, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this convocation for display.",
"type": "string"
},
"description": {
"description": "The description of this convocation.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this convocation. 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 convocation. 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 convocation.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this convocation. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this convocation.",
"type": "string"
},
"active": {
"description": "Whether this convocation 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 convocation is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean"
},
"disabled": {
"description": "Whether this convocation is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean"
},
"operational": {
"description": "Whether this convocation is operational. This convocation is operational if any of the applied enablers are true.",
"type": "boolean",
"readOnly": true
},
"awardIds": {
"description": "The awards.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
}
},
"date": {
"description": "The date the awards in this convocation are to be conferred.",
"type": "string",
"format": "date-time"
},
"timePeriodId": {
"description": ".",
"type": "string",
"format": "osid-id"
}
}
}Example:
{
"displayName": "Display Name of this Convocation",
"description": "The description of this Convocation",
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Convocation@base.url",
"license": "The license that applies to this Convocation",
"awardIds": [ "recognition.Award:3055@base.url", "..." ],
"date": "2021-07-21T23:15:30.000Z",
"timePeriodId": "calendaring.TimePeriod:1064@base.url"
}
Entity representing a convocation form metadata.
get
Get form metadata for creating a new convocation.
get /convocations/metadata
Get form metadata for creating a new convocation.
Query Parameters
- genusType: (string)
specify a particular convocation type to create
Example:
type.Type%3AexampleConvocationType%40dxtera.org - recordType: (array of )
specify support for one or more convocation record types
Example:
[ "type.Type%3AexampleConvocationRecordType%40campusapi.org", "..." ] - academyId: (string)
specify in which academy to create this convocation
Example:
recognition.Academy%3A8374%40base.url
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Convocation",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this convocation, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this convocation, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this convocation for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Convocation.Convocation:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this convocation",
"linked": false
},
"description": {
"description": "The description of this convocation.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Convocation.Convocation:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this convocation",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this convocation. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this convocation. 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 convocation.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Convocation.Convocation:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this convocation",
"linked": false
},
"brandingIds": {
"description": "The branding of this convocation. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Convocation.Convocation:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this convocation",
"linked": false
},
"license": {
"description": "The licensing that applies to this convocation.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Convocation.Convocation:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this convocation",
"linked": false
},
"enabled": {
"description": "Whether this convocation is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean",
"read-only": false,
"elementId": "Convocation.Convocation:enabled@base.url",
"existingValue": false,
"elementLabel": "Enabled",
"instructions": "Enter whether this convocation is enabled",
"linked": false
},
"disabled": {
"description": "Whether this convocation is administravely disabled. Administratively disabling overrides any applied enabler.",
"type": "boolean",
"read-only": false,
"elementId": "Convocation.Convocation:enabled@base.url",
"existingValue": false,
"elementLabel": "Enabled",
"instructions": "Enter whether this convocation is enabled",
"linked": false
},
"awardIds": {
"description": "The awards.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"elementId": "recognition.Convocation:awards@dxtera.org",
"existingValue": [],
"elementLabel": "Awards",
"instructions": "Enter Ids for awards of this convocation.",
"linked": false
},
"date": {
"description": "The date the awards in this convocation are to be conferred.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "recognition.Convocation:date@dxtera.org",
"existingValue": "",
"elementLabel": "Date",
"instructions": "Enter the date of this convocation.",
"linked": false
},
"timePeriodId": {
"description": ".",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "recognition.Convocation:timePeriod@dxtera.org",
"existingValue": null,
"elementLabel": "Time Period",
"instructions": "Enter the Id of the time period for this convocation.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a convocation
get
Get a convocation given its id.
put
Update a given convocation.
delete
Delete a given convocation.
get /convocations/{convocationId}
Get a convocation given its id.
URI Parameters
- convocationId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "recognition.Convocation:1381@base.url",
"uri": "http://base.url/open/campusapi/recognition/convocation/recognition.Convocation%3A1381%40base.url",
"displayName": "Display Name of this Convocation",
"description": "The description of this Convocation",
"genusTypeId": "type.Type:defaultConvocationType@base.url",
"recordTypeIds": [ "type.Type:exampleConvocationRecordType@campusapi.org", "..."],
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Convocation@base.url",
"license": "The license that applies to this Convocation",
"awardIds": [ "recognition.Award:7158@base.url", "..." ],
"date": "2021-07-21T23:15:30.000Z",
"timePeriodId": "calendaring.TimePeriod:3611@base.url"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "convocation not found" }
put /convocations/{convocationId}
Update a given convocation.
URI Parameters
- convocationId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Convocation",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this convocation, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this convocation, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this convocation for display.",
"type": "string"
},
"description": {
"description": "The description of this convocation.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this convocation. 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 convocation. 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 convocation.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this convocation. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this convocation.",
"type": "string"
},
"active": {
"description": "Whether this convocation 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 convocation is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean"
},
"disabled": {
"description": "Whether this convocation is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean"
},
"operational": {
"description": "Whether this convocation is operational. This convocation is operational if any of the applied enablers are true.",
"type": "boolean",
"readOnly": true
},
"awardIds": {
"description": "The awards.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id"
}
},
"date": {
"description": "The date the awards in this convocation are to be conferred.",
"type": "string",
"format": "date-time"
},
"timePeriodId": {
"description": ".",
"type": "string",
"format": "osid-id"
}
}
}Example:
{
"displayName": "Display Name of this Convocation",
"description": "The description of this Convocation",
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Convocation@base.url",
"license": "The license that applies to this Convocation",
"awardIds": [ "recognition.Award:3055@base.url", "..." ],
"date": "2021-07-21T23:15:30.000Z",
"timePeriodId": "calendaring.TimePeriod:1064@base.url"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The convocation has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "convocation not found" }
delete /convocations/{convocationId}
Delete a given convocation.
URI Parameters
- convocationId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The convocation has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "convocation not found" }
Entity representing a convocation form metadata for update
get
Get form metadata for updating an existing convocation.
get /convocations/{convocationId}/metadata
Get form metadata for updating an existing convocation.
URI Parameters
- convocationId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Convocation",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this convocation, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this convocation, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this convocation for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Convocation.Convocation:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this convocation",
"linked": false
},
"description": {
"description": "The description of this convocation.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Convocation.Convocation:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this convocation",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this convocation. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this convocation. 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 convocation.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Convocation.Convocation:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this convocation",
"linked": false
},
"brandingIds": {
"description": "The branding of this convocation. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Convocation.Convocation:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this convocation",
"linked": false
},
"license": {
"description": "The licensing that applies to this convocation.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Convocation.Convocation:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this convocation",
"linked": false
},
"enabled": {
"description": "Whether this convocation is administravely enabled. Administratively enabling overrides any applied enabler.",
"type": "boolean",
"read-only": false,
"elementId": "Convocation.Convocation:enabled@base.url",
"existingValue": false,
"elementLabel": "Enabled",
"instructions": "Enter whether this convocation is enabled",
"linked": false
},
"disabled": {
"description": "Whether this convocation is administravely disabled. Administratively disabling overrides any applied enabler.",
"type": "boolean",
"read-only": false,
"elementId": "Convocation.Convocation:enabled@base.url",
"existingValue": false,
"elementLabel": "Enabled",
"instructions": "Enter whether this convocation is enabled",
"linked": false
},
"awardIds": {
"description": "The awards.",
"type": "array",
"items": {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"elementId": "recognition.Convocation:awards@dxtera.org",
"existingValue": [],
"elementLabel": "Awards",
"instructions": "Enter Ids for awards of this convocation.",
"linked": false
},
"date": {
"description": "The date the awards in this convocation are to be conferred.",
"type": "string",
"format": "date-time",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "recognition.Convocation:date@dxtera.org",
"existingValue": "",
"elementLabel": "Date",
"instructions": "Enter the date of this convocation.",
"linked": false
},
"timePeriodId": {
"description": ".",
"type": "string",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "recognition.Convocation:timePeriod@dxtera.org",
"existingValue": null,
"elementLabel": "Time Period",
"instructions": "Enter the Id of the time period for this convocation.",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "convocation not found" }
/academies
Collection of academies in a system or federation of systems.
get
Get all academies.
post
Create a new academy.
get /academies
Get all academies.
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 - genusTypeId: (string)
The id string to match a genusType
Example:
type.Type%3AexampleAcademyType%40dxtera.org - parentGenusTypeId: (string)
The id string to match a parent genusType
Example:
type.Type%3AparentTypeExampleAcademyType%40dxtera.org - recordTypeId: (string)
The id string to match a recordType
Example:
type.Type%3AexampleAcademyType%40campusapi.org - providerId: (string)
Id string to match provider.
Example:
resource.Resource%3A3007%40demo.dxtera.org - conferralId: (string)
Get academies mapped to this conferral.
Example:
recognition.Conferral%3A693%40demo.dxtera.org - awardId: (string)
Get academies mapped to this award.
Example:
recognition.Award%3A385%40demo.dxtera.org - convocationId: (string)
Get academies mapped to this convocation.
Example:
recognition.Convocation%3A847%40demo.dxtera.org
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "recognition.Academy:1868@base.url",
"uri": "http://base.url/open/campusapi/recognition/academy/recognition.Academy%3A1868%40base.url",
"displayName": "Display Name of this Academy",
"description": "The description of this Academy",
"genusTypeId": "type.Type:defaultAcademyType@base.url",
"recordTypeIds": [ "type.Type:exampleAcademyRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Academy@base.url",
"license": "The license that applies to this Academy"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
post /academies
Create a new academy.
Query Parameters
- genusType: (string)
specify a particular academy type to create
Example:
type.Type%3AexampleAcademyType%40dxtera.org - recordType: (array of )
specify support for one or more academy record types
Example:
[ "type.Type%3AexampleAcademyRecordType%40campusapi.org", "..." ]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Academy",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this academy, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this academy, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this academy for display.",
"type": "string"
},
"description": {
"description": "The description of this academy.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this academy. 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 academy. 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 academy.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this academy. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this academy.",
"type": "string"
}
}
}Example:
{
"displayName": "Display Name of this Academy",
"description": "The description of this Academy",
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Academy@base.url",
"license": "The license that applies to this Academy"
}
Entity representing a academy form metadata.
get
Get form metadata for creating a new academy.
get /academies/metadata
Get form metadata for creating a new academy.
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Academy",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this academy, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this academy, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this academy for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Academy.Academy:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this academy",
"linked": false
},
"description": {
"description": "The description of this academy.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Academy.Academy:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this academy",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this academy. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this academy. 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 academy.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Academy.Academy:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this academy",
"linked": false
},
"brandingIds": {
"description": "The branding of this academy. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Academy.Academy:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this academy",
"linked": false
},
"license": {
"description": "The licensing that applies to this academy.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Academy.Academy:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this academy",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
The root academies in the academy hierarchy. A node with no parents is an orphan. While all academy Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.
get
Get all root root-academy
get /academies/root-academy
Get all root root-academy
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "recognition.Academy:1868@base.url",
"uri": "http://base.url/open/campusapi/recognition/academy/recognition.Academy%3A1868%40base.url",
"displayName": "Display Name of this Academy",
"description": "The description of this Academy",
"genusTypeId": "type.Type:defaultAcademyType@base.url",
"recordTypeIds": [ "type.Type:exampleAcademyRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Academy@base.url",
"license": "The license that applies to this Academy"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
Entity representing a academy
get
Get a academy given its id.
put
Update a given academy.
delete
Delete a given academy.
get /academies/{academyId}
Get a academy given its id.
URI Parameters
- academyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": "recognition.Academy:1868@base.url",
"uri": "http://base.url/open/campusapi/recognition/academy/recognition.Academy%3A1868%40base.url",
"displayName": "Display Name of this Academy",
"description": "The description of this Academy",
"genusTypeId": "type.Type:defaultAcademyType@base.url",
"recordTypeIds": [ "type.Type:exampleAcademyRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Academy@base.url",
"license": "The license that applies to this Academy"
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "academy not found" }
put /academies/{academyId}
Update a given academy.
URI Parameters
- academyId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Academy",
"type": "object",
"properties": {
"id": {
"description": "The unique id of this academy, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this academy, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this academy for display.",
"type": "string"
},
"description": {
"description": "The description of this academy.",
"type": "string"
},
"genusTypeId": {
"description": "Id of the immutable type of this academy. 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 academy. 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 academy.",
"type": "string",
"format": "osid-id"
},
"brandingIds": {
"description": "The branding of this academy. A collection of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id"
}
},
"license": {
"description": "The licensing that applies to this academy.",
"type": "string"
}
}
}Example:
{
"displayName": "Display Name of this Academy",
"description": "The description of this Academy",
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Academy@base.url",
"license": "The license that applies to this Academy"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The academy has been updated" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "academy not found" }
delete /academies/{academyId}
Delete a given academy.
URI Parameters
- academyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The academy has been deleted" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "academy not found" }
Entity representing a academy form metadata for update
get
Get form metadata for updating an existing academy.
get /academies/{academyId}/metadata
Get form metadata for updating an existing academy.
URI Parameters
- academyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"$schema": "http://json-schema.org/draft/2019-9/schema#",
"title": "Academy",
"type": "object",
"required": ["displayName"],
"properties": {
"id": {
"description": "The unique id of this academy, provided by system.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"uri": {
"description": "The uri of this academy, provided by system.",
"type": "string",
"format": "uri",
"readOnly": true
},
"displayName": {
"description": "The name of this academy for display.",
"type": "string",
"read-only": false,
"minLength": 1,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Academy.Academy:displayName@base.url",
"existingValue": "The Existing Name",
"elementLabel": "Name",
"instructions": "Enter a name for this academy",
"linked": false
},
"description": {
"description": "The description of this academy.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Academy.Academy:displayName@demo.base.url",
"existingValue": "The Existing Description",
"elementLabel": "Description",
"instructions": "Enter a description for this academy",
"linked": false
},
"genusTypeId": {
"description": "Id of the immutable type of this academy. Default type set by system unless specified in query parameter on initial post.",
"type": "string",
"format": "osid-id",
"readOnly": true
},
"recordTypeIds": {
"description": "Type Ids of record types available on this academy. 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 academy.",
"type": "string",
"format": "osid-id",
"read-only": false,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Academy.Academy:provider@base.url",
"existingValue": "",
"elementLabel": "Provider",
"instructions": "Enter the provider of this academy",
"linked": false
},
"brandingIds": {
"description": "The branding of this academy. A list of Assets.",
"type": "array",
"items" : {
"type": "string",
"format": "osid-id",
"pattern": "",
"enum": []
},
"read-only": false,
"default": [],
"elementId": "Academy.Academy:branding@base.url",
"existingValue": "",
"elementLabel": "Branding",
"instructions": "Enter the branding images for this academy",
"linked": false
},
"license": {
"description": "The licensing that applies to this academy.",
"type": "string",
"read-only": false,
"minLength": 0,
"maxLength": 128,
"pattern": "",
"default": "",
"enum": [],
"elementId": "Academy.Academy:license@base.url",
"existingValue": "The Existing License",
"elementLabel": "License",
"instructions": "Include a license for this academy",
"linked": false
}
}
}
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{"message": "academy not found" }
get
Get child academies for the given academy in the hierarchy.
get /academies/{academyId}/children
Get child academies for the given academy in the hierarchy.
URI Parameters
- academyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "recognition.Academy:1868@base.url",
"uri": "http://base.url/open/campusapi/recognition/academy/recognition.Academy%3A1868%40base.url",
"displayName": "Display Name of this Academy",
"description": "The description of this Academy",
"genusTypeId": "type.Type:defaultAcademyType@base.url",
"recordTypeIds": [ "type.Type:exampleAcademyRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Academy@base.url",
"license": "The license that applies to this Academy"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add academy as child of the given academy in the hierarchy.
delete
Remove the given academy as a child of the given academy in the hierarchy.
put /academies/{academyId}/children/{childId}
Add academy as child of the given academy in the hierarchy.
URI Parameters
- academyId: required(string)
- childId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "The child academy has been added to the hierarchy" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "academy not found" }
delete /academies/{academyId}/children/{childId}
Remove the given academy as a child of the given academy in the hierarchy.
URI Parameters
- academyId: required(string)
- childId: required(string)
get
Get parent academies for the given academy in the hierarchy.
get /academies/{academyId}/parents
Get parent academies for the given academy in the hierarchy.
URI Parameters
- academyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "recognition.Academy:1868@base.url",
"uri": "http://base.url/open/campusapi/recognition/academy/recognition.Academy%3A1868%40base.url",
"displayName": "Display Name of this Academy",
"description": "The description of this Academy",
"genusTypeId": "type.Type:defaultAcademyType@base.url",
"recordTypeIds": [ "type.Type:exampleAcademyRecordType@campusapi.org", "..."],
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Academy@base.url",
"license": "The license that applies to this Academy"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
get
Get all conferrals in this academy
get /academies/{academyId}/conferrals
Get all conferrals in this academy
URI Parameters
- academyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "recognition.Conferral:8668@base.url",
"uri": "http://base.url/open/campusapi/recognition/conferral/recognition.Conferral%3A8668%40base.url",
"displayName": "Display Name of this Conferral",
"description": "The description of this Conferral",
"genusTypeId": "type.Type:defaultConferralType@base.url",
"recordTypeIds": [ "type.Type:exampleConferralRecordType@campusapi.org", "..."],
"startDate": "2020-10-03T06:30:00.000Z",
"endDate": "2020-12-18T19:30:00.000Z",
"endReasonId": "process.State:8668@base.url",
"awardId": "recognition.Award:9638@base.url",
"recipientId": "resource.Resource:7067@base.url",
"referenceId": "id.Id:3297@base.url",
"convocationId": "recognition.Convocation:2224@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given conferral to this academy
delete
Remove the given conferral from the academy.
put /academies/{academyId}/conferrals/{conferralId}
Add the given conferral to this academy
URI Parameters
- academyId: required(string)
- conferralId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "conferral has been added to academy" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "conferral not found" }
delete /academies/{academyId}/conferrals/{conferralId}
Remove the given conferral from the academy.
URI Parameters
- academyId: required(string)
- conferralId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "conferral has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "conferral not found" }
get
Get all awards in this academy
get /academies/{academyId}/awards
Get all awards in this academy
URI Parameters
- academyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "recognition.Award:6063@base.url",
"uri": "http://base.url/open/campusapi/recognition/award/recognition.Award%3A6063%40base.url",
"displayName": "Display Name of this Award",
"description": "The description of this Award",
"genusTypeId": "type.Type:defaultAwardType@base.url",
"recordTypeIds": [ "type.Type:exampleAwardRecordType@campusapi.org", "..."]
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given award to this academy
delete
Remove the given award from the academy.
put /academies/{academyId}/awards/{awardId}
Add the given award to this academy
URI Parameters
- academyId: required(string)
- awardId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "award has been added to academy" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "award not found" }
delete /academies/{academyId}/awards/{awardId}
Remove the given award from the academy.
URI Parameters
- academyId: required(string)
- awardId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "award has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "award not found" }
get
Get all convocations in this academy
get /academies/{academyId}/convocations
Get all convocations in this academy
URI Parameters
- academyId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
[
{
"id": "recognition.Convocation:1381@base.url",
"uri": "http://base.url/open/campusapi/recognition/convocation/recognition.Convocation%3A1381%40base.url",
"displayName": "Display Name of this Convocation",
"description": "The description of this Convocation",
"genusTypeId": "type.Type:defaultConvocationType@base.url",
"recordTypeIds": [ "type.Type:exampleConvocationRecordType@campusapi.org", "..."],
"active": true,
"enabled": true,
"disabled": false,
"operational": true,
"providerId": "resource.Resource:123@base.url",
"brandingId": "asset.Asset:Convocation@base.url",
"license": "The license that applies to this Convocation",
"awardIds": [ "recognition.Award:7158@base.url", "..." ],
"date": "2021-07-21T23:15:30.000Z",
"timePeriodId": "calendaring.TimePeriod:3611@base.url"
},
{
"...": "..."
}
]
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
put
Add the given convocation to this academy
delete
Remove the given convocation from the academy.
put /academies/{academyId}/convocations/{convocationId}
Add the given convocation to this academy
URI Parameters
- academyId: required(string)
- convocationId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "convocation has been added to academy" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "convocation not found" }
delete /academies/{academyId}/convocations/{convocationId}
Remove the given convocation from the academy.
URI Parameters
- academyId: required(string)
- convocationId: required(string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{ "message": "convocation has been removed" }
HTTP status code 403
Body
Media type: application/json
Type: any
Example:
{"message": "Permission denied" }
HTTP status code 404
Body
Media type: application/json
Type: any
Example:
{ "message": "convocation not found" }