CampusAPI Personnel Services API documentation version 1.0.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", 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%3AexamplePersonType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExamplePersonType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexamplePersonType%40campusapi.org

• realmId: (string)

  The id string to match a realm

  Example:

  personnel.Realm%3A8374%40base.url

Query Parameters

• genusType: (string)

  specify a particular person type to create

  Example:

  type.Type%3AexamplePersonType%40dxtera.org

• recordType: (array of )

  specify support for one or more person record types

  Example:

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

• realmId: (string)

  specify in which realm to create this person

  Example:

  personnel.Realm%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Person",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this person, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this person, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this person for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this person.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this person. 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 person. 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
    },
    "salutation": {
      "description": "The title for this person (Mr.",
      "type": "string"
    },
    "givenName": {
      "description": "The given name of this person.",
      "type": "string"
    },
    "preferredName": {
      "description": "The preferred forename or mononym of this person.",
      "type": "string"
    },
    "forenameAliases": {
      "description": "Additional forenames this person is or was known by.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "middleNames": {
      "description": "The middle names of this person.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "surname": {
      "description": "The surname of this person.",
      "type": "string"
    },
    "surnameAliases": {
      "description": "Additional surnames this person is or was known by.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "generationQualifier": {
      "description": "The generation qualifier of this person.",
      "type": "string"
    },
    "birthDate": {
      "description": "The date of birth for this person.",
      "type": "string",
      "format": "date-time"
    },
    "deathDate": {
      "description": "The date of death for this person.",
      "type": "string",
      "format": "date-time"
    },
    "institutionalIdentifier": {
      "description": "The institutional identifier for this person.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Person",
  "description": "The description of this Person",
  "salutation": "This is the Salutation",
  "givenName": "This is the GivenName",
  "preferredName": "This is the PreferredName",
  "forenameAliases": [ "..string[]..", "..." ],
  "middleNames": [ "..string[]..", "..." ],
  "surname": "This is the Surname",
  "surnameAliases": [ "..string[]..", "..." ],
  "generationQualifier": "This is the GenerationQualifier",
  "birthDate": "2021-07-21T23:15:30.000Z",
  "deathDate": "2021-07-21T23:15:30.000Z",
  "institutionalIdentifier": "This is the string for InstitutionalIdentifier",
  "qualificationSuffix": "This is the QualificationSuffix"
}

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": "PersonQuery",
  "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"
          }
        }
      }
    },
    "matchSalutation": {
      "description": "List of Salutation strings to match. Boolean OR performed among multiple salutations.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "salutations": {
            "description": "salutations 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"
          }
        }
      }
    },
    "matchAnySalutation": {
      "description": "Match salutations with any value. true to match Persons with any salutation, false to match ProgramOfferings with no salutation",
      "type": "boolean"

    },
    "matchGivenName": {
      "description": "List of GivenName strings to match. Boolean OR performed among multiple givenNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "givenNames": {
            "description": "givenNames 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"
          }
        }
      }
    },
    "matchAnyGivenName": {
      "description": "Match givenNames with any value. true to match Persons with any given name, false to match ProgramOfferings with no given name",
      "type": "boolean"

    },
    "matchPreferredName": {
      "description": "List of PreferredName strings to match. Boolean OR performed among multiple preferredNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "preferredNames": {
            "description": "preferredNames 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"
          }
        }
      }
    },
    "matchAnyPreferredName": {
      "description": "Match preferredNames with any value. true to match Persons with any preferred name, false to match ProgramOfferings with no preferred name",
      "type": "boolean"

    },
    "matchForenameAliases": {
      "description": "List of ForenameAliases strings to match. Boolean OR performed among multiple forenameAliases.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "forenameAliases": {
            "description": "forenameAliases 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"
          }
        }
      }
    },
    "matchAnyForenameAliases": {
      "description": "Match forenameAliases with any value. true to match Persons with any forename aliases, false to match ProgramOfferings with no forename aliases",
      "type": "boolean"

    },
    "matchMiddleNames": {
      "description": "List of MiddleNames strings to match. Boolean OR performed among multiple middleNames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "middleNames": {
            "description": "middleNames 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"
          }
        }
      }
    },
    "matchAnyMiddleNames": {
      "description": "Match middleNames with any value. true to match Persons with any middle names, false to match ProgramOfferings with no middle names",
      "type": "boolean"

    },
    "matchSurname": {
      "description": "List of Surname strings to match. Boolean OR performed among multiple surnames.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "surnames": {
            "description": "surnames 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"
          }
        }
      }
    },
    "matchAnySurname": {
      "description": "Match surnames with any value. true to match Persons with any surname, false to match ProgramOfferings with no surname",
      "type": "boolean"

    },
    "matchSurnameAliases": {
      "description": "List of SurnameAliases strings to match. Boolean OR performed among multiple surnameAliases.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "surnameAliases": {
            "description": "surnameAliases 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"
          }
        }
      }
    },
    "matchAnySurnameAliases": {
      "description": "Match surnameAliases with any value. true to match Persons with any surname aliases, false to match ProgramOfferings with no surname aliases",
      "type": "boolean"

    },
    "matchGenerationQualifier": {
      "description": "List of GenerationQualifier strings to match. Boolean OR performed among multiple generationQualifiers.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "generationQualifiers": {
            "description": "generationQualifiers 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"
          }
        }
      }
    },
    "matchAnyGenerationQualifier": {
      "description": "Match generationQualifiers with any value. true to match Persons with any generation qualifier, false to match ProgramOfferings with no generation qualifier",
      "type": "boolean"

    },
    "matchBirthDate": {
      "description": "Matches birthDates 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"
          }
        }
      }
    },
    "matchAnyBirthDate": {
      "description": "Match birthDates with any value. true to match Persons with any birth date, false to match ProgramOfferings with no birth date",
      "type": "boolean"

    },
    "matchDeathDate": {
      "description": "Matches deathDates 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"
          }
        }
      }
    },
    "matchAnyDeathDate": {
      "description": "Match deathDates with any value. true to match Persons with any death date, false to match ProgramOfferings with no death date",
      "type": "boolean"

    },
    "matchInstitutionalIdentifier": {
      "description": "List of InstitutionalIdentifier strings to match. Boolean OR performed among multiple institutionalIdentifiers.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "institutionalIdentifiers": {
            "description": "institutionalIdentifiers 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"
          }
        }
      }
    },
    "matchAnyInstitutionalIdentifier": {
      "description": "Match institutionalIdentifiers with any value. true to match Persons with any institutional identifier, false to match ProgramOfferings with no institutional identifier",
      "type": "boolean"

    },
    "matchRealmIds": {
      "description": "List of Realm Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "realmId": {
            "description": "Realm id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "realmQueries": {
      "description": "RealmQueries to match Realm. 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 person type to create

  Example:

  type.Type%3AexamplePersonType%40dxtera.org

• recordType: (array of )

  specify support for one or more person record types

  Example:

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

• realmId: (string)

  specify in which realm to create this person

  Example:

  personnel.Realm%3A8374%40base.url

URI Parameters

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

• personId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Person",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this person, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this person, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this person for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this person.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this person. 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 person. 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
    },
    "salutation": {
      "description": "The title for this person (Mr.",
      "type": "string"
    },
    "givenName": {
      "description": "The given name of this person.",
      "type": "string"
    },
    "preferredName": {
      "description": "The preferred forename or mononym of this person.",
      "type": "string"
    },
    "forenameAliases": {
      "description": "Additional forenames this person is or was known by.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "middleNames": {
      "description": "The middle names of this person.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "surname": {
      "description": "The surname of this person.",
      "type": "string"
    },
    "surnameAliases": {
      "description": "Additional surnames this person is or was known by.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "generationQualifier": {
      "description": "The generation qualifier of this person.",
      "type": "string"
    },
    "birthDate": {
      "description": "The date of birth for this person.",
      "type": "string",
      "format": "date-time"
    },
    "deathDate": {
      "description": "The date of death for this person.",
      "type": "string",
      "format": "date-time"
    },
    "institutionalIdentifier": {
      "description": "The institutional identifier for this person.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Person",
  "description": "The description of this Person",
  "salutation": "This is the Salutation",
  "givenName": "This is the GivenName",
  "preferredName": "This is the PreferredName",
  "forenameAliases": [ "..string[]..", "..." ],
  "middleNames": [ "..string[]..", "..." ],
  "surname": "This is the Surname",
  "surnameAliases": [ "..string[]..", "..." ],
  "generationQualifier": "This is the GenerationQualifier",
  "birthDate": "2021-07-21T23:15:30.000Z",
  "deathDate": "2021-07-21T23:15:30.000Z",
  "institutionalIdentifier": "This is the string for InstitutionalIdentifier",
  "qualificationSuffix": "This is the QualificationSuffix"
}

URI Parameters

• personId: required(string)

URI Parameters

• personId: 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%3AexampleOrganizationType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleOrganizationType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleOrganizationType%40campusapi.org

• fromDate: (string)

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

  Example:

  2020-10-03

• toDate: (string)

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

  Example:

  2020-12-18

• realmId: (string)

  The id string to match a realm

  Example:

  personnel.Realm%3A8374%40base.url

Query Parameters

• genusType: (string)

  specify a particular organization type to create

  Example:

  type.Type%3AexampleOrganizationType%40dxtera.org

• recordType: (array of )

  specify support for one or more organization record types

  Example:

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

• realmId: (string)

  specify in which realm to create this organization

  Example:

  personnel.Realm%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Organization",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this organization, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this organization, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this organization for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this organization.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this organization. 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 organization. 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 organization.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this organization.",
      "type": "string",
      "format": "date-time"
    },
    "displayLabel": {
      "description": "The display label or code for this organization.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Organization",
  "description": "The description of this Organization",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "displayLabel": "This is the DisplayLabel"
}

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": "OrganizationQuery",
  "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"
        }
      }
    },
    "matchDisplayLabel": {
      "description": "List of DisplayLabel strings to match. Boolean OR performed among multiple displayLabels.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "displayLabels": {
            "description": "displayLabels 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"
          }
        }
      }
    },
    "matchAnyDisplayLabel": {
      "description": "Match displayLabels with any value. true to match Organizations with any display label, false to match ProgramOfferings with no display label",
      "type": "boolean"

    },
    "matchRealmIds": {
      "description": "List of Realm Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "realmId": {
            "description": "Realm id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "realmQueries": {
      "description": "RealmQueries to match Realm. 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 organization type to create

  Example:

  type.Type%3AexampleOrganizationType%40dxtera.org

• recordType: (array of )

  specify support for one or more organization record types

  Example:

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

• realmId: (string)

  specify in which realm to create this organization

  Example:

  personnel.Realm%3A8374%40base.url

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "id": "personnel.Organization:9579@base.url",
    "uri": "http://base.url/open/campusapi/personnel/organization/personnel.Organization%3A9579%40base.url",
    "displayName": "Display Name of this Organization",
    "description": "The description of this Organization",
    "genusTypeId": "type.Type:defaultOrganizationType@base.url",
    "recordTypeIds": [ "type.Type:exampleOrganizationRecordType@campusapi.org", "..."],
    "startDate": "2020-10-03T06:30:00.000Z",
    "endDate": "2020-12-18T19:30:00.000Z",
    "displayLabel": "This is the DisplayLabel"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• organizationId: required(string)

URI Parameters

• organizationId: required(string)

URI Parameters

• organizationId: required(string)

URI Parameters

• organizationId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Organization",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this organization, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this organization, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this organization for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this organization.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this organization. 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 organization. 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 organization.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this organization.",
      "type": "string",
      "format": "date-time"
    },
    "displayLabel": {
      "description": "The display label or code for this organization.",
      "type": "string"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Organization",
  "description": "The description of this Organization",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "displayLabel": "This is the DisplayLabel"
}

URI Parameters

• organizationId: required(string)

URI Parameters

• organizationId: required(string)

URI Parameters

• organizationId: required(string)

URI Parameters

• organizationId: required(string)
• childId: required(string)

URI Parameters

• organizationId: required(string)
• childId: required(string)

URI Parameters

• organizationId: 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", "level", "qualifications", "benefitsType", "organization", 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%3AexamplePositionType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExamplePositionType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexamplePositionType%40campusapi.org

• fromDate: (string)

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

  Example:

  2020-10-03

• toDate: (string)

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

  Example:

  2020-12-18

• organizationId: (string)

  the id string to match a organization.

  Example:

  personnel.Organization%3A864%40base.url

• realmId: (string)

  The id string to match a realm

  Example:

  personnel.Realm%3A8374%40base.url

Query Parameters

• organizationId: required(string)

  the organization of this position.

  Example:

  personnel.Organization%3A864%40base.url

• genusType: (string)

  specify a particular position type to create

  Example:

  type.Type%3AexamplePositionType%40dxtera.org

• recordType: (array of )

  specify support for one or more position record types

  Example:

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

• realmId: (string)

  specify in which realm to create this position

  Example:

  personnel.Realm%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Position",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this position, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this position, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this position for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this position.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this position. 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 position. 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 position.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this position.",
      "type": "string",
      "format": "date-time"
    },
    "organizationId": {
      "description": "The organization associated with this position.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "title": {
      "description": "The title for this position.",
      "type": "string"
    },
    "levelId": {
      "description": "The grade level for this position.",
      "type": "string",
      "format": "osid-id"
    },
    "qualificationIds": {
      "description": "The list of qualifications required for this position.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "targetAppointments": {
      "description": "The target number of Appointments desired for this Position.",
      "type": "integer",
      "minimum": 1
    },
    "requiredCommitment": {
      "description": "The required percentage commitment (0-100).",
      "type": "integer",
      "minimum": 1
    },
    "lowSalaryRange": {
      "description": "The low end of the salary range.",
      "type": "string",
      "format": "currency"
    },
    "midpointSalaryRange": {
      "description": "The midpoint of the salary range.",
      "type": "string",
      "format": "currency"
    },
    "highSalaryRange": {
      "description": "The high end of the salary range.",
      "type": "string",
      "format": "currency"
    },
    "compensationFrequency": {
      "description": "The frequency of compensation.",
      "type": "string",
      "format": "duration"
    },
    "exempt": {
      "description": "Tests if this position is FLSA exempt.",
      "type": "boolean"
    },
    "benefitsType": {
      "description": "The benefits Type assoicated with this position.",
      "type": "string",
      "format": "osid-type"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Position",
  "description": "The description of this Position",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "title": "This is the Title",
  "levelId": "grading.Grade:9372@base.url",
  "qualificationIds": [ "learning.Objective:9034@base.url", "..." ],
  "targetAppointments": 19,
  "requiredCommitment": 19,
  "lowSalaryRange": "USD+42.00",
  "midpointSalaryRange": "USD+42.00",
  "highSalaryRange": "USD+42.00",
  "compensationFrequency": "P3DT3H",
  "exempt": true,
  "benefitsType": "type.Type:4629@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", "level", "qualifications", "benefitsType", "organization", 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": "PositionQuery",
  "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"
        }
      }
    },
    "matchOrganizationIds": {
      "description": "List of organization Ids for this query to match position that have a related organization.",
      "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"
          }
        }
      }
    },
    "organizationQueries": {
      "description": "OrganizationQueries to match the organization. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchTitle": {
      "description": "List of Title strings to match. Boolean OR performed among multiple titles.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "titles": {
            "description": "titles 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"
          }
        }
      }
    },
    "matchAnyTitle": {
      "description": "Match titles with any value. true to match Positions with any title, false to match ProgramOfferings with no title",
      "type": "boolean"

    },
    "matchLevelIds": {
      "description": "List of Grade Ids for this query to match level.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "levelId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "levelQueries": {
      "description": "grading.GradeQueries to match the Level. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyLevel": {
      "description": "Match level with any value. true to match Positions with any level, false to match Positions with no level",
      "type": "boolean"
    },
    "matchQualificationIds": {
      "description": "List of Objective Ids for this query to match qualifications.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "qualificationId": {
            "description": "id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "qualificationQueries": {
      "description": "learning.ObjectiveQueries to match the Qualifications. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchAnyQualification": {
      "description": "Match qualifications with any value. true to match Positions with any qualifications, false to match Positions with no qualifications",
      "type": "boolean"
    },
    "matchTargetAppointments": {
      "description": "Match Positions with targetAppointments between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyTargetAppointments": {
      "description": "Match targetAppointments with any value. true to match Positions with any target appointments, false to match ProgramOfferings with no target appointments",
      "type": "boolean"

    },
    "matchRequiredCommitment": {
      "description": "Match Positions with requiredCommitments between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyRequiredCommitment": {
      "description": "Match requiredCommitments with any value. true to match Positions with any required commitment, false to match ProgramOfferings with no required commitment",
      "type": "boolean"

    },
    "matchLowSalaryRange": {
      "description": "Matches lowSalaryRanges in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "a starting range",
            "type": "string",
            "format": "currency"
          },
          "to": {
            "description": "an ending range",
            "type": "string",
            "format": "currency"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyLowSalaryRange": {
      "description": "Match lowSalaryRanges with any value. true to match Positions with any low salary range, false to match ProgramOfferings with no low salary range",
      "type": "boolean"

    },
    "matchMidpointSalaryRange": {
      "description": "Matches midpointSalaryRanges in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "a starting range",
            "type": "string",
            "format": "currency"
          },
          "to": {
            "description": "an ending range",
            "type": "string",
            "format": "currency"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyMidpointSalaryRange": {
      "description": "Match midpointSalaryRanges with any value. true to match Positions with any midpoint salary range, false to match ProgramOfferings with no midpoint salary range",
      "type": "boolean"

    },
    "matchHighSalaryRange": {
      "description": "Matches highSalaryRanges in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "a starting range",
            "type": "string",
            "format": "currency"
          },
          "to": {
            "description": "an ending range",
            "type": "string",
            "format": "currency"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyHighSalaryRange": {
      "description": "Match highSalaryRanges with any value. true to match Positions with any high salary range, false to match ProgramOfferings with no high salary range",
      "type": "boolean"

    },
    "matchCompensationFrequency": {
      "description": "Matches compensationFrequencys in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "start range",
            "type": "string",
            "format": "duration"
          },
          "to": {
            "description": "end range",
            "type": "string",
            "format": "duration"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyCompensationFrequency": {
      "description": "Match compensationFrequencys with any value. true to match Positions with any compensation frequency, false to match ProgramOfferings with no compensation frequency",
      "type": "boolean"

    },
    "matchExempt": {
      "description": "Match boolean value for exempt.",
      "type": "object",
      "properties": {
        "match": {
          "description": "true for a positive match, false for a negative match",
          "type": "boolean"
        }
      }
    },
    "matchBenefitsType": {
      "description": "List of Type Ids for this query to match benefitsType.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "benefitsTypeType": {
            "description": "type to match",
            "type": "string",
            "format": "osid-type"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchRealmIds": {
      "description": "List of Realm Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "realmId": {
            "description": "Realm id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "realmQueries": {
      "description": "RealmQueries to match Realm. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

Query Parameters

• organizationId: required(string)

  the organization of this metadatum.

  Example:

  personnel.Organization%3A864%40base.url

• genusType: (string)

  specify a particular position type to create

  Example:

  type.Type%3AexamplePositionType%40dxtera.org

• recordType: (array of )

  specify support for one or more position record types

  Example:

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

• realmId: (string)

  specify in which realm to create this position

  Example:

  personnel.Realm%3A8374%40base.url

URI Parameters

• positionId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• positionId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Position",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this position, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this position, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this position for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this position.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this position. 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 position. 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 position.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this position.",
      "type": "string",
      "format": "date-time"
    },
    "organizationId": {
      "description": "The organization associated with this position.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "title": {
      "description": "The title for this position.",
      "type": "string"
    },
    "levelId": {
      "description": "The grade level for this position.",
      "type": "string",
      "format": "osid-id"
    },
    "qualificationIds": {
      "description": "The list of qualifications required for this position.",
      "type": "array",
      "items": {
        "type": "string",
        "format": "osid-id"
      }
    },
    "targetAppointments": {
      "description": "The target number of Appointments desired for this Position.",
      "type": "integer",
      "minimum": 1
    },
    "requiredCommitment": {
      "description": "The required percentage commitment (0-100).",
      "type": "integer",
      "minimum": 1
    },
    "lowSalaryRange": {
      "description": "The low end of the salary range.",
      "type": "string",
      "format": "currency"
    },
    "midpointSalaryRange": {
      "description": "The midpoint of the salary range.",
      "type": "string",
      "format": "currency"
    },
    "highSalaryRange": {
      "description": "The high end of the salary range.",
      "type": "string",
      "format": "currency"
    },
    "compensationFrequency": {
      "description": "The frequency of compensation.",
      "type": "string",
      "format": "duration"
    },
    "exempt": {
      "description": "Tests if this position is FLSA exempt.",
      "type": "boolean"
    },
    "benefitsType": {
      "description": "The benefits Type assoicated with this position.",
      "type": "string",
      "format": "osid-type"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Position",
  "description": "The description of this Position",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "title": "This is the Title",
  "levelId": "grading.Grade:9372@base.url",
  "qualificationIds": [ "learning.Objective:9034@base.url", "..." ],
  "targetAppointments": 19,
  "requiredCommitment": 19,
  "lowSalaryRange": "USD+42.00",
  "midpointSalaryRange": "USD+42.00",
  "highSalaryRange": "USD+42.00",
  "compensationFrequency": "P3DT3H",
  "exempt": true,
  "benefitsType": "type.Type:4629@base.url"
}

URI Parameters

• positionId: required(string)

URI Parameters

• positionId: 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", "person", "position", 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%3AexampleAppointmentType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleAppointmentType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleAppointmentType%40campusapi.org

• fromDate: (string)

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

  Example:

  2020-10-03

• toDate: (string)

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

  Example:

  2020-12-18

• personId: (string)

  the id string to match a person.

  Example:

  personnel.Person%3A594%40base.url

• positionId: (string)

  the id string to match a position.

  Example:

  personnel.Position%3A792%40base.url

• realmId: (string)

  The id string to match a realm

  Example:

  personnel.Realm%3A8374%40base.url

Query Parameters

• personId: required(string)

  the person of this appointment.

  Example:

  personnel.Person%3A594%40base.url

• positionId: required(string)

  the position of this appointment.

  Example:

  personnel.Position%3A792%40base.url

• genusType: (string)

  specify a particular appointment type to create

  Example:

  type.Type%3AexampleAppointmentType%40dxtera.org

• recordType: (array of )

  specify support for one or more appointment record types

  Example:

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

• realmId: (string)

  specify in which realm to create this appointment

  Example:

  personnel.Realm%3A8374%40base.url

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Appointment",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this appointment, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this appointment, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this appointment for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this appointment.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this appointment. 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 appointment. 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 appointment.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this appointment.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this appointment ended.",
      "type": "string",
      "format": "osid-id"
    },
    "personId": {
      "description": "The person associated with this appointment.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "positionId": {
      "description": "The position associated with this appointment.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "commitment": {
      "description": "The percentage commitment (0-100).",
      "type": "integer",
      "minimum": 1
    },
    "title": {
      "description": "The title for this appointment.",
      "type": "string"
    },
    "salary": {
      "description": "The salary.",
      "type": "string",
      "format": "currency"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Appointment",
  "description": "The description of this Appointment",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:7278@base.url",
  "commitment": 19,
  "title": "This is the Title",
  "salary": "USD+42.00"
}

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", "person", "position", 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": "AppointmentQuery",
  "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 Appointments with any end reason, false to match Appointments with no end reason",
      "type": "boolean"
    },
    "matchPersonIds": {
      "description": "List of person Ids for this query to match appointment that have a related person.",
      "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"
          }
        }
      }
    },
    "personQueries": {
      "description": "PersonQueries to match the person. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchPositionIds": {
      "description": "List of position Ids for this query to match appointment that have a related position.",
      "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"
          }
        }
      }
    },
    "positionQueries": {
      "description": "PositionQueries to match the position. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "matchCommitment": {
      "description": "Match Appointments with commitments between the given integers inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "min": {
            "description": "low number",
            "type": "integer"
          },
          "max": {
            "description": "high number",
            "type": "integer"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnyCommitment": {
      "description": "Match commitments with any value. true to match Appointments with any commitment, false to match ProgramOfferings with no commitment",
      "type": "boolean"

    },
    "matchTitle": {
      "description": "List of Title strings to match. Boolean OR performed among multiple titles.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "titles": {
            "description": "titles 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"
          }
        }
      }
    },
    "matchAnyTitle": {
      "description": "Match titles with any value. true to match Appointments with any title, false to match ProgramOfferings with no title",
      "type": "boolean"

    },
    "matchSalary": {
      "description": "Matches salarys in the given range inclusive.",
      "type": "array",
        "items": {
        "type": "object",
        "properties": {
          "from": {
            "description": "a starting range",
            "type": "string",
            "format": "currency"
          },
          "to": {
            "description": "an ending range",
            "type": "string",
            "format": "currency"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "matchAnySalary": {
      "description": "Match salarys with any value. true to match Appointments with any salary, false to match ProgramOfferings with no salary",
      "type": "boolean"

    },
    "matchRealmIds": {
      "description": "List of Realm Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "realmId": {
            "description": "Realm id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "realmQueries": {
      "description": "RealmQueries to match Realm. Each query performs a boolean OR.",
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}

Example:

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

Query Parameters

• personId: required(string)

  the person of this metadatum.

  Example:

  personnel.Person%3A594%40base.url

• positionId: required(string)

  the position of this metadatum.

  Example:

  personnel.Position%3A792%40base.url

• genusType: (string)

  specify a particular appointment type to create

  Example:

  type.Type%3AexampleAppointmentType%40dxtera.org

• recordType: (array of )

  specify support for one or more appointment record types

  Example:

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

• realmId: (string)

  specify in which realm to create this appointment

  Example:

  personnel.Realm%3A8374%40base.url

URI Parameters

• appointmentId: required(string)

Query Parameters

• expand: (string)

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

  Example:

  all

URI Parameters

• appointmentId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Appointment",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this appointment, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this appointment, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this appointment for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this appointment.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this appointment. 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 appointment. 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 appointment.",
      "type": "string",
      "format": "date-time"
    },
    "endDate": {
      "description": "The ending date of this appointment.",
      "type": "string",
      "format": "date-time"
    },
    "endReasonId": {
      "description": "The reason this appointment ended.",
      "type": "string",
      "format": "osid-id"
    },
    "personId": {
      "description": "The person associated with this appointment.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "positionId": {
      "description": "The position associated with this appointment.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "commitment": {
      "description": "The percentage commitment (0-100).",
      "type": "integer",
      "minimum": 1
    },
    "title": {
      "description": "The title for this appointment.",
      "type": "string"
    },
    "salary": {
      "description": "The salary.",
      "type": "string",
      "format": "currency"
    }
  }
}

Example:

{
  "displayName": "Display Name of this Appointment",
  "description": "The description of this Appointment",
  "startDate": "2020-10-03T06:30:00.000Z",
  "endDate": "2020-12-18T19:30:00.000Z",
  "endReasonId": "process.State:7278@base.url",
  "commitment": 19,
  "title": "This is the Title",
  "salary": "USD+42.00"
}

URI Parameters

• appointmentId: required(string)

URI Parameters

• appointmentId: 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%3AexampleRealmType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleRealmType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleRealmType%40campusapi.org

• providerId: (string)

  Id string to match provider.

  Example:

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

• personId: (string)

  Get realms mapped to this person.

  Example:

  personnel.Person%3A270%40demo.dxtera.org

• organizationId: (string)

  Get realms mapped to this organization.

  Example:

  personnel.Organization%3A540%40demo.dxtera.org

• positionId: (string)

  Get realms mapped to this position.

  Example:

  personnel.Position%3A360%40demo.dxtera.org

• appointmentId: (string)

  Get realms mapped to this appointment.

  Example:

  personnel.Appointment%3A495%40demo.dxtera.org

Query Parameters

• genusType: (string)

  specify a particular realm type to create

  Example:

  type.Type%3AexampleRealmType%40dxtera.org

• recordType: (array of )

  specify support for one or more realm record types

  Example:

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

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Realm",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this realm, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this realm, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this realm for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this realm.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this realm. 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 realm. 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 realm.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this realm. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this realm.",
      "type": "string"
    }
  }
}

Example:

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

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": "RealmQuery",
  "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 Realm with any provider, false to match Realm 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 Realm with any branding, false to match Realm 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"
          }
        }
      }
    },
    "matchRealmIds": {
      "description": "List of Realm Id's to match.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "realmId": {
            "description": "Realm id to match",
            "type": "string",
            "format": "osid-id"
          },
          "match": {
            "description": "true for a positive match, false for a negative match",
            "type": "boolean"
          }
        }
      }
    },
    "realmQueries": {
      "description": "RealmQueries to match Realm. 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": "Realm",
  "type": "object",
  "required": ["displayName"],
  "properties": {
    "id": {
      "description": "The unique id of this realm, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this realm, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this realm for display.",
      "type": "string",
      "read-only": false,
      "minLength": 1,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Realm.Realm:displayName@base.url",
      "existingValue": "The Existing Name",
      "elementLabel": "Name",
      "instructions": "Enter a name for this realm",
      "linked": false
    },
    "description": {
      "description": "The description of this realm.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Realm.Realm:displayName@demo.base.url",
      "existingValue": "The Existing Description",
      "elementLabel": "Description",
      "instructions": "Enter a description for this realm",
      "linked": false
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this realm. 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 realm. 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 realm.",
      "type": "string",
      "format": "osid-id",
      "read-only": false,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Realm.Realm:provider@base.url",
      "existingValue": "",
      "elementLabel": "Provider",
      "instructions": "Enter the provider of this realm",
      "linked": false
    },
    "brandingIds": {
      "description": "The branding of this realm. A list of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id",
        "pattern": "",
        "enum": []
      },
      "read-only": false,
      "default": [],
      "elementId": "Realm.Realm:branding@base.url",
      "existingValue": "",
      "elementLabel": "Branding",
      "instructions": "Enter the branding images for this realm",
      "linked": false
    },
    "license": {
      "description": "The licensing that applies to this realm.",
      "type": "string",
      "read-only": false,
      "minLength": 0,
      "maxLength": 128,
      "pattern": "",
      "default": "",
      "enum": [],
      "elementId": "Realm.Realm:license@base.url",
      "existingValue": "The Existing License",
      "elementLabel": "License",
      "instructions": "Include a license for this realm",
      "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": "personnel.Realm:158@base.url",
    "uri": "http://base.url/open/campusapi/personnel/realm/personnel.Realm%3A158%40base.url",
    "displayName": "Display Name of this Realm",
    "description": "The description of this Realm",
    "genusTypeId": "type.Type:defaultRealmType@base.url",
    "recordTypeIds": [ "type.Type:exampleRealmRecordType@campusapi.org", "..."],
    "providerId": "resource.Resource:123@base.url",
    "brandingId": "asset.Asset:Realm@base.url",
    "license": "The license that applies to this Realm"
  },
  {
    "...": "..."
  }
]

HTTP status code 403

Body

Media type: application/json

Type: any

Example:

{"message": "Permission denied" }

URI Parameters

• realmId: required(string)

URI Parameters

• realmId: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Realm",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this realm, provided by system.",
      "type": "string",
      "format": "osid-id",
      "readOnly": true
    },
    "uri": {
      "description": "The uri of this realm, provided by system.",
      "type": "string",
      "format": "uri",
      "readOnly": true
    },
    "displayName": {
      "description": "The name of this realm for display.",
      "type": "string"
    },
    "description": {
      "description": "The description of this realm.",
      "type": "string"
    },
    "genusTypeId": {
      "description": "Id of the immutable type of this realm. 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 realm. 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 realm.",
      "type": "string",
      "format": "osid-id"
    },
    "brandingIds": {
      "description": "The branding of this realm. A collection of Assets.",
      "type": "array",
      "items" : {
        "type": "string",
        "format": "osid-id"
      }
    },
    "license": {
      "description": "The licensing that applies to this realm.",
      "type": "string"
    }
  }
}

Example:

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

URI Parameters

• realmId: required(string)

URI Parameters

• realmId: required(string)

URI Parameters

• realmId: required(string)

URI Parameters

• realmId: required(string)
• childId: required(string)

URI Parameters

• realmId: required(string)
• childId: required(string)

URI Parameters

• realmId: required(string)

URI Parameters

• realmId: 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%3AexamplePersonType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExamplePersonType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexamplePersonType%40campusapi.org

URI Parameters

• realmId: required(string)
• personId: required(string)

URI Parameters

• realmId: required(string)
• personId: required(string)

URI Parameters

• realmId: 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%3AexampleOrganizationType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleOrganizationType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleOrganizationType%40campusapi.org

URI Parameters

• realmId: required(string)
• organizationId: required(string)

URI Parameters

• realmId: required(string)
• organizationId: required(string)

URI Parameters

• realmId: 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", "level", "qualifications", "benefitsType", "organization", 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%3AexamplePositionType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExamplePositionType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexamplePositionType%40campusapi.org

URI Parameters

• realmId: required(string)
• positionId: required(string)

URI Parameters

• realmId: required(string)
• positionId: required(string)

URI Parameters

• realmId: 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", "person", "position", 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%3AexampleAppointmentType%40dxtera.org

• parentGenusTypeId: (string)

  The id string to match a parent genusType

  Example:

  type.Type%3AparentTypeExampleAppointmentType%40dxtera.org

• recordTypeId: (string)

  The id string to match a recordType

  Example:

  type.Type%3AexampleAppointmentType%40campusapi.org

URI Parameters

• realmId: required(string)
• appointmentId: required(string)

URI Parameters

• realmId: required(string)
• appointmentId: required(string)