Page Comparison

CollectionObject Service

Include Page

	SDRcollectionspace:Service Meta Table Style PageSDR
	collectionspace:Service Meta Table Style Page

Note

title	Note:

This is a draft page, exploring the structure and layout of the service description. There is a fair amount of cruft from a copy of a template used by KSS, so do not take the details here too seriously at this point.In particular, we are missing the style and

macro extensions in our Confluence installation. Once we fix that, the page will look a lot better!

HTML Table

id	serviceMetaTable

Table Row (tr)

Table Head (th)

class	h

Name

Table Cell (td)

colspan	2
id	serviceName

CollectionObject

Table Row (tr)

Table Head (th)

class	h

Version

Table Cell (td)

id	serviceVersion

Dev

Table Cell (td)

id	serviceVersionHistory

Release Notes/History

#References

#Operations

#Capabilities

Insert excerpt

	SDR:CollectionObject Service Description and AssumptionsSDR:
	CollectionObject Service Description and Assumptions

...

CollectionObject Service Description and Assumptions
CollectionObject Service Entity Diagram - diagram which matches understandings/concepts described through the service switch to versioned link when publishing
CollectionObject Service Stack

Operations

Include Page

	SDRcollectionspace:Method Table Style PageSDR
	collectionspace:Method Table Style Page

Panel

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

Dictionary Operations
#getObjectTypes
#getObjectStructure

Search Operations
#getSearchTypes
#getSearchType
#getSearchTypesByResult
#getSearchTypesByCriteria
#getSearchResultTypes
#getSearchResultType
#getSearchCriteriaTypes
#getSearchCriteriaType

Domain Operations
#getCollObjHierarchies
#getCollObjHierarchy

#getCollObjTypes
#getCollObjType

#getCollObjCollObjRelationTypes
#getCollObjCollObjRelationType

#getCollObjRelationTypesForCollObjType
#getCollObjCollObjRelationTypesForCollObjHierarchy

...

Panel

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

#createCollObj
#updateCollObj
#deleteCollObj

#createCollObjCollObjRelation
#updateCollObjCollObjRelation
#removeCollObjCollObjRelation

Include Page

	SDR:ServiceOperationStartSDR:
	ServiceOperationStart

Setup

Anchor

	getObjectTypes
	getObjectTypes

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getObjectTypes

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: fooInfo.

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 /wiki/spaces/collectionspace/pages/666274931

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getObjectStructure

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 /wiki/spaces/collectionspace/pages/666274955

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 /wiki/spaces/collectionspace/pages/666274927

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getEnumeration

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 /wiki/spaces/collectionspace/pages/666274894

Table Cell (td)

class	methodParamName

enumerationKey

Table Cell (td)

class	methodParamDesc

identifier of the enumeration

Table Row (tr)

Table Cell (td)

class	methodParamType

enumContextKey /wiki/spaces/collectionspace/pages/666274903

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 /wiki/spaces/collectionspace/pages/666274808

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 /wiki/spaces/collectionspace/pages/666274812

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 /wiki/spaces/collectionspace/pages/666274883

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getSearchTypes

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

class	methodReturnType

/wiki/spaces/collectionspace/pages/666274914

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getSearchType

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 /wiki/spaces/collectionspace/pages/666275028

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 /wiki/spaces/collectionspace/pages/666274920

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getSearchTypesByResult

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 /wiki/spaces/collectionspace/pages/666275032

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 /wiki/spaces/collectionspace/pages/666274914

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getSearchTypesByCriteria

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 /wiki/spaces/collectionspace/pages/666275018

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 /wiki/spaces/collectionspace/pages/666274914

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getSearchResultTypes

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 /wiki/spaces/collectionspace/pages/666275023

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getSearchResultType

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 /wiki/spaces/collectionspace/pages/666275032

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 /wiki/spaces/collectionspace/pages/666274906

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getSearchCriteriaTypes

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 /wiki/spaces/collectionspace/pages/666274979

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getSearchCriteriaType

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 /wiki/spaces/collectionspace/pages/666275018

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 /wiki/spaces/collectionspace/pages/666274965

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgHierarchies

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of organization hierarchies 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

orgHierarchyInfoList

Table Cell (td)

class	methodReturnDesc

list of organization hierarchies

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgHierarchy

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves information about a specific organization hierarchy.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgHierarchyKey

Table Cell (td)

class	methodParamName

orgHierarchyKey

Table Cell (td)

class	methodParamDesc

organization hierarchy identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgHierarchyInfo

Table Cell (td)

class	methodReturnDesc

information about the specified organization hierarchy

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

orgHierarchy not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgHierarchyKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgHierarchyKey

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgTypes

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of types of organizations 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

orgTypeInfoList

Table Cell (td)

class	methodReturnDesc

List of organization 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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgType

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves information about the specified type of organization.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgTypeKey

Table Cell (td)

class	methodParamName

orgTypeKey

Table Cell (td)

class	methodParamDesc

organization type identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgTypeInfo

Table Cell (td)

class	methodReturnDesc

organization 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

orgType not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgTypeKey

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgOrgRelationTypes

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of all types of relationships between organizations known to the 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

orgOrgRelationTypeInfoList

Table Cell (td)

class	methodReturnDesc

list of organization to organization relationship 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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgOrgRelationType

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves information about the specified type of relationship between organizations.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgOrgRelationTypeKey

Table Cell (td)

class	methodParamName

orgOrgRelationTypeKey

Table Cell (td)

class	methodParamDesc

organization organization relationship type identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgOrgRelationTypeInfo

Table Cell (td)

class	methodReturnDesc

organization organization relationship 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

orgOrgRelationType not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgOrgRelationTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgOrgRelationTypeKey

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgOrgRelationTypesForOrgType

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the types of relationships between organizations that are allowed for a particular type of organization.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgTypeKey

Table Cell (td)

class	methodParamName

orgTypeKey

Table Cell (td)

class	methodParamDesc

organization type identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgOrgRelationTypeInfoList

Table Cell (td)

class	methodReturnDesc

list of relationship types between organizations for the specified organization 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

orgType not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgTypeKey

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgOrgRelationTypesForOrgHierarchy

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the types of relationships between organizations that are allowed for a particular organization hierarchy.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgHierarchyKey

Table Cell (td)

class	methodParamName

orgHierarchyKey

Table Cell (td)

class	methodParamDesc

organization hierarchy identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgOrgRelationTypeInfoList

Table Cell (td)

class	methodReturnDesc

list of relationship types between organizations

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

orgHierarchy not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgHierarchyKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgHierarchyKey

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgPersonRelationTypes

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves all types of relationships between an organization and a person 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

orgPersonRelationTypeInfoList

Table Cell (td)

class	methodReturnDesc

list of all organization person relationship 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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgPersonRelationType

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves information about a type of relationship between an organization and a person.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgPersonRelationTypeKey

Table Cell (td)

class	methodParamName

orgPersonRelationTypeKey

Table Cell (td)

class	methodParamDesc

organization person relationship type identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgPersonRelationTypeInfo

Table Cell (td)

class	methodReturnDesc

organization person relationship 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

orgType not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgTypeKey

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgPersonRelationTypesForOrgType

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the types of relationships between an organization and a person that are allowed for a particular organization type.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgTypeKey

Table Cell (td)

class	methodParamName

orgTypeKey

Table Cell (td)

class	methodParamDesc

organization type identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgPersonRelationTypeInfoList

Table Cell (td)

class	methodReturnDesc

list of organization person relationship types that are valid for the supplied organization type (may have nothing)

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

orgType not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgTypeKey

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

Read

Anchor

	validateOrg
	validateOrg

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

validateOrg

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Validates an organization. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the organization (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the organization can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object.

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

validationTypeKey

Table Cell (td)

class	methodParamName

validationType

Table Cell (td)

class	methodParamDesc

identifier of the extent of validation

Table Row (tr)

Table Cell (td)

class	methodParamType

orgInfo

Table Cell (td)

class	methodParamName

orgInfo

Table Cell (td)

class	methodParamDesc

organization information to be tested.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

validationResultList

Table Cell (td)

class	methodReturnDesc

results from performing the validation

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

validationTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid validationTypeKey, orgInfo

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing validationTypeKey, orgInfo

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

validateOrgOrgRelation

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Validates an organization to organization relationship. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the organization organization relationship (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the organization organization relationship can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object.

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

validationTypeKey

Table Cell (td)

class	methodParamName

validationType

Table Cell (td)

class	methodParamDesc

identifier of the extent of validation

Table Row (tr)

Table Cell (td)

class	methodParamType

orgOrgRelationInfo

Table Cell (td)

class	methodParamName

orgOrgRelationInfo

Table Cell (td)

class	methodParamDesc

organization organization relationship information to be tested.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

validationResultList

Table Cell (td)

class	methodReturnDesc

results from performing the validation

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

validationTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid validationTypeKey, orgOrgRelationInfo

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing validationTypeKey, orgOrgRelationInfo

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

validateOrgPersonRelation

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Validates a organization to person relationship. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the organization person relationship (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the organization person relationship can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object.

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

validationTypeKey

Table Cell (td)

class	methodParamName

validationType

Table Cell (td)

class	methodParamDesc

identifier of the extent of validation

Table Row (tr)

Table Cell (td)

class	methodParamType

orgPersonRelationInfo

Table Cell (td)

class	methodParamName

orgPersonRelationInfo

Table Cell (td)

class	methodParamDesc

organization person relationship information to be tested.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

validationResultList

Table Cell (td)

class	methodReturnDesc

results from performing the validation

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

validationTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid validationTypeKey, orgPersonRelationInfo

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing validationTypeKey, orgPersonRelationInfo

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

validateOrgPositionRestriction

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Validates an organization position restriction. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the position restriction (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the position restriction can be shifted to the new values. If an identifier is not present or a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object.

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

validationTypeKey

Table Cell (td)

class	methodParamName

validationType

Table Cell (td)

class	methodParamDesc

identifier of the extent of validation

Table Row (tr)

Table Cell (td)

class	methodParamType

orgPositionRestrictionInfo

Table Cell (td)

class	methodParamName

orgPositionRestrictionInfo

Table Cell (td)

class	methodParamDesc

organization position restriction information to be tested.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

validationResultList

Table Cell (td)

class	methodReturnDesc

results from performing the validation

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

validationTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid validationTypeKey, orgPositionRestrictionInfo

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing validationTypeKey, orgPositionRestrictionInfo

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrganization

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves an existing organization by its identifier.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

identifier for org to be retrieved

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgInfo

Table Cell (td)

class	methodReturnDesc

details of the organization for this id

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

orgId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrganizationsByIdList

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves a list of existing organizations from a list of identifiers.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgIdList

Table Cell (td)

class	methodParamName

orgIdList

Table Cell (td)

class	methodParamDesc

identifiers for orgs to be retrieved

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgInfoList

Table Cell (td)

class	methodReturnDesc

details of the organizations for these ids

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

orgId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgOrgRelation

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves an existing organization to organization relationship by the relationship identifier

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgOrgRelationId

Table Cell (td)

class	methodParamName

orgOrgRelationId

Table Cell (td)

class	methodParamDesc

identifier for org to org relation to be retrieved

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgOrgRelationInfo

Table Cell (td)

class	methodReturnDesc

details of the orgOrgRelation for this id

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

orgOrgRelationId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgOrgRelationId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgOrgRelationId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgOrgRelationsByIdList

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves a list of existing organization to organization relationships from a list of identifiers

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgOrgRelationIdList

Table Cell (td)

class	methodParamName

orgOrgRelationIdList

Table Cell (td)

class	methodParamDesc

identifiers for org org relations to be retrieved

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgOrgRelationInfoList

Table Cell (td)

class	methodReturnDesc

details of the organizations for these ids

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

orgOrgRelationId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgOrgRelationId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgOrgRelationId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgOrgRelationsByOrg

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves organization to organization relationships for a particular organization

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

organization identifier for which organization organization relationships are to be found

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgOrgRelationInfoList

Table Cell (td)

class	methodReturnDesc

List of org to org relations found for the supplied organization

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

orgId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgOrgRelationsByRelatedOrg

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves organization to organization relationships that have been made TO a particular organization. Opposite direction from #getOrgOrgRelationsByOrg.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

relatedOrgId

Table Cell (td)

class	methodParamDesc

organization identifier for which the reverse organization organization relationships are to be found

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgOrgRelationInfoList

Table Cell (td)

class	methodReturnDesc

List of organization organization relationships found for the supplied organization

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

orgId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

hasOrgOrgRelation

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Tests if a org has a current relationship with a specified organization.

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

identifier of the organization

Table Row (tr)

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

comparisonOrgId

Table Cell (td)

class	methodParamDesc

identifier of the organization to be compared to

Table Row (tr)

Table Cell (td)

class	methodParamType

orgOrgRelationTypeKey

Table Cell (td)

class	methodParamName

orgOrgRelationTypeKey

Table Cell (td)

class	methodParamDesc

type of relationship between the organizations

Table Row (tr)

Table Head (th)

class	h

Return

boolean

Table Cell (td)

colspan	2
class	methodReturnType

methodReturnType

/wiki/spaces/collectionspace/pages/666274878

Table Cell (td)

class	methodReturnDesc

true if a relationship exists

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId, comparisonOrgId, orgOrgRelationType

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgId, comparisonOrgId, orgOrgRelationType

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

isDescendant

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Tests if a specified organization is a descendant of the other specified organization in the given organization hierarchy.

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

identifier of the "ancestor" organization

Table Row (tr)

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

descendantOrgId

Table Cell (td)

class	methodParamDesc

identifier of the organization to be checked if it is a descendant

Table Row (tr)

Table Cell (td)

class	methodParamType

orgHierarchyKey

Table Cell (td)

class	methodParamName

orgHierarchy

Table Cell (td)

class	methodParamDesc

identifier of the organization hierarchy to be checked against

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

boolean /wiki/spaces/collectionspace/pages/666274878

Table Cell (td)

class	methodReturnDesc

True if the organization is a descendant of the other organization in that hierarchy

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId, descendantOrgId, orgHierarchy

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgId, descendantOrgId, orgHierarchy

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

If additional hierarchies are added to this service (ex. around "positions"), we may need to add additional semantics to this operation to distinguish which hierarchy is being referred to.

Back to Operations

Anchor

	getAllDescendants
	getAllDescendants

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getAllDescendants

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of identifiers for the "descendant" organizations of the specified organization in the given organization hierarchy. Information about the distance from the original organization is not passed in this call, so this can be seen as a flattened and de-duplicated representation.

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

identifier of the "ancestor" organization

Table Row (tr)

Table Cell (td)

class	methodParamType

orgHierarchyKey

Table Cell (td)

class	methodParamName

orgHierarchy

Table Cell (td)

class	methodParamDesc

identifier of the organization hierarchy to be checked against

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgIdList

Table Cell (td)

class	methodReturnDesc

list of identifiers for the "descendant" organizations for the specified organization

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId, orgHierarchy

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgId, orgHierarchy

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

If additional hierarchies are added to this service (ex. around "positions"), we may need to add additional semantics to this operation to distinguish which hierarchy is being referred to.

Back to Operations

Anchor

	getAncestors
	getAncestors

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getAncestors

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of identifiers for the "ancestor" organizations of the specified organization in the given organization hierarchy. Information about the distance from the original organization is not passed in this call, so this can be seen as a flattened and de-duplicated representation.

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

identifier of the "descendant" organization

Table Row (tr)

Table Cell (td)

class	methodParamType

orgHierarchyKey

Table Cell (td)

class	methodParamName

orgHierarchy

Table Cell (td)

class	methodParamDesc

identifier of the organization hierarchy to be checked against

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgIdList

Table Cell (td)

class	methodReturnDesc

list of identifiers for the "ancestor" organizations of the specified organization

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId, orgHierarchy

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgId, orgHierarchy

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

If additional hierarchies are added to this service (e. around "positions"), we may need to add additional semantics to this operation to distinguish which hierarchy is being referred to.

Back to Operations

Anchor

	getOrgPersonRelation
	getOrgPersonRelation

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgPersonRelation

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves an existing org to person relation by the relation ID

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgPersonRelationId

Table Cell (td)

class	methodParamName

orgPersonRelationId

Table Cell (td)

class	methodParamDesc

identifier for org to person relation to be retrieved

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgPersonRelationInfo

Table Cell (td)

class	methodReturnDesc

details of the orgPersonRelation for this id

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

orgPersonRelationId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgPersonRelationId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgPersonRelationId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgPersonRelationsByIdList

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves a list of existing organization to person relations from a list of org person relation IDs

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgPersonRelationIdList

Table Cell (td)

class	methodParamName

orgPersonRelationIdList

Table Cell (td)

class	methodParamDesc

identifiers for org person relations to be retrieved

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgPersonRelationInfoList

Table Cell (td)

class	methodReturnDesc

details of the relations for these ids

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

orgPersonRelationId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgPersonRelationId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgPersonRelationId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getPersonIdsForOrgByRelationType

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the list of identifiers for people that have the specified type of relationship to this organization

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

identifier of the organization that members are being found for

Table Row (tr)

Table Cell (td)

class	methodParamType

orgPersonRelationTypeKey

Table Cell (td)

class	methodParamName

orgPersonRelationTypeKey

Table Cell (td)

class	methodParamDesc

type of organization person relationship that is being looked for

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

personIdList

Table Cell (td)

class	methodReturnDesc

list of person identifiers that match supplied criteria

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

orgId, orgPersonRelationType not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId, orgPersonRelationType

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgId, orgPersonRelationType

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgPersonRelationsByOrg

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves the org to person relations for a particular organization

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

identifier for the organization for which organization person relationships are to be found

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgPersonRelationInfoList

Table Cell (td)

class	methodReturnDesc

list of organization person relationships found for the supplied organization

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

orgId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getOrgPersonRelationsByPerson

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves all OrgPersonRelations for a particular Person and Organization

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

personId /wiki/spaces/collectionspace/pages/666275074

Table Cell (td)

class	methodParamName

personId

Table Cell (td)

class	methodParamDesc

person to use to look for relationships

Table Row (tr)

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

organization to use to look for relationships

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgPersonRelationInfoList

Table Cell (td)

class	methodReturnDesc

list of organization person relationships that exist for the supplied person and organization

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

personId, orgId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid personId, orgId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing personId, orgId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getAllOrgPersonRelationsByPerson

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves all organization person relationships for a person.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

personId /wiki/spaces/collectionspace/pages/666275074

Table Cell (td)

class	methodParamName

personId

Table Cell (td)

class	methodParamDesc

person to get all relationships for

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgPersonRelationInfoList

Table Cell (td)

class	methodReturnDesc

List of organization person relationships that exist for this person

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

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getAllOrgPersonRelationsByOrg

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves all organization person relationships for an organization.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

organization to get all relationships for

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgPersonRelationInfoList

Table Cell (td)

class	methodReturnDesc

list of organization person relationships that exist for this organization

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

orgId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

hasOrgPersonRelation

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Tests if a person has a current relationship with a specified organization

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

identifier of the organization

Table Row (tr)

Table Cell (td)

class	methodParamType

personId /wiki/spaces/collectionspace/pages/666275074

Table Cell (td)

class	methodParamName

personId

Table Cell (td)

class	methodParamDesc

identifier of the person

Table Row (tr)

Table Cell (td)

class	methodParamType

orgPersonRelationTypeKey

Table Cell (td)

class	methodParamName

orgPersonRelationTypeKey

Table Cell (td)

class	methodParamDesc

type of relationship between the person and organization

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

boolean /wiki/spaces/collectionspace/pages/666274878

Table Cell (td)

class	methodReturnDesc

true if a relationship exists

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId, personId, orgPersonRelationTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgId, personId, orgPersonRelationTypeKey

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getPositionRestrictionsByOrg

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Retrieves a list of organization-specific restrictions on relationships with people for a particular organization.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

identifier of the organization

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgPositionRestrictionInfoList

Table Cell (td)

class	methodReturnDesc

list of the organization-specific position restriction information

Table Row (tr)

Table Head (th)

rowspan	6
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DATA_VALIDATION_ERROR

Table Cell (td)

class	methodErrorDesc

One or more values invalid for this operation

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

the orgId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PERMISSION_DENIED

Table Cell (td)

class	methodErrorDesc

authorization failure

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

Search

Anchor

	searchForResults
	searchForResults

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 /wiki/spaces/collectionspace/pages/666275028

Table Cell (td)

class	methodParamName

searchTypeKey

Table Cell (td)

class	methodParamDesc

search identifier

Table Row (tr)

Table Cell (td)

class	methodParamType

queryParamValueList /wiki/spaces/collectionspace/pages/666275094

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 /wiki/spaces/collectionspace/pages/666275096

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

searchForOrganizations

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Searches for identifiers of organizations by complex criteria and logic.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgCriteria

Table Cell (td)

class	methodParamName

orgCriteria

Table Cell (td)

class	methodParamDesc

criteria to be used for search, e.g. by type, by name, by number of members

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgIdList

Table Cell (td)

class	methodReturnDesc

list of organization ids that matched the supplied criteria

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid organization criteria

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing organization criteria

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

searchForOrgOrgRelations

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Searches for identifiers of organization to organization relationships by complex criteria and logic.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgOrgRelationCriteria

Table Cell (td)

class	methodParamName

orgOrgRelationCriteria

Table Cell (td)

class	methodParamDesc

criteria to be used for search, e.g. by type, by name, by number of members

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgOrgRelationIdList

Table Cell (td)

class	methodReturnDesc

list of organization to organization relationship identifiers that matched the supplied criteria

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid organization to organization relationship criteria

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing organization to organization relationship criteria

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

searchForOrgPersonRelations

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Searches for identifiers of organization to person relationships by complex criteria and logic.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgPersonRelationCriteria

Table Cell (td)

class	methodParamName

orgPersonRelationCriteria

Table Cell (td)

class	methodParamDesc

criteria to be used for search, e.g. by type, by name, by number of members

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgPersonRelationIdList

Table Cell (td)

class	methodReturnDesc

list of organization to person relationship identifiers that matched the supplied criteria

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid organization to person relationship criteria

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing organization to person relationship criteria

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

	createOrganization
	createOrganization

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

createOrganization

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Creates a new organization

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

orgTypeKey

Table Cell (td)

class	methodParamName

orgTypeKey

Table Cell (td)

class	methodParamDesc

Unique identifier for an organization type.

Table Row (tr)

Table Cell (td)

class	methodParamType

orgInfo

Table Cell (td)

class	methodParamName

orgInfo

Table Cell (td)

class	methodParamDesc

information about the organization to be created

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgInfo

Table Cell (td)

class	methodReturnDesc

newly created organization information

Table Row (tr)

Table Head (th)

rowspan	6
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

ALREADY_EXISTS

Table Cell (td)

class	methodErrorDesc

org already exists

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DATA_VALIDATION_ERROR

Table Cell (td)

class	methodErrorDesc

one or more values invalid for this operation

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgInfo

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgInfo

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updateOrganization

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Updates an existing organization

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

identifier for org to be updated

Table Row (tr)

Table Cell (td)

class	methodParamType

orgInfo

Table Cell (td)

class	methodParamName

orgInfo

Table Cell (td)

class	methodParamDesc

information about the organization to be updated

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgInfo

Table Cell (td)

class	methodReturnDesc

updated organization information

Table Row (tr)

Table Head (th)

rowspan	7
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DATA_VALIDATION_ERROR

Table Cell (td)

class	methodErrorDesc

one or more values invalid for this operation

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

orgId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgInfo, orgID

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgInfo, orgID

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 Cell (td)

colspan	2
class	methodErrorType

VERSION_MISMATCH

Table Cell (td)

class	methodErrorDesc

action was attempted on an out of date version.

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

deleteOrganization

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Deletes an existing organization.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

identifier for org to be deleted

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

status /wiki/spaces/collectionspace/pages/666275040

Table Cell (td)

class	methodReturnDesc

status of the operation (success or failure)

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

orgId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

createOrgOrgRelation

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Creates an organization to organization relationship between two organizations of a particular type.

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

identifier of the organization

Table Row (tr)

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

relatedOrgId

Table Cell (td)

class	methodParamDesc

identifier of the "child" organization

Table Row (tr)

Table Cell (td)

class	methodParamType

orgOrgRelationTypeKey

Table Cell (td)

class	methodParamName

orgOrgRelationTypeKey

Table Cell (td)

class	methodParamDesc

identifier of the type of relationship between the organizations

Table Row (tr)

Table Cell (td)

class	methodParamType

orgOrgRelationInfo

Table Cell (td)

class	methodParamName

orgOrgRelationInfo

Table Cell (td)

class	methodParamDesc

organization to organization relationship information to be created

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgOrgRelationInfo

Table Cell (td)

class	methodReturnDesc

information about the new organization to organization relationship

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

org org relationship already exists

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DATA_VALIDATION_ERROR

Table Cell (td)

class	methodErrorDesc

one or more values invalid for this operation

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

orgId, relatedOrgId, orgOrgRelationTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId, relatedOrgId, orgOrgRelationTypeKey create info

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgId, relatedOrgId, orgOrgRelationTypeKey create info

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PERMISSION_DENIED

Table Cell (td)

class	methodErrorDesc

authorization failure

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updateOrgOrgRelation

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Updates an organization to organization relationship.

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

orgOrgRelationId

Table Cell (td)

class	methodParamName

orgOrgRelationId

Table Cell (td)

class	methodParamDesc

organization to organization relationship identifier

Table Row (tr)

Table Cell (td)

class	methodParamType

orgOrgRelationInfo

Table Cell (td)

class	methodParamName

orgOrgRelationInfo

Table Cell (td)

class	methodParamDesc

detail information of the organization to organization relationship

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgOrgRelationInfo

Table Cell (td)

class	methodReturnDesc

updated organization to organization relationship information

Table Row (tr)

Table Head (th)

rowspan	7
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DATA_VALIDATION_ERROR

Table Cell (td)

class	methodErrorDesc

one or more values invalid for this operation

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

orgOrgRelationId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgOrgRelationId, orgOrgRelation update info

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgOrgRelationId, orgOrgRelation update info

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 Cell (td)

colspan	2
class	methodErrorType

VERSION_MISMATCH

Table Cell (td)

class	methodErrorDesc

action was attempted on an out of date version.

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

removeOrgOrgRelation

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Removes an organization to organization relationship.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgOrgRelationId

Table Cell (td)

class	methodParamName

orgOrgRelationId

Table Cell (td)

class	methodParamDesc

organization to organization relationship identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

status /wiki/spaces/collectionspace/pages/666275040

Table Cell (td)

class	methodReturnDesc

status of the operation

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

orgOrgRelationId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgOrgRelationId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgOrgRelationId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

createOrgPersonRelation

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Creates an organization to person relationship between an organization and a person with a particular type.

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

organization

Table Row (tr)

Table Cell (td)

class	methodParamType

personId /wiki/spaces/collectionspace/pages/666275074

Table Cell (td)

class	methodParamName

personId

Table Cell (td)

class	methodParamDesc

person

Table Row (tr)

Table Cell (td)

class	methodParamType

orgPersonRelationTypeKey

Table Cell (td)

class	methodParamName

orgPersonRelationTypeKey

Table Cell (td)

class	methodParamDesc

organization person relationship type

Table Row (tr)

Table Cell (td)

class	methodParamType

orgPersonRelationInfo

Table Cell (td)

class	methodParamName

orgPersonRelationInfo

Table Cell (td)

class	methodParamDesc

organization person relationship information

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgPersonRelationInfo

Table Cell (td)

class	methodReturnDesc

detail information of the new organization to person relationship

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

organization person relationship already exists

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DATA_VALIDATION_ERROR

Table Cell (td)

class	methodErrorDesc

one or more values invalid for this operation

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

personId, orgId, orgPersonRelationTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid personId, orgId, orgPersonRelationTypeKey, orgPersonRelationInfo

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing personId, orgId, orgPersonRelationTypeKey, orgPersonRelationInfo

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

PERMISSION_DENIED

Table Cell (td)

class	methodErrorDesc

authorization failure

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updateOrgPersonRelation

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Updates an organization to person relationship.

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

orgPersonRelationId

Table Cell (td)

class	methodParamName

orgPersonRelationId

Table Cell (td)

class	methodParamDesc

organization person relationship identifier

Table Row (tr)

Table Cell (td)

class	methodParamType

orgPersonRelationInfo

Table Cell (td)

class	methodParamName

orgPersonRelationInfo

Table Cell (td)

class	methodParamDesc

information about the organization to person relationship to be updated

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgPersonRelationInfo

Table Cell (td)

class	methodReturnDesc

updated organization to person relationship information

Table Row (tr)

Table Head (th)

rowspan	7
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DATA_VALIDATION_ERROR

Table Cell (td)

class	methodErrorDesc

one or more values invalid for this operation

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

orgPersonRelationId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgPersonRelationId, orgPersonRelationInfo

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgPersonRelationId, orgPersonRelationInfo

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 Cell (td)

colspan	2
class	methodErrorType

VERSION_MISMATCH

Table Cell (td)

class	methodErrorDesc

action was attempted on an out of date version.

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

removeOrgPersonRelation

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Removes an organization to person relationship.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

orgPersonRelationId

Table Cell (td)

class	methodParamName

orgPersonRelationId

Table Cell (td)

class	methodParamDesc

organization person relationship identifier

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

status /wiki/spaces/collectionspace/pages/666275040

Table Cell (td)

class	methodReturnDesc

status of the operation

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

orgPersonRelationId not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgPersonRelationId

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgPersonRelationId

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

addPositionRestrictionToOrg

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Adds a description of the organization-specific usage of an organization person relationship type. This information typically coincides with constraints, such as how many relationships of a given type may be active at a particular time, etc.

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

organization

Table Row (tr)

Table Cell (td)

class	methodParamType

orgPersonRelationTypeKey

Table Cell (td)

class	methodParamName

orgPersonRelationTypeKey

Table Cell (td)

class	methodParamDesc

organization person relationship type

Table Row (tr)

Table Cell (td)

class	methodParamType

orgPositionRestrictionInfo

Table Cell (td)

class	methodParamName

orgPositionRestrictionInfo

Table Cell (td)

class	methodParamDesc

organization position restriction information

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgPositionRestrictionInfo

Table Cell (td)

class	methodReturnDesc

information about the newly created organization position restriction

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

org position restriction already exists

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DATA_VALIDATION_ERROR

Table Cell (td)

class	methodErrorDesc

one or more values invalid for this operation

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

the orgId, orgPersonRelationTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId, orgPersonRelationTypeKey, orgPositionRestrictionInfo

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgId, orgPersonRelationTypeKey, orgPositionRestrictionInfo

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updatePositionRestrictionForOrg

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Updates a description of the organization-specific usage of an organization person relationship type.

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

organization

Table Row (tr)

Table Cell (td)

class	methodParamType

orgPersonRelationTypeKey

Table Cell (td)

class	methodParamName

orgPersonRelationTypeKey

Table Cell (td)

class	methodParamDesc

organization person relationship type

Table Row (tr)

Table Cell (td)

class	methodParamType

orgPositionRestrictionInfo

Table Cell (td)

class	methodParamName

orgPositionRestrictionInfo

Table Cell (td)

class	methodParamDesc

organization position restriction information

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

orgPositionRestrictionInfo

Table Cell (td)

class	methodReturnDesc

information about the updated organization position restriction

Table Row (tr)

Table Head (th)

rowspan	7
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

DATA_VALIDATION_ERROR

Table Cell (td)

class	methodErrorDesc

one or more values invalid for this operation

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

DOES_NOT_EXIST

Table Cell (td)

class	methodErrorDesc

orgId, orgPersonRelationTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId, orgPersonRelationTypeKey, orgPositionRestrictionInfo

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgId, orgPersonRelationTypeKey, orgPositionRestrictionInfo

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 Cell (td)

colspan	2
class	methodErrorType

VERSION_MISMATCH

Table Cell (td)

class	methodErrorDesc

action was attempted on an out of date version.

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

...

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

removePositionRestrictionFromOrg

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Removes a description of the organization-specific usage of an organization person relationship type.

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

orgId

Table Cell (td)

class	methodParamName

orgId

Table Cell (td)

class	methodParamDesc

organization

Table Row (tr)

Table Cell (td)

class	methodParamType

orgPersonRelationTypeKey

Table Cell (td)

class	methodParamName

orgPersonRelationTypeKey

Table Cell (td)

class	methodParamDesc

organization person relationship type

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

status /wiki/spaces/collectionspace/pages/666275040

Table Cell (td)

class	methodReturnDesc

status

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

the orgId, orgPersonRelationTypeKey not found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID_PARAMETER

Table Cell (td)

class	methodErrorDesc

invalid orgId, orgPersonRelationTypeKey

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MISSING_PARAMETER

Table Cell (td)

class	methodErrorDesc

missing orgId, orgPersonRelationTypeKey

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

	SDR:ServiceOperationStopSDR:
	ServiceOperationStop

Versions Compared

Old Version 2

New Version Current

Key

CollectionObject Service

Operations

Setup

Read

Search

Maintenance

Capabilities