CampusAPI Recognition Services API documentation version 0.1.5
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", "endReason", "reference", "convocation", "award", "recipient", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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%40base.url

• convocationId: (string)

  Id string to match convocation.

  Example:

  recognition.Convocation%3A3048%40base.url

• academyId: (string)

  The id string to match a academy

  Example:

  recognition.Academy%3A8374%40base.url

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:217@base.url",
  "referenceId": "id.Id:8934@base.url",
  "convocationId": "recognition.Convocation:4857@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", "reference", "convocation", "award", "recipient", 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": "ConferralQuery",
  "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"
          }
        }
      }
    },
    "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": "object"
      }
    },
    "matchAnyEndReason": {
      "description": "Match end reasons with any value. true to match Conferrals with any end reason, false to match Conferrals with no end reason",
      "type": "boolean"
    },
    "matchAwardIds": {
      "description": "List of award Ids for this query to match conferral that have a related award.",
      "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"
          }
        }
      }
    },
    "awardQueries": {
      "description": "AwardQueries to match the award. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchRecipientIds": {
      "description": "List of recipient Ids for this query to match conferral that have a related recipient.",
      "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"
          }
        }
      }
    },
    "recipientQueries": {
      "description": "RecipientQueries to match the recipient. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchReferenceIds": {
      "description": "List of Id Ids for this query to match reference.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "referenceId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "referenceQueries": {
      "description": "id.IdQueries to match the Reference. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyReference": {
      "description": "Match reference with any value. true to match Conferrals with any reference, false to match Conferrals with no reference",
      "type": "boolean"
    },
    "matchConvocationIds": {
      "description": "List of Convocation Ids for this query to match convocation.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "convocationId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "convocationQueries": {
      "description": "recognition.ConvocationQueries to match the Convocation. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyConvocation": {
      "description": "Match convocation with any value. true to match Conferrals with any convocation, false to match Conferrals with no convocation",
      "type": "boolean"
    },
    "matchAcademyIds": {
      "description": "List of Academy Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "academyId": {
            "description": "Academy id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "academyQueries": {
      "description": "AcademyQueries to match Academy. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

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

URI Parameters

• conferralId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

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:217@base.url",
  "referenceId": "id.Id:8934@base.url",
  "convocationId": "recognition.Convocation:4857@base.url"
}

URI Parameters

• conferralId: required(string)

URI Parameters

• conferralId: 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

• 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

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"
}

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": "AwardQuery",
  "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"
          }
        }
      }
    },
    "matchAcademyIds": {
      "description": "List of Academy Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "academyId": {
            "description": "Academy id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "academyQueries": {
      "description": "AcademyQueries to match Academy. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

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

URI Parameters

• awardId: 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

• 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"
}

URI Parameters

• awardId: required(string)

URI Parameters

• awardId: 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", "awards", "timePeriod", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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%40base.url

• 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

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:6544@base.url", "..." ],
  "date": "2021-07-21T23:15:30.000Z",
  "timePeriodId": "calendaring.TimePeriod:5561@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", "awards", "timePeriod", 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": "ConvocationQuery",
  "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"
          }
        }
      }
    },
    "matchProviderIds": {
      "description": "List of provider Ids 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"
          }
        }
      }
    },
    "providerQueries": {
      "description": "resource.ResourceQuery for provider. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
    },
    "matchAnyProvider": {
      "description": "Match providers with any value. true to match Convocation with any provider, false to match Convocation with no provider",
      "type": "boolean"
      }
    },
    "matchBrandingIds": {
      "description": "List of branding asset Ids 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"
          }
        }
      }
    },
    "brandingQueries": {
      "description": "repository.AssetQuery for branding. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyBranding": {
      "description": "Match brandingss with any value. true to match Convocation with any branding, false to match Convocation with no branding",
      "type": "boolean"
    },
    "matchlicenses": {
      "description": "List of license strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "license": {
            "description": "license 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"
          }
        }
      }
    },
    "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"
    },
    "matchAwardIds": {
      "description": "List of Award Ids for this query to match awards.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "awardId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "awardQueries": {
      "description": "recognition.AwardQueries to match the Awards. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyAward": {
      "description": "Match awards with any value. true to match Convocations with any awards, false to match Convocations with no awards",
      "type": "boolean"
    },
    "matchDate": {
      "description": "Matches dates 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"
          }
        }
      }
    },
    "matchAnyDate": {
      "description": "Match dates with any value. true to match Convocations with any date, false to match ProgramOfferings with no date",
      "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": "object"
      }
    },
    "matchAnyTimePeriod": {
      "description": "Match time period with any value. true to match Convocations with any time period, false to match Convocations with no time period",
      "type": "boolean"
    },
    "matchAcademyIds": {
      "description": "List of Academy Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "academyId": {
            "description": "Academy id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "academyQueries": {
      "description": "AcademyQueries to match Academy. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

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

URI Parameters

• convocationId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

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:6544@base.url", "..." ],
  "date": "2021-07-21T23:15:30.000Z",
  "timePeriodId": "calendaring.TimePeriod:5561@base.url"
}

URI Parameters

• convocationId: required(string)

URI Parameters

• convocationId: 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

• 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

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"
}

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": "AcademyQuery",
  "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"
          }
        }
      }
    },
    "matchProviderIds": {
      "description": "List of provider Ids 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"
          }
        }
      }
    },
    "providerQueries": {
      "description": "resource.ResourceQuery for provider. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
    },
    "matchAnyProvider": {
      "description": "Match providers with any value. true to match Academy with any provider, false to match Academy with no provider",
      "type": "boolean"
      }
    },
    "matchBrandingIds": {
      "description": "List of branding asset Ids 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"
          }
        }
      }
    },
    "brandingQueries": {
      "description": "repository.AssetQuery for branding. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyBranding": {
      "description": "Match brandingss with any value. true to match Academy with any branding, false to match Academy with no branding",
      "type": "boolean"
    },
    "matchlicenses": {
      "description": "List of license strings to match. Boolean OR performed among multiple descriptions.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "license": {
            "description": "license 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"
          }
        }
      }
    },
    "matchAcademyIds": {
      "description": "List of Academy Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "academyId": {
            "description": "Academy id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "academyQueries": {
      "description": "AcademyQueries to match Academy. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

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 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "recognition.Academy:6186@base.url",
    "uri": "http://base.url/open/campusapi/recognition/academy/recognition.Academy%3A6186%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" }

URI Parameters

• academyId: required(string)

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"
}

URI Parameters

• academyId: required(string)

URI Parameters

• academyId: required(string)

URI Parameters

• academyId: required(string)

URI Parameters

• academyId: required(string)
• childId: required(string)

URI Parameters

• academyId: required(string)
• childId: required(string)

URI Parameters

• academyId: required(string)

URI Parameters

• academyId: 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", "reference", "convocation", "award", "recipient", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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

URI Parameters

• academyId: required(string)
• conferralId: required(string)

URI Parameters

• academyId: required(string)
• conferralId: required(string)

URI Parameters

• academyId: 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

• 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

URI Parameters

• academyId: required(string)
• awardId: required(string)

URI Parameters

• academyId: required(string)
• awardId: required(string)

URI Parameters

• academyId: 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", "awards", "timePeriod", or "all" to expand all referenced objects or types. This parameter can be repeated to expand multiples.

  Example:

  all

• 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

URI Parameters

• academyId: required(string)
• convocationId: required(string)

URI Parameters

• academyId: required(string)
• convocationId: required(string)