get-structure-types

Specification Version

Version: "1"

Context and rules

Required for the SubjectRead capability.

Returns details of structure types when an array of structure type keys is passed in.

Endpoint specification

• Name: endpoint-prefix-aireframe-get-structure-types
• Verb: POST
• Authentication: Client credentials

Input

• Format: JSON
• Schema:

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"title": "get-structure-types-input",
	"type": "object",
	"properties": {
		"Keys": {
			"type": "array",
			"items": {
				"type": "string"
			}
		}
	},
	"required": [
		"Keys"
	]
}

• Example:

{
	"Keys": [
		"division",
		"dept"
	]
}

Response

• Format: JSON
• Schema:

{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"title": "get-structure-types-response",
	"type": "object",
	"properties": {
		"StructureTypes": {
			"type": "array",
			"items": {
				"required": [
					"Key",
					"DisplayName",
					"IsSubjectAssignable"
				],
				"properties": {
					"Key": {
						"type": "string"
					},
					"DisplayName": {
						"type": "string"
					},
					"IsSubjectAssignable": {
						"type": "boolean"
					},
					"CustomFields": {
						"type": "array",
						"items": {
							"type": "object",
							"properties": {
								"Key": {
									"type": "string"
								},
								"Name": {
									"type": "string"
								},
								"IsRequired": {
									"type": "boolean"
								},
								"FieldType": {
									"type": "string",
									"enum": [
										"Text",
										"Email",
										"Number",
										"PhoneNumber",
										"DateTime",
										"Date",
										"Time",
										"UserIdentifier"
									]
								}
							},
							"required": [
								"Key",
								"DisplayName",
								"IsRequired",
								"FieldType"
							]
						}
					}
				}
			}
		}
	},
	"required": [
		"StructureTypes"
	]
}

• Example

{
	"StructureTypes": [
		{
			"Key": "division",
			"DisplayName": "Division",
			"IsSubjectAssignable": true
		},
		{
			"Key": "dept",
			"DisplayName": "Department",
			"IsSubjectAssignable": true
		}
	]
}

Previous versions

None