get-subject-structural-entities

Specification Version

Version: "1"

Context and rules

Required for the SubjectRead capability.

Returns the key property of any structural entities to which the subject is assigned.

The structural entity keys should be compatible with the get-structure-entities endpoint.

The external ID passed in for the subject corresponds to the value returned for the property ExternalSubjectId by the get-subjects endpoint.

Endpoint specification

• Name: endpoint-prefix-aireframe-get-subject-structural-entities
• Verb: POST
• Authentication: Client credentials

Input

• Format: JSON
• Schema:

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"title": "get-subject-structural-entities-input",
	"type": "object",
	"properties": {
		"ExternalId": {
			"type": "string"
		}
	},
	"required": [
		"ExternalId"
	]
}

• Example:

{
	"ExternalId": "subj-145"
}

Response

• Format: JSON
• Schema:

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"title": "get-subject-structural-entities-response",
	"type": "object",
	"properties": {
		"StructuralEntities": {
			"type": "array",
			"items": {
				"required": [
					"Key"
				],
				"properties": {
					"Key": {
						"type": "string"
					}
				}
			}
		}
	},
	"required": [
		"StructuralEntities"
	]
}

• Example

{
	"StructuralEntities": [
		{
			"Key": "AAC"
		}
	]
}

Previous versions

None