get-subject-avatar

Specification Version

Version: "1"

Context and rules

Required for the SubjectRead capability when the subject avatar feature is enabled.

Returns a subject's avatar as a stream when an ExternalSubjectId is passed in.

Supported Image Content Types

Only image content types are supported.

For a complete list of image media types, please refer to the Image Media Types documentation.

Endpoint specification

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

Input

• Format: JSON
• Schema:

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"title": "get-subject-avatar",
	"type": "object",
	"properties": {
		"Lookup": {
			"type": "object",
			"properties": {
				"ExternalSubjectId": {
					"type": "string"
				},
				"LookupExpression": {
					"type": ["string", "null"]
				}
			},
			"required": [
				"ExternalSubjectId",
				"LookupExpression"
			]
		}
	},
	"required": [
		"Lookup"
	]
}

• Example:

{
  "Lookup": {
    "ExternalSubjectId": "subj-145",
    "LookupExpression": null
  }
}

Response

• Format: Stream

Previous versions

None