Page Comparison

{div:style=}[

Wiki Markup

Div

style	font-weight:bold;font-size:1.2em;

Authentication Service Home]{div}

Kuali Authentication Service

Include Page

	Service Meta Table Style Page
	Service Meta Table Style Page

Wiki Markup

{table:id=serviceMetaTable}
{tr}
{th:class=h}Name
{th}
{td:id=serviceName|colspan=2}AuthenticationService
{td}
{tr}
{tr}
{th:class=h}Version
{th}
{td:id=serviceVersion}Dev
{td}
{td:id=serviceVersionHistory}[Release Notes/History|Authentication Service Release Notes#current]
{td}
{tr}
{tr}
{th:class=h}Based upon
{th}
{td:id=serviceName|colspan=2}[KSS AuthenticationService|https://test.kuali.org/confluence/display/KULSTU/Authentication+Service]
{td}
{tr}
{table}

#References

#Operations

#Capabilities

...

title	Notes

...

HTML Table

id	serviceMetaTable

Table Row (tr)

Table Head (th)

class	h

Name

Table Cell (td)

colspan	2
id	serviceName

AuthenticationService

Table Row (tr)

Table Head (th)

class	h

Version

Table Cell (td)

id	serviceVersion

Dev

Table Cell (td)

id	serviceVersionHistory

Release Notes/History

Table Row (tr)

Table Head (th)

class	h

Based upon

Table Cell (td)

colspan	2
id	serviceName

KSS AuthenticationService

#References

#Operations

#Capabilities

Note

title	Notes

References

Authentication Service Structures

...

Panel

borderColor	#cccccc
bgColor	#ffffff
titleBGColor	#eeeeee
title	Setup
borderStyle	solid
title	Setup

Dictionary Operations
#findObjectTypes
#fetchObjectStructure
#fetchEnumeration

Search Operations
#findSearchTypes
#fetchSearchType
#findSearchTypesByResult
#findSearchTypesByCriteria
#findSearchResultTypes
#fetchSearchResultType
#findSearchCriteriaTypes
#fetchSearchCriteriaType

Domain Operations
#findAuthenticationTypes

Panel

borderColor	#cccccc
bgColor	#ffffff
titleBGColor	#eeeeee
title	Read
borderStyle	solid
title	Read

Need to add operation for fetchCurrentUser

#fetchPrincipal
#findPrincipalsByIdList

#fetchPrincipalDisplayInfo
#findPrincipalDisplayInfoByIdList

#findPrincipalIdsByPerson
#findPrincipalIdsBySystem

#fetchPersonIdByPrincipal
#fetchSystemIdByPrincipal Changed Service to System
#fetchPrincipalTypeForPrincipal

#findPrincipalTypesByPrincipalIdList

Panel

borderColor	#cccccc
bgColor	#ffffff
titleBGColor	#eeeeee
title	Search
borderStyle	solid	title	Search

#searchForResults

Panel

title

borderColor	#cccccc
bgColor	#ffffff
titleBGColor	#eeeeee
title	Maintenance
borderStyle	solid	Maintenance

#assignPrincipalToPerson
#assignPrincipalToSystem Changed Service to System
#removePrincipalFromPerson
#removePrincipalFromSystem Changed Service to System

Include Page

	ServiceOperationStart
	ServiceOperationStart

Setup

Anchor

	findObjectTypes
	findObjectTypes

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}findObjectTypes {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves the list of object type identifiers known by this service. Example: cluInfo. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}None {td} {td:class=methodParamName}None {td} {td:class=methodParamDesc}No parameters {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[objectTypeKeyList|objectTypeKeyList Structure] {td} {td:class=methodReturnDesc}list of object type identifiers {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findObjectTypes

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of object type identifiers known by this service. Example: cluInfo.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

None

Table Cell (td)

class	methodParamName

None

Table Cell (td)

class	methodParamDesc

No parameters

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

objectTypeKeyList

Table Cell (td)

class	methodReturnDesc

list of object type identifiers

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	fetchObjectStructure
	fetchObjectStructure

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}fetchObjectStructure {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves the basic dictionary information about a particular object structure. Including all variations based on a certain type and state. Example: Given that a CLU is of type "Course" and in the state of "Proposed," tell which fields are read only, mandatory, not applicable, have enumerations available, etc. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}[objectTypeKey|objectTypeKey Structure] {td} {td:class=methodParamName}objectTypeKey {td} {td:class=methodParamDesc}identifier of the object type {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[objectStructure|objectStructure Structure] {td} {td:class=methodReturnDesc}describes the fields for the input object type {td} {tr} {tr} {th:class=h|rowspan=4}Errors {th} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}specified objectTypeKey not found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid objectTypeKey {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}missing objectTypeKey {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

fetchObjectStructure

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the basic dictionary information about a particular object structure. Including all variations based on a certain type and state. Example: Given that a CLU is of type "Course" and in the state of "Proposed," tell which fields are read only, mandatory, not applicable, have enumerations available, etc.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

objectTypeKey

Table Cell (td)

class	methodParamName

objectTypeKey

Table Cell (td)

class	methodParamDesc

identifier of the object type

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

objectStructure

Table Cell (td)

class	methodReturnDesc

describes the fields for the input object type

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

specified objectTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid objectTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing objectTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	fetchEnumeration
	fetchEnumeration

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}fetchEnumeration {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves the list of enumeration values for a particular enumeration with a certain context for a particular date. The values returned should be those where the supplied date is between the effective and expiration dates. Certain enumerations may not support this functionality. {td} {tr} {tr} {th:class=h|rowspan=4}Parameters {th} {td:class=methodParamType}[enumerationKey|enumerationKey Structure] {td} {td:class=methodParamName}enumerationKey {td} {td:class=methodParamDesc}identifier of the enumeration {td} {tr} {tr} {td:class=methodParamType}[enumContextKey|enumContextKey Structure] {td} {td:class=methodParamName}contextType {td} {td:class=methodParamDesc}identifier of the enumeration context type {td} {tr} {tr} {td:class=methodParamType}[string|string Structure] {td} {td:class=methodParamName}contextValue {td} {td:class=methodParamDesc}value of the enumeration context {td} {tr} {tr} {td:class=methodParamType}[dateTime|dateTime Structure] {td} {td:class=methodParamName}contextDate {td} {td:class=methodParamDesc}date and time to get the enumeration for {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[enumeratedValueList|enumeratedValueList Structure] {td} {td:class=methodReturnDesc}list of enumerated codes and values {td} {tr} {tr} {th:class=h|rowspan=4}Errors {th} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}enumerationKey not found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid enumerationKey, contextType, contextValue, contextDate {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}missing enumerationKey, contextType, contextValue, contextDate {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

fetchEnumeration

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of enumeration values for a particular enumeration with a certain context for a particular date. The values returned should be those where the supplied date is between the effective and expiration dates. Certain enumerations may not support this functionality.

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Parameters

Table Cell (td)

class	methodParamType

enumerationKey

Table Cell (td)

class	methodParamName

enumerationKey

Table Cell (td)

class	methodParamDesc

identifier of the enumeration

Table Row (tr)

Table Cell (td)

class	methodParamType

enumContextKey

Table Cell (td)

class	methodParamName

contextType

Table Cell (td)

class	methodParamDesc

identifier of the enumeration context type

Table Row (tr)

Table Cell (td)

class	methodParamType

string

Table Cell (td)

class	methodParamName

contextValue

Table Cell (td)

class	methodParamDesc

value of the enumeration context

Table Row (tr)

Table Cell (td)

class	methodParamType

dateTime

Table Cell (td)

class	methodParamName

contextDate

Table Cell (td)

class	methodParamDesc

date and time to get the enumeration for

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

enumeratedValueList

Table Cell (td)

class	methodReturnDesc

list of enumerated codes and values

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

enumerationKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid enumerationKey, contextType, contextValue, contextDate

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing enumerationKey, contextType, contextValue, contextDate

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	findSearchTypes
	findSearchTypes

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}findSearchTypes {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves the list of search types known by this service. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}None {td} {td:class=methodParamName}None {td} {td:class=methodParamDesc}No Parameters {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[searchTypeInfoList|searchTypeInfoList Structure] {td} {td:class=methodReturnDesc}list of search type information {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findSearchTypes

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of search types known by this service.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

None

Table Cell (td)

class	methodParamName

None

Table Cell (td)

class	methodParamDesc

No Parameters

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

searchTypeInfoList

Table Cell (td)

class	methodReturnDesc

list of search type information

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	fetchSearchType
	fetchSearchType

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}fetchSearchType {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves information about a particular search type. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}[searchTypeKey|searchTypeKey Structure] {td} {td:class=methodParamName}searchTypeKey {td} {td:class=methodParamDesc}identifier of the search type {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[searchTypeInfo|searchTypeInfo Structure] {td} {td:class=methodReturnDesc}information on the search type {td} {tr} {tr} {th:class=h|rowspan=4}Errors {th} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}specified searchTypeKey not found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid searchTypeKey {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}searchTypeKey not specified {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

fetchSearchType

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves information about a particular search type.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

searchTypeKey

Table Cell (td)

class	methodParamName

searchTypeKey

Table Cell (td)

class	methodParamDesc

identifier of the search type

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

searchTypeInfo

Table Cell (td)

class	methodReturnDesc

information on the search type

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

specified searchTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid searchTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

searchTypeKey not specified

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	findSearchTypesByResult
	findSearchTypesByResult

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}findSearchTypesByResult {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves the list of search types which return results in the specified format. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}[searchResultTypeKey|searchResultTypeKey Structure] {td} {td:class=methodParamName}searchResultTypeKey {td} {td:class=methodParamDesc}identifier of the search result type {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[searchTypeInfoList|searchTypeInfoList Structure] {td} {td:class=methodReturnDesc}list of search type information {td} {tr} {tr} {th:class=h|rowspan=4}Errors {th} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}specified searchResultTypeKey not found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid searchResultTypeKey {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}searchResultTypeKey not specified {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findSearchTypesByResult

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of search types which return results in the specified format.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

searchResultTypeKey

Table Cell (td)

class	methodParamName

searchResultTypeKey

Table Cell (td)

class	methodParamDesc

identifier of the search result type

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

searchTypeInfoList

Table Cell (td)

class	methodReturnDesc

list of search type information

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

specified searchResultTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid searchResultTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

searchResultTypeKey not specified

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	findSearchTypesByCriteria
	findSearchTypesByCriteria

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}findSearchTypesByCriteria {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves the list of search types which use criteria in the specified format. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}[searchCriteriaTypeKey|searchCriteriaTypeKey Structure] {td} {td:class=methodParamName}searchCriteriaTypeKey {td} {td:class=methodParamDesc}identifier of the search criteria {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[searchTypeInfoList|searchTypeInfoList Structure] {td} {td:class=methodReturnDesc}list of search type information {td} {tr} {tr} {th:class=h|rowspan=4}Errors {th} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}specified searchCriteriaTypeKey not found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid searchCriteriaTypeKey {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}searchCriteriaTypeKey not specified {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findSearchTypesByCriteria

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of search types which use criteria in the specified format.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

searchCriteriaTypeKey

Table Cell (td)

class	methodParamName

searchCriteriaTypeKey

Table Cell (td)

class	methodParamDesc

identifier of the search criteria

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

searchTypeInfoList

Table Cell (td)

class	methodReturnDesc

list of search type information

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

specified searchCriteriaTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid searchCriteriaTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

searchCriteriaTypeKey not specified

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	findSearchResultTypes
	findSearchResultTypes

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}findSearchResultTypes {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves the list of search result types known by this service. Search result types describe the return structure for a search. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}None {td} {td:class=methodParamName}None {td} {td:class=methodParamDesc}No Parameters {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[searchResultTypeInfoList|searchResultTypeInfoList Structure] {td} {td:class=methodReturnDesc}list of search result type information {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findSearchResultTypes

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of search result types known by this service. Search result types describe the return structure for a search.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

None

Table Cell (td)

class	methodParamName

None

Table Cell (td)

class	methodParamDesc

No Parameters

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

searchResultTypeInfoList

Table Cell (td)

class	methodReturnDesc

list of search result type information

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	fetchSearchResultType
	fetchSearchResultType

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}fetchSearchResultType {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves information about a particular search result type. Search result types describe the return structure for a search. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}[searchResultTypeKey|searchResultTypeKey Structure] {td} {td:class=methodParamName}searchResultTypeKey {td} {td:class=methodParamDesc}identifier of the search result type {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[searchResultTypeInfo|searchResultTypeInfo Structure] {td} {td:class=methodReturnDesc}information on the search result type {td} {tr} {tr} {th:class=h|rowspan=4}Errors {th} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}specified searchResultTypeKey not found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid searchResultTypeKey {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}searchResultTypeKey not specified {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

fetchSearchResultType

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves information about a particular search result type. Search result types describe the return structure for a search.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

searchResultTypeKey

Table Cell (td)

class	methodParamName

searchResultTypeKey

Table Cell (td)

class	methodParamDesc

identifier of the search result type

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

searchResultTypeInfo

Table Cell (td)

class	methodReturnDesc

information on the search result type

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

specified searchResultTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid searchResultTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

searchResultTypeKey not specified

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	findSearchCriteriaTypes
	findSearchCriteriaTypes

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}findSearchCriteriaTypes {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves the list of search criteria types known by this service. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}None {td} {td:class=methodParamName}None {td} {td:class=methodParamDesc}No parameters {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[searchCriteriaTypeInfoList|searchCriteriaTypeInfoList Structure] {td} {td:class=methodReturnDesc}list of search criteria type information {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findSearchCriteriaTypes

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of search criteria types known by this service.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

None

Table Cell (td)

class	methodParamName

None

Table Cell (td)

class	methodParamDesc

No parameters

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

searchCriteriaTypeInfoList

Table Cell (td)

class	methodReturnDesc

list of search criteria type information

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	fetchSearchCriteriaType
	fetchSearchCriteriaType

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}fetchSearchCriteriaType {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves information about a particular search criteria type. {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}[searchCriteriaTypeKey|searchCriteriaTypeKey Structure] {td} {td:class=methodParamName}searchCriteriaTypeKey {td} {td:class=methodParamDesc}identifier of the search criteria type {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[searchCriteriaTypeInfo|searchCriteriaTypeInfo Structure] {td} {td:class=methodReturnDesc}information on the search criteria type {td} {tr} {tr} {th:class=h|rowspan=4}Errors {th} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}specified searchCriteriaTypeKey not found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid searchCriteriaTypeKey {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}searchCriteriaTypeKey not specified {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

fetchSearchCriteriaType

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves information about a particular search criteria type.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

searchCriteriaTypeKey

Table Cell (td)

class	methodParamName

searchCriteriaTypeKey

Table Cell (td)

class	methodParamDesc

identifier of the search criteria type

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

searchCriteriaTypeInfo

Table Cell (td)

class	methodReturnDesc

information on the search criteria type

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

specified searchCriteriaTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid searchCriteriaTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

searchCriteriaTypeKey not specified

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	findAuthenticationTypes
	findAuthenticationTypes

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}findAuthenticationTypes {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieve the list of authentication types known by this service {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}None {td} {td:class=methodParamName}None {td} {td:class=methodParamDesc}No parameters {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[authenticationTypeList|authenticationTypeList Structure] {td} {td:class=methodReturnDesc}list of authentication types {td} {tr} {tr} {th:class=h|rowspan=1}Errors {th} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findAuthenticationTypes

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieve the list of authentication types known by this service

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

None

Table Cell (td)

class	methodParamName

None

Table Cell (td)

class	methodParamDesc

No parameters

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

authenticationTypeList

Table Cell (td)

class	methodReturnDesc

list of authentication types

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Read

Anchor

	findPrincipalIdsByPerson
	findPrincipalIdsByPerson

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}findPrincipalIdsByPerson {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves a list of Principals for a given Person {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}[personId|personId Structure] {td} {td:class=methodParamName}personId {td} {td:class=methodParamDesc}person identifier {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[principalIdList|principalIdList Structure] {td} {td:class=methodReturnDesc}list of principal ids for the specified person {td} {tr} {tr} {th:class=h|rowspan=6}Errors {th} {td:class=methodErrorType|colspan=2}DISABLED_IDENTIFIER {td} {td:class=methodErrorDesc}personId found but has been retired {td} {tr} {tr} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}personId not found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid personId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}missing personId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {td:class=methodErrorType|colspan=2}PERMISSION_DENIED {td} {td:class=methodErrorDesc}authorization failure {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findPrincipalIdsByPerson

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves a list of Principals for a given Person

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

personId

Table Cell (td)

class	methodParamName

personId

Table Cell (td)

class	methodParamDesc

person identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

principalIdList

Table Cell (td)

class	methodReturnDesc

list of principal ids for the specified person

Table Row (tr)

Table Head (th)

rowspan	6
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DISABLED_IDENTIFIER

Table Cell (td)

class	methodErrorDesc

personId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

personId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid personId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing personId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PERMISSION_DENIED

Table Cell (td)

class	methodErrorDesc

authorization failure

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	findPrincipalIdsBySystem
	findPrincipalIdsBySystem

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}findPrincipalIdsBySystem {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves a list of Principals for a given System {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}[systemId|systemId Structure] {td} {td:class=methodParamName}systemId {td} {td:class=methodParamDesc}system identifier {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[principalIdList|principalIdList Structure] {td} {td:class=methodReturnDesc}list of principal ids for the given system {td} {tr} {tr} {th:class=h|rowspan=6}Errors {th} {td:class=methodErrorType|colspan=2}DISABLED_IDENTIFIER {td} {td:class=methodErrorDesc}systemId found but has been retired {td} {tr} {tr} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}systemId not found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid systemId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}missing systemId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {td:class=methodErrorType|colspan=2}PERMISSION_DENIED {td} {td:class=methodErrorDesc}authorization failure {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findPrincipalIdsBySystem

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves a list of Principals for a given System

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

systemId

Table Cell (td)

class	methodParamName

systemId

Table Cell (td)

class	methodParamDesc

system identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

principalIdList

Table Cell (td)

class	methodReturnDesc

list of principal ids for the given system

Table Row (tr)

Table Head (th)

rowspan	6
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DISABLED_IDENTIFIER

Table Cell (td)

class	methodErrorDesc

systemId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

systemId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid systemId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing systemId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PERMISSION_DENIED

Table Cell (td)

class	methodErrorDesc

authorization failure

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	fetchPersonIdByPrincipal
	fetchPersonIdByPrincipal

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}fetchPersonIdByPrincipal {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves a Person for a given Principal {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}[principalId|principalId Structure] {td} {td:class=methodParamName}principalId {td} {td:class=methodParamDesc}principal identifier {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[personId|personId Structure] {td} {td:class=methodReturnDesc}person identifier that matches the supplied criteria {td} {tr} {tr} {th:class=h|rowspan=6}Errors {th} {td:class=methodErrorType|colspan=2}DISABLED_IDENTIFIER {td} {td:class=methodErrorDesc}principalId found but has been retired {td} {tr} {tr} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}principalId not found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid principalId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}missing principalId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {td:class=methodErrorType|colspan=2}PERMISSION_DENIED {td} {td:class=methodErrorDesc}authorization failure {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

fetchPersonIdByPrincipal

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves a Person for a given Principal

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

principalId

Table Cell (td)

class	methodParamName

principalId

Table Cell (td)

class	methodParamDesc

principal identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

personId

Table Cell (td)

class	methodReturnDesc

person identifier that matches the supplied criteria

Table Row (tr)

Table Head (th)

rowspan	6
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DISABLED_IDENTIFIER

Table Cell (td)

class	methodErrorDesc

principalId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

principalId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid principalId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing principalId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PERMISSION_DENIED

Table Cell (td)

class	methodErrorDesc

authorization failure

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	fetchSystemIdByPrincipal
	fetchSystemIdByPrincipal

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}fetchSystemByPrincipal {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves a System for a given Principal {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}[principalId|principalId Structure] {td} {td:class=methodParamName}principalId {td} {td:class=methodParamDesc}principal identifier {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[systemId|systemId Structure] {td} {td:class=methodReturnDesc}system identifier that matches the supplied criteria {td} {tr} {tr} {th:class=h|rowspan=6}Errors {th} {td:class=methodErrorType|colspan=2}DISABLED_IDENTIFIER {td} {td:class=methodErrorDesc}systemId found but has been retired {td} {tr} {tr} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}systemId not found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid principalId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}missing principalId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {td:class=methodErrorType|colspan=2}PERMISSION_DENIED {td} {td:class=methodErrorDesc}authorization failure {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

fetchSystemByPrincipal

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves a System for a given Principal

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

principalId

Table Cell (td)

class	methodParamName

principalId

Table Cell (td)

class	methodParamDesc

principal identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

systemId

Table Cell (td)

class	methodReturnDesc

system identifier that matches the supplied criteria

Table Row (tr)

Table Head (th)

rowspan	6
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DISABLED_IDENTIFIER

Table Cell (td)

class	methodErrorDesc

systemId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

systemId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid principalId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing principalId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PERMISSION_DENIED

Table Cell (td)

class	methodErrorDesc

authorization failure

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	fetchPrincipalTypeForPrincipal
	fetchPrincipalTypeForPrincipal

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}fetchPrincipalTypeForPrincipal {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves a Principal Type for a given Principal {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}[principalId|principalId Structure] {td} {td:class=methodParamName}principalId {td} {td:class=methodParamDesc}principal identifier {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[principalType|principalType Structure] {td} {td:class=methodReturnDesc}principal type that matches the supplied criteria {td} {tr} {tr} {th:class=h|rowspan=6}Errors {th} {td:class=methodErrorType|colspan=2}DISABLED_IDENTIFIER {td} {td:class=methodErrorDesc}principalId found but has been retired {td} {tr} {tr} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}principalId not found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid principalId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}missing principalId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {td:class=methodErrorType|colspan=2}PERMISSION_DENIED {td} {td:class=methodErrorDesc}authorization failure {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

fetchPrincipalTypeForPrincipal

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves a Principal Type for a given Principal

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

principalId

Table Cell (td)

class	methodParamName

principalId

Table Cell (td)

class	methodParamDesc

principal identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

principalType

Table Cell (td)

class	methodReturnDesc

principal type that matches the supplied criteria

Table Row (tr)

Table Head (th)

rowspan	6
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DISABLED_IDENTIFIER

Table Cell (td)

class	methodErrorDesc

principalId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

principalId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid principalId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing principalId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PERMISSION_DENIED

Table Cell (td)

class	methodErrorDesc

authorization failure

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	findPrincipalTypesByPrincipalIdList
	findPrincipalTypesByPrincipalIdList

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}findPrincipalTypesByPrincipalIdList {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves a list of Principal Types for a given list of Principal Ids {td} {tr} {tr} {th:class=h|rowspan=1}Parameters {th} {td:class=methodParamType}[principalIdList|principalIdList Structure] {td} {td:class=methodParamName}principalIdList {td} {td:class=methodParamDesc}list of principal identifiers {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[principalTypeList|principalTypeList Structure] {td} {td:class=methodReturnDesc}List of principal types that match the supplied criteria {td} {tr} {tr} {th:class=h|rowspan=6}Errors {th} {td:class=methodErrorType|colspan=2}DISABLED_IDENTIFIER {td} {td:class=methodErrorDesc}One or more principalIds found but have been retired {td} {tr} {tr} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}One or more principalIds not found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid principalIdList {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}missing principalId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {td:class=methodErrorType|colspan=2}PERMISSION_DENIED {td} {td:class=methodErrorDesc}authorization failure {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

findPrincipalTypesByPrincipalIdList

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves a list of Principal Types for a given list of Principal Ids

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

principalIdList

Table Cell (td)

class	methodParamName

principalIdList

Table Cell (td)

class	methodParamDesc

list of principal identifiers

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

principalTypeList

Table Cell (td)

class	methodReturnDesc

List of principal types that match the supplied criteria

Table Row (tr)

Table Head (th)

rowspan	6
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DISABLED_IDENTIFIER

Table Cell (td)

class	methodErrorDesc

One or more principalIds found but have been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

One or more principalIds not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid principalIdList

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing principalId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PERMISSION_DENIED

Table Cell (td)

class	methodErrorDesc

authorization failure

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Search

Anchor

	searchForResults
	searchForResults

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}searchForResults {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Retrieves results in tabular form for the specified parameters. {td} {tr} {tr} {th:class=h|rowspan=2}Parameters {th} {td:class=methodParamType}[searchTypeKey|searchTypeKey Structure] {td} {td:class=methodParamName}searchTypeKey {td} {td:class=methodParamDesc}search identifier {td} {tr} {tr} {td:class=methodParamType}[queryParamValueList|queryParamValueList Structure] {td} {td:class=methodParamName}queryParamValues {td} {td:class=methodParamDesc}list of values for search parameters {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[resultList|resultList Structure] {td} {td:class=methodReturnDesc}list of results from the query {td} {tr} {tr} {th:class=h|rowspan=5}Errors {th} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}specified search type not found {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid searchTypeKey, queryParamValueList {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}searchTypeKey, queryParamValueList not specified {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {td:class=methodErrorType|colspan=2}PERMISSION_DENIED {td} {td:class=methodErrorDesc}authorization failure {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

searchForResults

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves results in tabular form for the specified parameters.

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

searchTypeKey

Table Cell (td)

class	methodParamName

searchTypeKey

Table Cell (td)

class	methodParamDesc

search identifier

Table Row (tr)

Table Cell (td)

class	methodParamType

queryParamValueList

Table Cell (td)

class	methodParamName

queryParamValues

Table Cell (td)

class	methodParamDesc

list of values for search parameters

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

resultList

Table Cell (td)

class	methodReturnDesc

list of results from the query

Table Row (tr)

Table Head (th)

rowspan	5
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

specified search type not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid searchTypeKey, queryParamValueList

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

searchTypeKey, queryParamValueList not specified

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PERMISSION_DENIED

Table Cell (td)

class	methodErrorDesc

authorization failure

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Maintenance

Anchor

	assignPrincipalToPerson
	assignPrincipalToPerson

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}assignPrincipalToPerson {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Assigns a Principal to a Person {td} {tr} {tr} {th:class=h|rowspan=2}Parameters {th} {td:class=methodParamType}[principalId|principalId Structure] {td} {td:class=methodParamName}principalId {td} {td:class=methodParamDesc}principal identifier {td} {tr} {tr} {td:class=methodParamType}[personId|personId Structure] {td} {td:class=methodParamName}personId {td} {td:class=methodParamDesc}person identifier {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[status|status Structure] {td} {td:class=methodReturnDesc}status of the operation {td} {tr} {tr} {th:class=h|rowspan=7}Errors {th} {td:class=methodErrorType|colspan=2}ALREADY_EXISTS {td} {td:class=methodErrorDesc}association already exists {td} {tr} {tr} {td:class=methodErrorType|colspan=2}DISABLED_IDENTIFIER {td} {td:class=methodErrorDesc}personId or principalId found but has been retired {td} {tr} {tr} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}personId, principalId does not exist {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid personId, principalId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}missing personId, principalId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {td:class=methodErrorType|colspan=2}PERMISSION_DENIED {td} {td:class=methodErrorDesc}authorization failure {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

assignPrincipalToPerson

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Assigns a Principal to a Person

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

principalId

Table Cell (td)

class	methodParamName

principalId

Table Cell (td)

class	methodParamDesc

principal identifier

Table Row (tr)

Table Cell (td)

class	methodParamType

personId

Table Cell (td)

class	methodParamName

personId

Table Cell (td)

class	methodParamDesc

person identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

status

Table Cell (td)

class	methodReturnDesc

status of the operation

Table Row (tr)

Table Head (th)

rowspan	7
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

ALREADY_EXISTS

Table Cell (td)

class	methodErrorDesc

association already exists

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DISABLED_IDENTIFIER

Table Cell (td)

class	methodErrorDesc

personId or principalId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

personId, principalId does not exist

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid personId, principalId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing personId, principalId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PERMISSION_DENIED

Table Cell (td)

class	methodErrorDesc

authorization failure

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	assignPrincipalToSystem
	assignPrincipalToSystem

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}assignPrincipalToSystem {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Assigns a Principal to a System {td} {tr} {tr} {th:class=h|rowspan=2}Parameters {th} {td:class=methodParamType}[principalId|principalId Structure] {td} {td:class=methodParamName}principalId {td} {td:class=methodParamDesc}principal identifier {td} {tr} {tr} {td:class=methodParamType}[systemId|systemId Structure] {td} {td:class=methodParamName}systemId {td} {td:class=methodParamDesc}system identifier {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[status|status Structure] {td} {td:class=methodReturnDesc}status of the operation {td} {tr} {tr} {th:class=h|rowspan=7}Errors {th} {td:class=methodErrorType|colspan=2}ALREADY_EXISTS {td} {td:class=methodErrorDesc}association already exists {td} {tr} {tr} {td:class=methodErrorType|colspan=2}DISABLED_IDENTIFIER {td} {td:class=methodErrorDesc}principalId, systemId found but has been retired {td} {tr} {tr} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}principalId, systemId does not exist {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid principalId, systemId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}missing principalId, systemId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {td:class=methodErrorType|colspan=2}PERMISSION_DENIED {td} {td:class=methodErrorDesc}authorization failure {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

assignPrincipalToSystem

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Assigns a Principal to a System

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

principalId

Table Cell (td)

class	methodParamName

principalId

Table Cell (td)

class	methodParamDesc

principal identifier

Table Row (tr)

Table Cell (td)

class	methodParamType

systemId

Table Cell (td)

class	methodParamName

systemId

Table Cell (td)

class	methodParamDesc

system identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

status

Table Cell (td)

class	methodReturnDesc

status of the operation

Table Row (tr)

Table Head (th)

rowspan	7
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

ALREADY_EXISTS

Table Cell (td)

class	methodErrorDesc

association already exists

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DISABLED_IDENTIFIER

Table Cell (td)

class	methodErrorDesc

principalId, systemId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

principalId, systemId does not exist

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid principalId, systemId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing principalId, systemId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PERMISSION_DENIED

Table Cell (td)

class	methodErrorDesc

authorization failure

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	removePrincipalFromPerson
	removePrincipalFromPerson

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}removePrincipalFromPerson {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Remove a Principal from a Person {td} {tr} {tr} {th:class=h|rowspan=2}Parameters {th} {td:class=methodParamType}[principalId|principalId Structure] {td} {td:class=methodParamName}principalId {td} {td:class=methodParamDesc}principal identifier {td} {tr} {tr} {td:class=methodParamType}[personId|personId Structure] {td} {td:class=methodParamName}personId {td} {td:class=methodParamDesc}person identifier {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[status|status Structure] {td} {td:class=methodReturnDesc}status of the operation {td} {tr} {tr} {th:class=h|rowspan=6}Errors {th} {td:class=methodErrorType|colspan=2}DISABLED_IDENTIFIER {td} {td:class=methodErrorDesc}personId or principalId found but has been retired {td} {tr} {tr} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}personId, principalId, association does not exist {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid personId, principalId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}missing personId, principalId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {td:class=methodErrorType|colspan=2}PERMISSION_DENIED {td} {td:class=methodErrorDesc}authorization failure {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

removePrincipalFromPerson

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Remove a Principal from a Person

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

principalId

Table Cell (td)

class	methodParamName

principalId

Table Cell (td)

class	methodParamDesc

principal identifier

Table Row (tr)

Table Cell (td)

class	methodParamType

personId

Table Cell (td)

class	methodParamName

personId

Table Cell (td)

class	methodParamDesc

person identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

status

Table Cell (td)

class	methodReturnDesc

status of the operation

Table Row (tr)

Table Head (th)

rowspan	6
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DISABLED_IDENTIFIER

Table Cell (td)

class	methodErrorDesc

personId or principalId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

personId, principalId, association does not exist

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid personId, principalId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing personId, principalId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PERMISSION_DENIED

Table Cell (td)

class	methodErrorDesc

authorization failure

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	removePrincipalFromSystem
	removePrincipalFromSystem

{table:class=methodTable} {tr} {th:class=h}Method {th} {td:class=methodName|colspan=3}removePrincipalFromSystem {td} {tr} {tr} {th:class=h}Description {th} {td:class=methodDesc|colspan=3}Remove a Principal from a System {td} {tr} {tr} {th:class=h|rowspan=2}Parameters {th} {td:class=methodParamType}[principalId|principalId Structure] {td} {td:class=methodParamName}principalId {td} {td:class=methodParamDesc}principal identifier {td} {tr} {tr} {td:class=methodParamType}[systemId|systemId Structure] {td} {td:class=methodParamName}systemId {td} {td:class=methodParamDesc}system identifier {td} {tr} {tr} {th:class=h}Return {th} {td:class=methodReturnType|colspan=2}[status|status Structure] {td} {td:class=methodReturnDesc}status of the operation {td} {tr} {tr} {th:class=h|rowspan=6}Errors {th} {td:class=methodErrorType|colspan=2}DISABLED_IDENTIFIER {td} {td:class=methodErrorDesc}principalId, systemId found but has been retired {td} {tr} {tr} {td:class=methodErrorType|colspan=2}DOES_NOT_EXIST {td} {td:class=methodErrorDesc}principalId, systemId, association does not exist {td} {tr} {tr} {td:class=methodErrorType|colspan=2}INVALID_PARAMETER {td} {td:class=methodErrorDesc}invalid principalId, systemId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}MISSING_PARAMETER {td} {td:class=methodErrorDesc}missing principalId, systemId {td} {tr} {tr} {td:class=methodErrorType|colspan=2}OPERATION_FAILED {td} {td:class=methodErrorDesc}unable to complete request {td} {tr} {tr} {td:class=methodErrorType|colspan=2}PERMISSION_DENIED {td} {td:class=methodErrorDesc}authorization failure {td} {tr} {tr} {th:class=h}Capabilities {th} {td:class=capabilityDesc|colspan=3} {td} {tr} {tr} {th:class=h}Use Cases {th} {td:class=usecaseDesc|colspan=3} {td} {tr} {tr} {th:class=h}Comments/Feedback {th} {td:class=commentsDesc|colspan=3} {td} {tr} {table}

Wiki Markup

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

removePrincipalFromSystem

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Remove a Principal from a System

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

principalId

Table Cell (td)

class	methodParamName

principalId

Table Cell (td)

class	methodParamDesc

principal identifier

Table Row (tr)

Table Cell (td)

class	methodParamType

systemId

Table Cell (td)

class	methodParamName

systemId

Table Cell (td)

class	methodParamDesc

system identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

status

Table Cell (td)

class	methodReturnDesc

status of the operation

Table Row (tr)

Table Head (th)

rowspan	6
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DISABLED_IDENTIFIER

Table Cell (td)

class	methodErrorDesc

principalId, systemId found but has been retired

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

principalId, systemId, association does not exist

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid principalId, systemId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing principalId, systemId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OPERATION_FAILED

Table Cell (td)

class	methodErrorDesc

unable to complete request

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PERMISSION_DENIED

Table Cell (td)

class	methodErrorDesc

authorization failure

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Include Page

	ServiceOperationStop
	ServiceOperationStop

...

Versions Compared

Old Version 17

New Version 18

Key

Kuali Authentication Service

References

Setup

Read

Search

Maintenance