Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

CollectionObject Service

Unable to render {include} The included page could not be found.

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.

Name

CollectionObject

Version

Dev

[Release Notes/History]

#References

#Operations

#Capabilities

CollectionObject Service Description and Assumptions

References

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

Operations

Unable to render {include} The included page could not be found.
Setup

Dictionary Operations
#getObjectTypes
#getObjectStructure

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

Domain Operations
#getCollObjHierarchies
#getCollObjHierarchy

#getCollObjTypes
#getCollObjType

#getCollObjCollObjRelationTypes
#getCollObjCollObjRelationType

#getCollObjRelationTypesForCollObjType
#getCollObjCollObjRelationTypesForCollObjHierarchy

Read

#validateCollObj
#validateCollObjCollObjRelation

#getCollObj
#getCollObjsByIdList

#getCollObjCollObjRelation
#getCollObjCollObjRelationsByIdList
#getCollObjCollObjRelationsByCollObj
#getCollObjCollObjRelationsByRelatedCollObj
#hasCollObjCollObjRelation

#isDescendant
#getAllDescendants
#getAncestors

Search

#searchForResults

#searchForCollObjs
#searchForCollObjCollObjRelations

Maintenance

#createCollObj
#updateCollObj
#deleteCollObj

#createCollObjCollObjRelation
#updateCollObjCollObjRelation
#removeCollObjCollObjRelation

Setup

Method

getObjectTypes

Description

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

Parameters

None

None

No parameters

Return

[objectTypeKeyList]

list of object type identifiers

Errors

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getObjectStructure

Description

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.

Parameters

[objectTypeKey]

objectTypeKey

identifier of the object type

Return

[objectStructure]

describes the fields for the input object type

Errors

DOES_NOT_EXIST

specified objectTypeKey not found

INVALID_PARAMETER

invalid objectTypeKey

MISSING_PARAMETER

missing objectTypeKey

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getEnumeration

Description

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.

Parameters

[enumerationKey]

enumerationKey

identifier of the enumeration

[enumContextKey]

contextType

identifier of the enumeration context type

[string]

contextValue

value of the enumeration context

[dateTime]

contextDate

date and time to get the enumeration for

Return

[enumeratedValueList]

list of enumerated codes and values

Errors

DOES_NOT_EXIST

enumerationKey not found

INVALID_PARAMETER

invalid enumerationKey, contextType, contextValue, contextDate

MISSING_PARAMETER

missing enumerationKey, contextType, contextValue, contextDate

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getSearchTypes

Description

Retrieves the list of search types known by this service.

Parameters

None

None

No Parameters

Return

[searchTypeInfoList]

list of search type information

Errors

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getSearchType

Description

Retrieves information about a particular search type.

Parameters

[searchTypeKey]

searchTypeKey

identifier of the search type

Return

[searchTypeInfo]

information on the search type

Errors

DOES_NOT_EXIST

specified searchTypeKey not found

INVALID_PARAMETER

invalid searchTypeKey

MISSING_PARAMETER

searchTypeKey not specified

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getSearchTypesByResult

Description

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

Parameters

[searchResultTypeKey]

searchResultTypeKey

identifier of the search result type

Return

[searchTypeInfoList]

list of search type information

Errors

DOES_NOT_EXIST

specified searchResultTypeKey not found

INVALID_PARAMETER

invalid searchResultTypeKey

MISSING_PARAMETER

searchResultTypeKey not specified

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getSearchTypesByCriteria

Description

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

Parameters

[searchCriteriaTypeKey]

searchCriteriaTypeKey

identifier of the search criteria

Return

[searchTypeInfoList]

list of search type information

Errors

DOES_NOT_EXIST

specified searchCriteriaTypeKey not found

INVALID_PARAMETER

invalid searchCriteriaTypeKey

MISSING_PARAMETER

searchCriteriaTypeKey not specified

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getSearchResultTypes

Description

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

Parameters

None

None

No Parameters

Return

[searchResultTypeInfoList]

list of search result type information

Errors

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getSearchResultType

Description

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

Parameters

[searchResultTypeKey]

searchResultTypeKey

identifier of the search result type

Return

[searchResultTypeInfo]

information on the search result type

Errors

DOES_NOT_EXIST

specified searchResultTypeKey not found

INVALID_PARAMETER

invalid searchResultTypeKey

MISSING_PARAMETER

searchResultTypeKey not specified

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getSearchCriteriaTypes

Description

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

Parameters

None

None

No parameters

Return

[searchCriteriaTypeInfoList]

list of search criteria type information

Errors

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getSearchCriteriaType

Description

Retrieves information about a particular search criteria type.

Parameters

[searchCriteriaTypeKey]

searchCriteriaTypeKey

identifier of the search criteria type

Return

[searchCriteriaTypeInfo]

information on the search criteria type

Errors

DOES_NOT_EXIST

specified searchCriteriaTypeKey not found

INVALID_PARAMETER

invalid searchCriteriaTypeKey

MISSING_PARAMETER

searchCriteriaTypeKey not specified

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgHierarchies

Description

Retrieves the list of organization hierarchies known by this service.

Parameters

None

None

No parameters

Return

[orgHierarchyInfoList]

list of organization hierarchies

Errors

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgHierarchy

Description

Retrieves information about a specific organization hierarchy.

Parameters

[orgHierarchyKey]

orgHierarchyKey

organization hierarchy identifier

Return

[orgHierarchyInfo]

information about the specified organization hierarchy

Errors

DOES_NOT_EXIST

orgHierarchy not found

INVALID_PARAMETER

invalid orgHierarchyKey

MISSING_PARAMETER

missing orgHierarchyKey

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgTypes

Description

Retrieves the list of types of organizations known by this service.

Parameters

None

None

No parameters

Return

[orgTypeInfoList]

List of organization types

Errors

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgType

Description

Retrieves information about the specified type of organization.

Parameters

[orgTypeKey]

orgTypeKey

organization type identifier

Return

[orgTypeInfo]

organization type

Errors

DOES_NOT_EXIST

orgType not found

INVALID_PARAMETER

invalid orgTypeKey

MISSING_PARAMETER

missing orgTypeKey

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgOrgRelationTypes

Description

Retrieves the list of all types of relationships between organizations known to the service.

Parameters

None

None

No parameters

Return

[orgOrgRelationTypeInfoList]

list of organization to organization relationship types

Errors

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgOrgRelationType

Description

Retrieves information about the specified type of relationship between organizations.

Parameters

[orgOrgRelationTypeKey]

orgOrgRelationTypeKey

organization organization relationship type identifier

Return

[orgOrgRelationTypeInfo]

organization organization relationship type information

Errors

DOES_NOT_EXIST

orgOrgRelationType not found

INVALID_PARAMETER

invalid orgOrgRelationTypeKey

MISSING_PARAMETER

missing orgOrgRelationTypeKey

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgOrgRelationTypesForOrgType

Description

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

Parameters

[orgTypeKey]

orgTypeKey

organization type identifier

Return

[orgOrgRelationTypeInfoList]

list of relationship types between organizations for the specified organization type

Errors

DOES_NOT_EXIST

orgType not found

INVALID_PARAMETER

invalid orgTypeKey

MISSING_PARAMETER

missing orgTypeKey

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgOrgRelationTypesForOrgHierarchy

Description

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

Parameters

[orgHierarchyKey]

orgHierarchyKey

organization hierarchy identifier

Return

[orgOrgRelationTypeInfoList]

list of relationship types between organizations

Errors

DOES_NOT_EXIST

orgHierarchy not found

INVALID_PARAMETER

invalid orgHierarchyKey

MISSING_PARAMETER

missing orgHierarchyKey

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgPersonRelationTypes

Description

Retrieves all types of relationships between an organization and a person known by this service.

Parameters

None

None

No parameters

Return

[orgPersonRelationTypeInfoList]

list of all organization person relationship types

Errors

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgPersonRelationType

Description

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

Parameters

[orgPersonRelationTypeKey]

orgPersonRelationTypeKey

organization person relationship type identifier

Return

[orgPersonRelationTypeInfo]

organization person relationship type information

Errors

DOES_NOT_EXIST

orgType not found

INVALID_PARAMETER

invalid orgTypeKey

MISSING_PARAMETER

missing orgTypeKey

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgPersonRelationTypesForOrgType

Description

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

Parameters

[orgTypeKey]

orgTypeKey

organization type identifier

Return

[orgPersonRelationTypeInfoList]

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

Errors

DOES_NOT_EXIST

orgType not found

INVALID_PARAMETER

invalid orgTypeKey

MISSING_PARAMETER

missing orgTypeKey

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Read

Method

validateOrg

Description

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.

Parameters

[validationTypeKey]

validationType

identifier of the extent of validation

[orgInfo]

orgInfo

organization information to be tested.

Return

[validationResultList]

results from performing the validation

Errors

DOES_NOT_EXIST

validationTypeKey not found

INVALID_PARAMETER

invalid validationTypeKey, orgInfo

MISSING_PARAMETER

missing validationTypeKey, orgInfo

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

validateOrgOrgRelation

Description

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.

Parameters

[validationTypeKey]

validationType

identifier of the extent of validation

[orgOrgRelationInfo]

orgOrgRelationInfo

organization organization relationship information to be tested.

Return

[validationResultList]

results from performing the validation

Errors

DOES_NOT_EXIST

validationTypeKey not found

INVALID_PARAMETER

invalid validationTypeKey, orgOrgRelationInfo

MISSING_PARAMETER

missing validationTypeKey, orgOrgRelationInfo

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

validateOrgPersonRelation

Description

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.

Parameters

[validationTypeKey]

validationType

identifier of the extent of validation

[orgPersonRelationInfo]

orgPersonRelationInfo

organization person relationship information to be tested.

Return

[validationResultList]

results from performing the validation

Errors

DOES_NOT_EXIST

validationTypeKey not found

INVALID_PARAMETER

invalid validationTypeKey, orgPersonRelationInfo

MISSING_PARAMETER

missing validationTypeKey, orgPersonRelationInfo

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

validateOrgPositionRestriction

Description

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.

Parameters

[validationTypeKey]

validationType

identifier of the extent of validation

[orgPositionRestrictionInfo]

orgPositionRestrictionInfo

organization position restriction information to be tested.

Return

[validationResultList]

results from performing the validation

Errors

DOES_NOT_EXIST

validationTypeKey not found

INVALID_PARAMETER

invalid validationTypeKey, orgPositionRestrictionInfo

MISSING_PARAMETER

missing validationTypeKey, orgPositionRestrictionInfo

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrganization

Description

Retrieves an existing organization by its identifier.

Parameters

[orgId]

orgId

identifier for org to be retrieved

Return

[orgInfo]

details of the organization for this id

Errors

DOES_NOT_EXIST

orgId not found

INVALID_PARAMETER

invalid orgId

MISSING_PARAMETER

invalid orgId

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrganizationsByIdList

Description

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

Parameters

[orgIdList]

orgIdList

identifiers for orgs to be retrieved

Return

[orgInfoList]

details of the organizations for these ids

Errors

DOES_NOT_EXIST

orgId not found

INVALID_PARAMETER

invalid orgId

MISSING_PARAMETER

invalid orgId

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgOrgRelation

Description

Retrieves an existing organization to organization relationship by the relationship identifier

Parameters

[orgOrgRelationId]

orgOrgRelationId

identifier for org to org relation to be retrieved

Return

[orgOrgRelationInfo]

details of the orgOrgRelation for this id

Errors

DOES_NOT_EXIST

orgOrgRelationId not found

INVALID_PARAMETER

invalid orgOrgRelationId

MISSING_PARAMETER

invalid orgOrgRelationId

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgOrgRelationsByIdList

Description

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

Parameters

[orgOrgRelationIdList]

orgOrgRelationIdList

identifiers for org org relations to be retrieved

Return

[orgOrgRelationInfoList]

details of the organizations for these ids

Errors

DOES_NOT_EXIST

orgOrgRelationId not found

INVALID_PARAMETER

invalid orgOrgRelationId

MISSING_PARAMETER

invalid orgOrgRelationId

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgOrgRelationsByOrg

Description

Retrieves organization to organization relationships for a particular organization

Parameters

[orgId]

orgId

organization identifier for which organization organization relationships are to be found

Return

[orgOrgRelationInfoList]

List of org to org relations found for the supplied organization

Errors

DOES_NOT_EXIST

orgId not found

INVALID_PARAMETER

invalid orgId

MISSING_PARAMETER

missing orgId

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgOrgRelationsByRelatedOrg

Description

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

Parameters

[orgId]

relatedOrgId

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

Return

[orgOrgRelationInfoList]

List of organization organization relationships found for the supplied organization

Errors

DOES_NOT_EXIST

orgId not found

INVALID_PARAMETER

invalid orgId

MISSING_PARAMETER

missing orgId

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

hasOrgOrgRelation

Description

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

Parameters

[orgId]

orgId

identifier of the organization

[orgId]

comparisonOrgId

identifier of the organization to be compared to

[orgOrgRelationTypeKey]

orgOrgRelationTypeKey

type of relationship between the organizations

Return

[boolean]

true if a relationship exists

Errors

INVALID_PARAMETER

invalid orgId, comparisonOrgId, orgOrgRelationType

MISSING_PARAMETER

missing orgId, comparisonOrgId, orgOrgRelationType

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

isDescendant

Description

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

Parameters

[orgId]

orgId

identifier of the "ancestor" organization

[orgId]

descendantOrgId

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

[orgHierarchyKey]

orgHierarchy

identifier of the organization hierarchy to be checked against

Return

[boolean]

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

Errors

INVALID_PARAMETER

invalid orgId, descendantOrgId, orgHierarchy

MISSING_PARAMETER

missing orgId, descendantOrgId, orgHierarchy

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

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

Method

getAllDescendants

Description

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.

Parameters

[orgId]

orgId

identifier of the "ancestor" organization

[orgHierarchyKey]

orgHierarchy

identifier of the organization hierarchy to be checked against

Return

[orgIdList]

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

Errors

INVALID_PARAMETER

invalid orgId, orgHierarchy

MISSING_PARAMETER

missing orgId, orgHierarchy

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

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

Method

getAncestors

Description

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.

Parameters

[orgId]

orgId

identifier of the "descendant" organization

[orgHierarchyKey]

orgHierarchy

identifier of the organization hierarchy to be checked against

Return

[orgIdList]

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

Errors

INVALID_PARAMETER

invalid orgId, orgHierarchy

MISSING_PARAMETER

missing orgId, orgHierarchy

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

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

Method

getOrgPersonRelation

Description

Retrieves an existing org to person relation by the relation ID

Parameters

[orgPersonRelationId]

orgPersonRelationId

identifier for org to person relation to be retrieved

Return

[orgPersonRelationInfo]

details of the orgPersonRelation for this id

Errors

DOES_NOT_EXIST

orgPersonRelationId not found

INVALID_PARAMETER

invalid orgPersonRelationId

MISSING_PARAMETER

invalid orgPersonRelationId

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgPersonRelationsByIdList

Description

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

Parameters

[orgPersonRelationIdList]

orgPersonRelationIdList

identifiers for org person relations to be retrieved

Return

[orgPersonRelationInfoList]

details of the relations for these ids

Errors

DOES_NOT_EXIST

orgPersonRelationId not found

INVALID_PARAMETER

invalid orgPersonRelationId

MISSING_PARAMETER

invalid orgPersonRelationId

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getPersonIdsForOrgByRelationType

Description

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

Parameters

[orgId]

orgId

identifier of the organization that members are being found for

[orgPersonRelationTypeKey]

orgPersonRelationTypeKey

type of organization person relationship that is being looked for

Return

[personIdList]

list of person identifiers that match supplied criteria

Errors

DOES_NOT_EXIST

orgId, orgPersonRelationType not found

INVALID_PARAMETER

invalid orgId, orgPersonRelationType

MISSING_PARAMETER

missing orgId, orgPersonRelationType

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgPersonRelationsByOrg

Description

Retrieves the org to person relations for a particular organization

Parameters

[orgId]

orgId

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

Return

[orgPersonRelationInfoList]

list of organization person relationships found for the supplied organization

Errors

DOES_NOT_EXIST

orgId not found

INVALID_PARAMETER

invalid orgId

MISSING_PARAMETER

missing orgId

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getOrgPersonRelationsByPerson

Description

Retrieves all OrgPersonRelations for a particular Person and Organization

Parameters

[personId]

personId

person to use to look for relationships

[orgId]

orgId

organization to use to look for relationships

Return

[orgPersonRelationInfoList]

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

Errors

DOES_NOT_EXIST

personId, orgId not found

INVALID_PARAMETER

invalid personId, orgId

MISSING_PARAMETER

missing personId, orgId

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getAllOrgPersonRelationsByPerson

Description

Retrieves all organization person relationships for a person.

Parameters

[personId]

personId

person to get all relationships for

Return

[orgPersonRelationInfoList]

List of organization person relationships that exist for this person

Errors

DOES_NOT_EXIST

personId not found

INVALID_PARAMETER

invalid personId

MISSING_PARAMETER

missing personId

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getAllOrgPersonRelationsByOrg

Description

Retrieves all organization person relationships for an organization.

Parameters

[orgId]

orgId

organization to get all relationships for

Return

[orgPersonRelationInfoList]

list of organization person relationships that exist for this organization

Errors

DOES_NOT_EXIST

orgId not found

INVALID_PARAMETER

invalid orgId

MISSING_PARAMETER

missing orgId

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

hasOrgPersonRelation

Description

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

Parameters

[orgId]

orgId

identifier of the organization

[personId]

personId

identifier of the person

[orgPersonRelationTypeKey]

orgPersonRelationTypeKey

type of relationship between the person and organization

Return

[boolean]

true if a relationship exists

Errors

INVALID_PARAMETER

invalid orgId, personId, orgPersonRelationTypeKey

MISSING_PARAMETER

missing orgId, personId, orgPersonRelationTypeKey

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

getPositionRestrictionsByOrg

Description

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

Parameters

[orgId]

orgId

identifier of the organization

Return

[orgPositionRestrictionInfoList]

list of the organization-specific position restriction information

Errors

DATA_VALIDATION_ERROR

One or more values invalid for this operation

DOES_NOT_EXIST

the orgId not found

INVALID_PARAMETER

invalid orgId

MISSING_PARAMETER

missing orgId

PERMISSION_DENIED

authorization failure

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

searchForResults

Description

Retrieves results in tabular form for the specified parameters.

Parameters

[searchTypeKey]

searchTypeKey

search identifier

[queryParamValueList]

queryParamValues

list of values for search parameters

Return

[resultList]

list of results from the query

Errors

DOES_NOT_EXIST

specified search type not found

INVALID_PARAMETER

invalid searchTypeKey, queryParamValueList

MISSING_PARAMETER

searchTypeKey, queryParamValueList not specified

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

searchForOrganizations

Description

Searches for identifiers of organizations by complex criteria and logic.

Parameters

[orgCriteria]

orgCriteria

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

Return

[orgIdList]

list of organization ids that matched the supplied criteria

Errors

INVALID_PARAMETER

invalid organization criteria

MISSING_PARAMETER

missing organization criteria

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

searchForOrgOrgRelations

Description

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

Parameters

[orgOrgRelationCriteria]

orgOrgRelationCriteria

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

Return

[orgOrgRelationIdList]

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

Errors

INVALID_PARAMETER

invalid organization to organization relationship criteria

MISSING_PARAMETER

missing organization to organization relationship criteria

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

searchForOrgPersonRelations

Description

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

Parameters

[orgPersonRelationCriteria]

orgPersonRelationCriteria

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

Return

[orgPersonRelationIdList]

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

Errors

INVALID_PARAMETER

invalid organization to person relationship criteria

MISSING_PARAMETER

missing organization to person relationship criteria

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Maintenance

Method

createOrganization

Description

Creates a new organization

Parameters

[orgTypeKey]

orgTypeKey

Unique identifier for an organization type.

[orgInfo]

orgInfo

information about the organization to be created

Return

[orgInfo]

newly created organization information

Errors

ALREADY_EXISTS

org already exists

DATA_VALIDATION_ERROR

one or more values invalid for this operation

INVALID_PARAMETER

invalid orgInfo

MISSING_PARAMETER

missing orgInfo

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

updateOrganization

Description

Updates an existing organization

Parameters

[orgId]

orgId

identifier for org to be updated

[orgInfo]

orgInfo

information about the organization to be updated

Return

[orgInfo]

updated organization information

Errors

DATA_VALIDATION_ERROR

one or more values invalid for this operation

DOES_NOT_EXIST

orgId not found

INVALID_PARAMETER

invalid orgInfo, orgID

MISSING_PARAMETER

missing orgInfo, orgID

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

VERSION_MISMATCH

action was attempted on an out of date version.

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

deleteOrganization

Description

Deletes an existing organization.

Parameters

[orgId]

orgId

identifier for org to be deleted

Return

[status]

status of the operation (success or failure)

Errors

DOES_NOT_EXIST

orgId not found

INVALID_PARAMETER

invalid orgId

MISSING_PARAMETER

missing orgId

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

createOrgOrgRelation

Description

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

Parameters

[orgId]

orgId

identifier of the organization

[orgId]

relatedOrgId

identifier of the "child" organization

[orgOrgRelationTypeKey]

orgOrgRelationTypeKey

identifier of the type of relationship between the organizations

[orgOrgRelationInfo]

orgOrgRelationInfo

organization to organization relationship information to be created

Return

[orgOrgRelationInfo]

information about the new organization to organization relationship

Errors

ALREADY_EXISTS

org org relationship already exists

DATA_VALIDATION_ERROR

one or more values invalid for this operation

DOES_NOT_EXIST

orgId, relatedOrgId, orgOrgRelationTypeKey not found

INVALID_PARAMETER

invalid orgId, relatedOrgId, orgOrgRelationTypeKey create info

MISSING_PARAMETER

missing orgId, relatedOrgId, orgOrgRelationTypeKey create info

PERMISSION_DENIED

authorization failure

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

updateOrgOrgRelation

Description

Updates an organization to organization relationship.

Parameters

[orgOrgRelationId]

orgOrgRelationId

organization to organization relationship identifier

[orgOrgRelationInfo]

orgOrgRelationInfo

detail information of the organization to organization relationship

Return

[orgOrgRelationInfo]

updated organization to organization relationship information

Errors

DATA_VALIDATION_ERROR

one or more values invalid for this operation

DOES_NOT_EXIST

orgOrgRelationId not found

INVALID_PARAMETER

invalid orgOrgRelationId, orgOrgRelation update info

MISSING_PARAMETER

missing orgOrgRelationId, orgOrgRelation update info

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

VERSION_MISMATCH

action was attempted on an out of date version.

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

removeOrgOrgRelation

Description

Removes an organization to organization relationship.

Parameters

[orgOrgRelationId]

orgOrgRelationId

organization to organization relationship identifier

Return

[status]

status of the operation

Errors

DOES_NOT_EXIST

orgOrgRelationId not found

INVALID_PARAMETER

invalid orgOrgRelationId

MISSING_PARAMETER

missing orgOrgRelationId

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

createOrgPersonRelation

Description

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

Parameters

[orgId]

orgId

organization

[personId]

personId

person

[orgPersonRelationTypeKey]

orgPersonRelationTypeKey

organization person relationship type

[orgPersonRelationInfo]

orgPersonRelationInfo

organization person relationship information

Return

[orgPersonRelationInfo]

detail information of the new organization to person relationship

Errors

ALREADY_EXISTS

organization person relationship already exists

DATA_VALIDATION_ERROR

one or more values invalid for this operation

DOES_NOT_EXIST

personId, orgId, orgPersonRelationTypeKey not found

INVALID_PARAMETER

invalid personId, orgId, orgPersonRelationTypeKey, orgPersonRelationInfo

MISSING_PARAMETER

missing personId, orgId, orgPersonRelationTypeKey, orgPersonRelationInfo

PERMISSION_DENIED

authorization failure

OPERATION_FAILED

unable to complete request

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

updateOrgPersonRelation

Description

Updates an organization to person relationship.

Parameters

[orgPersonRelationId]

orgPersonRelationId

organization person relationship identifier

[orgPersonRelationInfo]

orgPersonRelationInfo

information about the organization to person relationship to be updated

Return

[orgPersonRelationInfo]

updated organization to person relationship information

Errors

DATA_VALIDATION_ERROR

one or more values invalid for this operation

DOES_NOT_EXIST

orgPersonRelationId not found

INVALID_PARAMETER

invalid orgPersonRelationId, orgPersonRelationInfo

MISSING_PARAMETER

missing orgPersonRelationId, orgPersonRelationInfo

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

VERSION_MISMATCH

action was attempted on an out of date version.

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

removeOrgPersonRelation

Description

Removes an organization to person relationship.

Parameters

[orgPersonRelationId]

orgPersonRelationId

organization person relationship identifier

Return

[status]

status of the operation

Errors

DOES_NOT_EXIST

orgPersonRelationId not found

INVALID_PARAMETER

invalid orgPersonRelationId

MISSING_PARAMETER

missing orgPersonRelationId

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

addPositionRestrictionToOrg

Description

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.

Parameters

[orgId]

orgId

organization

[orgPersonRelationTypeKey]

orgPersonRelationTypeKey

organization person relationship type

[orgPositionRestrictionInfo]

orgPositionRestrictionInfo

organization position restriction information

Return

[orgPositionRestrictionInfo]

information about the newly created organization position restriction

Errors

ALREADY_EXISTS

org position restriction already exists

DATA_VALIDATION_ERROR

one or more values invalid for this operation

DOES_NOT_EXIST

the orgId, orgPersonRelationTypeKey not found

INVALID_PARAMETER

invalid orgId, orgPersonRelationTypeKey, orgPositionRestrictionInfo

MISSING_PARAMETER

missing orgId, orgPersonRelationTypeKey, orgPositionRestrictionInfo

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

updatePositionRestrictionForOrg

Description

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

Parameters

[orgId]

orgId

organization

[orgPersonRelationTypeKey]

orgPersonRelationTypeKey

organization person relationship type

[orgPositionRestrictionInfo]

orgPositionRestrictionInfo

organization position restriction information

Return

[orgPositionRestrictionInfo]

information about the updated organization position restriction

Errors

DATA_VALIDATION_ERROR

one or more values invalid for this operation

DOES_NOT_EXIST

orgId, orgPersonRelationTypeKey not found

INVALID_PARAMETER

invalid orgId, orgPersonRelationTypeKey, orgPositionRestrictionInfo

MISSING_PARAMETER

missing orgId, orgPersonRelationTypeKey, orgPositionRestrictionInfo

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

VERSION_MISMATCH

action was attempted on an out of date version.

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Method

removePositionRestrictionFromOrg

Description

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

Parameters

[orgId]

orgId

organization

[orgPersonRelationTypeKey]

orgPersonRelationTypeKey

organization person relationship type

Return

[status]

status

Errors

DOES_NOT_EXIST

the orgId, orgPersonRelationTypeKey not found

INVALID_PARAMETER

invalid orgId, orgPersonRelationTypeKey

MISSING_PARAMETER

missing orgId, orgPersonRelationTypeKey

OPERATION_FAILED

unable to complete request

PERMISSION_DENIED

authorization failure

Capabilities

Use Cases

Comments/Feedback

Back to Operations

Capabilities

  • No labels