OrganizationService

Name Organization
Version
Included Services SearchService
Java Package org.kuali.student.r2.core.organization.service

Description



The Organization service manages organizational units that have
some relationship to the institution and manages the relationships
between people and those organization. Internal organizations
include officially recognized organizations (such as schools and
departments) and unofficial organizations (such as clubs or student
groups). Organizations may also be external to the institution,
such as companies, other institutions, government,
associations.



Assumptions



The design of this service considers the following assumptions:





Key Concepts



Operations
Main Message Structures

Method getOrgHierarchy
Description Retrieves a single OrgHierarchy by OrgHierarchy Id.
Parameters String orgHierarchyId the identifier for the OrgHierarchy to be
retrieved
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgHierarchyInfo the OrgHierarchy requested
Errors DoesNotExistException orgHierarchyId not found
InvalidParameterException contextInfo is not valid
MissingParameterException orgHierarchyId or contextInfo
is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgHierarchiesByIds
Description Retrieves a list of OrgHierarchies from a list of OrgHierarchy
Ids. The returned list may be in any order and if duplicate Ids
are supplied, a unique set may or may not be returned.
Parameters StringList orgHierarchyIds a list of OrgHierarchy Ids
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgHierarchyInfoList a list of OrgHierarchies
Errors DoesNotExistException an orgHierarchyId in the list not found
InvalidParameterException contextInfo is not valid
MissingParameterException orgHierarchyIds, an id in
orgHierarchyIds, or contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgHierarchyIdsByType
Description Retrieves a list of OrgHierarchy Ids by OrgHierarchy Type.
Parameters String orgHierarchyTypeKey an identifier for the OrgHierarchy
type
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return StringList a list of OrgHierarchy Ids matching orgHierarchyTypeKey
or an empty list if none found
Errors InvalidParameterException contextInfo is invalid
MissingParameterException orgHierarchyTypeKey or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgHierarchies
Description Retrieves the list of all organization hierarchies known by
this service.
Parameters ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgHierarchyInfoList a list of organization hierarchies
Errors InvalidParameterException contextInfo is not valid
MissingParameterException contextInfo is missing or
null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgTypes
Description Retrieves the list of types of organizations known by this service.
Parameters ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return TypeInfoList a list of organization types
Errors InvalidParameterException contextInfo is not valid
MissingParameterException contextInfo is missing or
null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrg
Description Retrieves a a single Org by Org Id.
Parameters String orgId the identifier for the Org to be retrieved
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgInfo the Org requested
Errors DoesNotExistException orgId is not found
InvalidParameterException contextInfo is not valid
MissingParameterException orgId or contextInfo is
missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgsByIds
Description Retrieves a list of Orgs from a list of Org Ids. The returned
list may be in any order and if duplicate Ids are supplied, a
unique set may or may not be returned. identifiers.
Parameters StringList orgIds a list of Org Ids
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgInfoList a list of Orgs
Errors DoesNotExistException an orgId in the list not found
InvalidParameterException contextInfo is not valid
MissingParameterException orgIds, an orgId in orgIds,
or contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgIdsByType
Description Retrieves a list of Org Ids by Org Type.
Parameters String orgTypeKey an identifier for the Org type
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return StringList a list of Org Ids matching orgTypeKey or an empty list
if none found
Errors InvalidParameterException contextInfo is invalid
MissingParameterException orgTypeKey or contextInfo is
missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method searchForOrgIds
Description Searches for Org Ids that meet the given search criteria.
Parameters QueryByCriteria criteria the search criteria
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return StringList list of Org identifiers matching the criteria
Errors InvalidParameterException criteria or contextInfo is not valid
MissingParameterException criteria or contextInfo is
missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method searchForOrgs
Description Searches for Orgs that meet the given search criteria.
Parameters QueryByCriteria criteria the search criteria
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgInfoList list of Orgs matching the criteria
Errors InvalidParameterException criteria or contextInfo is not valid
MissingParameterException criteria or contextInfo is
missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

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 Org. If an
identifier is present for the Org (and/or one of its contained
sub-objects) and a record is found for that identifier, the
validation checks if the Org can be shifted to the new
values. If a an identifier is not present or a record does not
exist, the validation checks if the Org with the given data can
be created.
Parameters String validationTypeKey the identifier for the validation Type
String orgTypeKey the identifier for the Org Type to be validated
OrgInfo orgInfo the identifier for the Org to be validated
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return ValidationResultInfoList a list of validation results or an empty list if validation
succeeded
Errors DoesNotExistException validationTypeKey or orgTypeKey
is not found
InvalidParameterException orgInfo or contextInfo is not valid
MissingParameterException validationTypeKey, orgTypeKey
orgInfo, or contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method createOrg
Description Creates a new Org. The Org Id, Type and Meta information may
not be set in the supplied data object.
Parameters String orgTypeKey a unique identifier for the Type of the new
Org
OrgInfo orgInfo the data with which to create the Org
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgInfo the new Org
Errors DataValidationErrorException supplied data is invalid
DoesNotExistException orgTypeKey does not exist or is
not supported
InvalidParameterException orgInfo or contextInfo is not valid
MissingParameterException orgTypeKey, orgInfo, or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred
ReadOnlyException an attempt at supplying information
designated as read only

Back to Operations

Method updateOrg
Description Updates an existing Org. The Org id, Type, and
Meta information may not be changed.
Parameters String orgId the identifier for the Org to be updated
OrgInfo orgInfo the new data for the Org
ContextInfo contextInfo information containing the principalId and locale
information about the caller of service operation
Return OrgInfo the updated Org
Errors DataValidationErrorException supplied data is invalid
DoesNotExistException orgId is not found
InvalidParameterException orgInfo or contextInfo is not valid
MissingParameterException orgId, orgInfo, or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred
ReadOnlyException an attempt at supplying information
designated as read only
VersionMismatchException an optimistic locking failure
or the action was attempted on an out of date version

Back to Operations

Method deleteOrg
Description Deletes an existing Org.
Parameters String orgId the identifier for the Org to be deleted
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return StatusInfo the status of the operation. This must always be true.
Errors DoesNotExistException orgId is not found
InvalidParameterException contextInfo is not valid
MissingParameterException orgId or contextInfo is
missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgOrgRelationTypes
Description Retrieves the list of all types of relationships between
organizations known to the service.
Parameters ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return TypeInfoList list of organization to organization relationship types
Errors InvalidParameterException contextInfo is not valid
MissingParameterException contextInfo is missing or
null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgOrgRelationTypesForOrgType
Description Retrieves the Types of relationships between organizations that
are allowed for a particular type of organization.
Parameters String orgTypeKey an identifier for an Org Type
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return TypeInfoList a list of relationship types between organizations for
the specified organization type or an empty list if
none found
Errors InvalidParameterException contextInfo is not valid
MissingParameterException orgTypeKey or contextInfo is
missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgOrgRelationTypeForOrgType
Description Retrieves the Types of relationships between organizations that
are allowed for a particular type of organization.
============== Deprecated ===============
Parameters String orgTypeKey an identifier for an Org Type
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return TypeInfo a list of relationship types between organizations for
the specified organization type or an empty list if
none found
Errors InvalidParameterException contextInfo is not valid
MissingParameterException orgTypeKey or contextInfo is
missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgOrgRelationTypesForOrgHierarchy
Description Retrieves the Types of relationships between organizations that
are allowed for a particular organization hierarchy.
Parameters String orgHierarchyId an identifier for an OrgHierarchy
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return TypeInfoList a list of relationship types between organizations
Errors DoesNotExistException orgHierarchyId is is not found
InvalidParameterException contextInfo is not valid
MissingParameterException orgHierarchyId or contextInfo
is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method hasOrgOrgRelation
Description Tests if a org has a current relationship with a specified organization.
Parameters String orgId identifier of the organization
String comparisonOrgId identifier of the organization to be compared to
String orgOrgRelationTypeKey type of relationship between the organizations
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return Boolean true if a relationship between the two Ids exists, false
if no relation exists or is not found
Errors InvalidParameterException contextInfo is not valid
MissingParameterException orgId, comparisonOrgId,
orgOrgRelationType, or contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgOrgRelation
Description Retrieves a single OrgOrgRelation by OrgOrgRelation Id.
Parameters String orgOrgRelationId the identifier for OrgOrgRelation to be
retrieved
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgOrgRelationInfo the OrgOrgRelation requested
Errors DoesNotExistException orgOrgRelationId is not found
InvalidParameterException contextInfo is not valid
MissingParameterException orgOrgRelationId or contextInfo
is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgOrgRelationsByIds
Description Retrieves a list of OrgOrgRelations from a list of
OrgOrgRelation Ids. The returned list may be in any order and
if duplicate Ids are supplied, a unique set may or may not be
returned.
Parameters StringList orgOrgRelationIds a list of OrgOrgRelation identifiers
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgOrgRelationInfoList a list of OrgOrgRelations
Errors DoesNotExistException an orgOrgRelationId in the list not found
InvalidParameterException contextInfo is not valid
MissingParameterException orgOrgRelationIds, an
orgOrgRelationId in the orgOrgRelationIds, or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgOrgRelationIdsByType
Description Retrieves a list of OrgOrgRelation Ids by OrgOrgRelation Type.
Parameters String orgOrgRelationTypeKey an identifier for an OrgOrgRelation Type
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return StringList a list of OrgOrgRelation identifiers matching
orgOrgRelationTypeKey or an empty list if none found
Errors InvalidParameterException contextInfo is not valid
MissingParameterException orgOrgRelationTypeKey or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgOrgRelationsByOrg
Description Retrieves all OrgOrgRelations to the given Org independent of
which side of the relationship the Org resides.
Parameters String orgId the identifier for the Org
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgOrgRelationInfoList a list of OrgOrgrelations to the given Org or an empty list if
none found
Errors InvalidParameterException contextInfo is not valid
MissingParameterException orgId or contextInfo is
missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgOrgRelationsByOrgs
Description Retrieves all OrgOrgRelations between the given Orgs.
Parameters String orgId the identifier for the Org
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgOrgRelationInfoList a list of OrgOrgrelations between the given Orgs or an empty list
if none found
Errors InvalidParameterException contextInfo is not valid
MissingParameterException orgId, orgPeerId, or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgOrgRelationsByTypeAndOrg
Description Retrieves a list of OrgOrgRelations of the specified
OrgOrgRelationType for an Org. (these parameters are
backwards).
Parameters String orgId the identifier for an Org
String orgOrgRelationTypeKey the identifier for an
OrgOrgRelation Type
ContextInfo contextInfo information containing the principalId and locale
information about the caller of service operation
Return OrgOrgRelationInfoList a list of OrgOrgRelations of the specified OrgOrgRelationType for
the given Org or an empty list if none found
Errors InvalidParameterException contextInfo is notvalid
MissingParameterException orgOrgRelationTypeKey, orgId, or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method searchForOrgOrgRelationIds
Description Searches for OrgOrgRelations that meet the given search criteria.
Parameters QueryByCriteria criteria the search criteria
ContextInfo contextInfo information containing the principalId and locale
information about the caller of service operation
Return StringList a list of OrgOrgRelation identifiers matching the criteria
Errors InvalidParameterException criteria or contextInfo is not valid
MissingParameterException criteria or contextInfo is missing or
null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method searchForOrgOrgRelations
Description Searches for OrgOrgRelations that meet the given search
criteria.
Parameters QueryByCriteria criteria the search criteria
ContextInfo contextInfo information containing the principalId and locale
information about the caller of service operation
Return OrgOrgRelationInfoList a list of OrgOrgRelations matching the criteria
Errors InvalidParameterException contextInfo is invalid
MissingParameterException criteria or contextInfo is missing or
null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method validateOrgOrgRelation
Description Validates an OrgOrgRelation. Depending on the value of
validationType, this validation could be limited to tests on
just the current OrgOrgRelation and its directly contained
sub-objects or expanded to perform all tests related to this
OrgOrgRelation. If an identifier is present for the
OrgOrgRelation (and/or one of its contained sub-objects) and a
record is found for that identifier, the validation checks if
the OrgOrgRelation can be shifted to the new values. If an
identifier is not present or a record cannot be found for the
identifier, the validation checks if the object with the given
data can be created.
Parameters String validationTypeKey the identifier for the validation Type
String orgId the identifier for an Org
String orgPeerId a the identifier for the Org peer
String orgOrgRelationTypeKey the identifier for the OrgOrgRelation Type
OrgOrgRelationInfo orgOrgRelationInfo the OrgOrgRelation to be validated
ContextInfo contextInfo information containing the principalId and locale
information about the caller of service operation
Return ValidationResultInfoList a list of validation results or an empty list if validation
succeeded
Errors DoesNotExistException validationTypeKey, orgId,
orgPeerId, or orgOrgRelationTypeKey is not found
InvalidParameterException orgOrgRelationInfo or
contextInfo is not valid
MissingParameterException validationTypeKey, orgId,
orgPeerId, orgOrgRelationTypeKey, orgOrgRelationInfo,
or contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException authorization failure

Back to Operations

Method createOrgOrgRelation
Description Creates a new OrgOrgRelation. The OrgOrgRelation Id, Type, Org
Ids, and Meta information may not be set in the supplied data.
Parameters String orgId a peer of the relationship
String orgPeerId a peer of the relationship
String orgOrgRelationTypeKey the identifier for the Type of OrgOrgRelation
OrgOrgRelationInfo orgOrgRelationInfo the relationship to be created
ContextInfo contextInfo information containing the principalId and locale
information about the caller of service operation
Return OrgOrgRelationInfo the new OrgOrgRelation
Errors DoesNotExistException orgId, orgPeerId, or
orgOrgRelationTypeKey is not found
DataValidationErrorException supplied data is invalid
InvalidParameterException orgOrgRelationInfo or contextInfo is
not valid
MissingParameterException orgId, orgPeerId,
orgOrgRelationTypeKey, orgOrgRelationInfo, or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred
ReadOnlyException an attempt at supplying information
designated as read only

Back to Operations

Method updateOrgOrgRelation
Description Updates an Org Milestone Relationship. The OrgOrgRelation Id,
Type, Org Ids, and Meta information may not be changed.
Parameters String orgOrgRelationId the identifier for the OrgOrgRelation updated
OrgOrgRelationInfo orgOrgRelationInfo the new data for the OrgOrgRelation
ContextInfo contextInfo information containing the principalId and locale
information about the caller of service operation
Return OrgOrgRelationInfo the updated OrgOrgRelation
Errors DataValidationErrorException supplied data is invalid
DoesNotExistException orgOrgRelationId is not found
InvalidParameterException orgOrgRelationInfo or
contextInfo is not valid
MissingParameterException orgOrgRelationId,
orgOrgRelationInfo, or contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred
ReadOnlyException an attempt at supplying information
designated as read-only
VersionMismatchException optimistic locking failure or the action
was attempted on an out of date version

Back to Operations

Method deleteOrgOrgRelation
Description Deletes an existing OrgOrgRelation.
Parameters String orgOrgRelationId the identifier for the OrgOrgRelation
to be deleted
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return StatusInfo status of the delete operation. This must always be true.
Errors DoesNotExistException orgOrgrelationId is not found
InvalidParameterException contextInfo is not valid
MissingParameterException orgOrgRelationId or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgPersonRelationTypes
Description Retrieves all Types of OrgPersonRelations between an
organization and a person known by this service.
Parameters ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return TypeInfoList a list of all OrgPersonRelation Types
Errors InvalidParameterException contextInfo is not valid
MissingParameterException contextInfo is missing or
null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgPersonRelationTypesForOrgType
Description Retrieves the OrgPersonRelationship Types between an
organization and a person that are allowed for a particular Org
Type.
Parameters String orgTypeKey an identifier for an Org Type
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return TypeInfoList a list of organization person relationship types that
are valid for the supplied organization type or an
empty list of none found
Errors InvalidParameterException contextInfo is not valid
MissingParameterException orgTypeKey or contextInfo is
missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method hasOrgPersonRelation
Description Tests if a person has a current relationship with a specified
organization
Parameters String orgId identifier of the organization
String personId identifier of the person
String orgPersonRelationTypeKey type of relationship between the
person and organization
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return Boolean true if a relationship between the two Ids exists, false if
no relation exists or is not found
Errors InvalidParameterException contextInfo is not valid
MissingParameterException orgId, personId,
orgPersonRelationTypeKey, or contextInfo is missing or
null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgPersonRelation
Description Retrieves a single OrgPersonRelation by OrgPersonRelation Id.
Parameters String orgPersonRelationId the identifier for the OrgPersonRelation
to be retrieved
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgPersonRelationInfo the OrgPersonRelation requested
Errors DoesNotExistException orgPersonRelationId is not found
InvalidParameterException contextInfo is not valid
MissingParameterException orgPersonRelationId or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgPersonRelationsByIds
Description Retrieves a list of OrgPersonRelations from a list of
OrgPersonRelation Ids. The returned list may be in any order and
if duplicate Ids are supplied, a unique set may or may not be
returned.
Parameters StringList orgPersonRelationIds a list of OrgPersonRelation identifiers
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgPersonRelationInfoList a list of OrgPersonRelations
Errors DoesNotExistException an orgPersonRelationId in the list not found
InvalidParameterException contextInfo is not valid
MissingParameterException orgPersonRelationIds, an
orgPersonRelationId in the orgPersonRelationIds, or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgPersonRelationIdsByType
Description Retrieves a list of OrgPersonRelation Ids by OrgPersonRelation Type.
Parameters String orgPersonRelationTypeKey an identifier for an OrgPersonRelation Type
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return StringList a list of OrgPersonRelation identifiers matching
orgPersonRelationTypeKey or an empty list if none found
Errors InvalidParameterException contextInfo is not valid
MissingParameterException orgPersonRelationTypeKey or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgPersonRelationsByOrg
Description Retrieves all OrgPersonRelations to the given Org.
Parameters String orgId the identifier for the Org
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgPersonRelationInfoList a list of OrgPersonRelations to the given Org or an
empty list if none found
Errors InvalidParameterException contextInfo is not valid
MissingParameterException orgId or contextInfo is
missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgPersonRelationsByTypeAndOrg
Description Retrieves a list of OrgPersonRelations of the specified
OrgPersonRelationType for an Org.
Parameters String orgPersonRelationTypeKey the identifier for an
OrgPersonRelationType
String orgId the identifier for an Org
ContextInfo contextInfo information containing the principalId and locale
information about the caller of service operation
Return OrgPersonRelationInfoList a list of OrgPersonRelations of the specified OrgPersonRelationType for
the given Org or an empty list if none found
Errors InvalidParameterException contextInfo is not valid
MissingParameterException orgPersonRelationTypeKey,
orgId, or contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgPersonRelationByTypeAndOrg
Description Retrieves a list of OrgPersonRelations of the specified
OrgPersonRelationType for an Org.
============== Deprecated ===============
Parameters String orgPersonRelationTypeKey the identifier for an
OrgPersonRelationType
String orgId the identifier for an Org
ContextInfo contextInfo information containing the principalId and locale
information about the caller of service operation
Return OrgPersonRelationInfo a list of OrgPersonRelations of the specified OrgPersonRelationType for
the given Org or an empty list if none found
Errors InvalidParameterException contextInfo is not valid
MissingParameterException orgPersonRelationTypeKey,
orgId, or contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgPersonRelationsByPerson
Description Retrieves all OrgPersonRelations to the given Person.
Parameters String personId the identifier for the Person
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgPersonRelationInfoList a list of OrgPersonRelations to the given Person or an
empty list if none found
Errors InvalidParameterException contextInfo is not valid
MissingParameterException personId or contextInfo is
missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgPersonRelationsByTypeAndPerson
Description Retrieves a list of OrgPersonRelations of the specified
OrgPersonRelationType for a Person.
Parameters String orgPersonRelationTypeKey the identifier for an
OrgPersonRelationType
String personId the identifier for a Person
ContextInfo contextInfo information containing the principalId and locale
information about the caller of service operation
Return OrgPersonRelationInfoList a list of OrgPersonRelations of the specified OrgPersonRelationType for
the given Person or an empty list if none found
Errors InvalidParameterException contextInfo is notvalid
MissingParameterException orgPersonRelationTypeKey,
personId, or contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgPersonRelationsByOrgAndPerson
Description Retrieves all OrgPersonRelations between the given Orn and
Person.
Parameters String orgId the identifier for the Org
String personId the identifier for the Person
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgPersonRelationInfoList a list of OrgPersonRelations to the given Org and
Person or an empty list if none found
Errors InvalidParameterException contextInfo is not valid
MissingParameterException orgId, personId or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgPersonRelationsByTypeAndOrgAndPerson
Description Retrieves a list of OrgPersonRelations of the specified
OrgPersonRelationType between an Org and a Person.
Parameters String orgPersonRelationTypeKey the identifier for an
OrgPersonRelationType
String orgId the identifier for the Org
String personId the identifier for a Person
ContextInfo contextInfo information containing the principalId and locale
information about the caller of service operation
Return OrgPersonRelationInfoList a list of OrgPersonRelations of the specified
OrgPersonRelationType for the given Org and Person or
an empty list if none found
Errors InvalidParameterException contextInfo is not valid
MissingParameterException orgPersonRelationTypeKey,
orgId, personId, or contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method searchForOrgPersonRelationIds
Description Searches for OrgPersonRelation Ids that meet the given search
criteria.
Parameters QueryByCriteria criteria the search criteria
ContextInfo contextInfo information containing the principalId and locale
information about the caller of service operation
Return StringList a list of OrgPersonRelation identifiers matching the criteria
Errors InvalidParameterException criteria or contextInfo is not valid
MissingParameterException criteria or contextInfo is missing or
null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method searchForOrgPersonRelations
Description Searches for OrgPersonRelations that meet the given search
criteria.
Parameters QueryByCriteria criteria the search criteria
ContextInfo contextInfo information containing the principalId and locale
information about the caller of service operation
Return OrgPersonRelationInfoList a list of OrgPersonRelations matching the criteria
Errors InvalidParameterException contextInfo is invalid
MissingParameterException criteria or contextInfo is missing or
null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method validateOrgPersonRelation
Description Validates an OrgPersonRelation. Depending on the value of
validationType, this validation could be limited to tests on
just the current OrgPersonRelation and its directly contained
sub-objects or expanded to perform all tests related to this
OrgPersonRelation. If an identifier is present for the
OrgPersonRelation (and/or one of its contained sub-objects) and
a record is found for that identifier, the validation checks if
the OrgPersonRelation can be shifted to the new values. If an
identifier is not present or a record cannot be found for the
identifier, the validation checks if the object with the given
data can be created.
Parameters String validationTypeKey the identifier for the validation Type
String orgId the identifier for an Org
String personId a the identifier for the Org peer
String orgPersonRelationTypeKey the identifier for the OrgPersonRelation Type
OrgPersonRelationInfo orgPersonRelationInfo the OrgPersonRelation to be validated
ContextInfo contextInfo information containing the principalId and locale
information about the caller of service operation
Return ValidationResultInfoList a list of validation results or an empty list if validation
succeeded
Errors DoesNotExistException validationTypeKey, orgId,
personId, or orgPersonRelationTypeKey is not found
InvalidParameterException orgPersonRelationInfo or
contextInfo is not valid
MissingParameterException validationTypeKey, orgId,
personId, orgPersonRelationTypeKey, orgPersonRelationInfo,
or contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException authorization failure

Back to Operations

Method createOrgPersonRelation
Description Creates a new OrgPersonRelation. The OrgPersonRelation Id, Type, Org
Ids, and Meta information may not be set in the supplied data.
Parameters String orgId a peer of the relationship
String personId a peer of the relationship
String orgPersonRelationTypeKey the identifier for the Type of
OrgPersonRelation
OrgPersonRelationInfo orgPersonRelationInfo the relationship to be created
ContextInfo contextInfo information containing the principalId and locale
information about the caller of service operation
Return OrgPersonRelationInfo the new OrgPersonRelation
Errors DoesNotExistException orgId, personId, or
orgPersonRelationTypeKey is not found
DataValidationErrorException supplied data is invalid
InvalidParameterException orgPersonRelationInfo or contextInfo is
not valid
MissingParameterException orgId, personId,
orgPersonRelationTypeKey, orgPersonRelationInfo, or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred
ReadOnlyException an attempt at supplying information
designated as read only

Back to Operations

Method updateOrgPersonRelation
Description Updates an Org Milestone Relationship. The OrgPersonRelation Id,
Type, Org Ids, and Meta information may not be changed.
Parameters String orgPersonRelationId the identifier for the
OrgPersonRelation updated
OrgPersonRelationInfo orgPersonRelationInfo the new data for the OrgPersonRelation
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgPersonRelationInfo the updated OrgPersonRelation
Errors DataValidationErrorException supplied data is invalid
DoesNotExistException orgPersonRelationId is not found
InvalidParameterException orgPersonRelationInfo or
contextInfo is not valid
MissingParameterException orgPersonRelationId,
orgPersonRelationInfo, or contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred
ReadOnlyException an attempt at supplying information
designated as read-only
VersionMismatchException optimistic locking failure or
the action was attempted on an out of date version

Back to Operations

Method deleteOrgPersonRelation
Description Deletes an existing OrgPersonRelation.
Parameters String orgPersonRelationId the identifier for the
OrgPersonRelation to be deleted
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return StatusInfo status of the delete operation. This must always be true.
Errors DoesNotExistException orgPersonrelationId is not found
InvalidParameterException contextInfo is not valid
MissingParameterException orgPersonRelationId or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgPositionRestriction
Description Retrieves a single OrgPositionRestriction by
OrgPositionRestriction id.
Parameters String orgPositionRestrictionId the identifier of the
OrgPositionRestriction to be retrieved
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgPositionRestrictionInfo the OrgPositionRestriction requested
Errors DoesNotExistException orgPositionRestrictionId is not found
InvalidParameterException contextInfo not valid
MissingParameterException orgPositionRestrictionId or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgPositionRestrictionsByIds
Description Retrieves a list of OrgPositionRestrictions from a list of
OrgPositionRestriction Ids. The returned list may be in any
order and if duplicate Ids are supplied, a unique set may or
may not be returned.
Parameters StringList orgPositionRestrictionIds a list of OrgPositionRestriction Ids
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgPositionRestrictionInfoList a list of OrgPositionRestrictions
Errors DoesNotExistException an orgPositionRestrictionId in
the list not found
InvalidParameterException contextInfo is not valid
MissingParameterException orgPositionRestrictionIds, an
id in orgPositionRestrictionIds, or contextInfo is
missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgPositionRestrictionIdsByType
Description Retrieves a list of OrgPositionRestrictions by
OrgPositionRestriction Type.
Parameters String orgPersonRelationTypeKey an identifier for the OrgPositionRestriction
type
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return StringList a list of OrgPositionRestriction Ids matching
orgPersonRelationTypeKey or an empty list if none found
Errors InvalidParameterException contextInfo is invalid
MissingParameterException orgPersonRelationTypeKey or contextInfo is
missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgPositionRestrictionIdsByOrg
Description Retrieves a list of OrgPositionRestrictions by Org.
Parameters String orgId an identifier for the Org
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return StringList a list of OrgPositionRestrictions for the Org
Errors DoesNotExistException orgId is not found
InvalidParameterException contextInfo is invalid
MissingParameterException orgIdy or contextInfo is
missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method searchForOrgPositionRestrictionIds
Description Searches for OrgPositionRestriction Ids that meet the given
search criteria.
Parameters QueryByCriteria criteria the search criteria
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return StringList list of OrgPositionRestriction identifiers matching the
criteria
Errors InvalidParameterException criteria or contextInfo is not valid
MissingParameterException criteria or contextInfo is
missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method searchForOrgPositionRestrictions
Description Searches for OrgPositionRestrictions that meet the given search
criteria.
Parameters QueryByCriteria criteria the search criteria
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgPositionRestrictionInfoList list of OrgPositionRestrictions matching the criteria
Errors InvalidParameterException criteria or contextInfo is
not valid
MissingParameterException criteria or contextInfo is
missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method validateOrgPositionRestriction
Description Validates an OrgPositionRestriction. 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
OrgPositionRestriction. If an identifier is present for the
OrgPositionRestriction (and/or one of its contained
sub-objects) and a record is found for that identifier, the
validation checks if the OrgPositionRestriction can be shifted
to the new values. If a an identifier is not present or a
record does not exist, the validation checks if the
OrgPositionRestriction with the given data can be created.
Parameters String validationTypeKey the identifier for the validation Type
String orgId the identifier for the Org
String orgPersonRelationTypeKey the identifier for the
OrgPositionRestriction Type to be validated
OrgPositionRestrictionInfo orgPositionRestrictionInfo the identifier for the
OrgPositionRestriction to be validated
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return ValidationResultInfoList a list of validation results or an empty list if
validation succeeded
Errors DoesNotExistException validationTypeKey, orgId, or
orgPersonRelationTypeKey is not found
InvalidParameterException orgPositionRestrictionInfo or
contextInfo is not valid
MissingParameterException validationTypeKey, orgId,
orgPersonRelationTypeKey
orgPositionRestrictionInfo, or contextInfo is missing
or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method createOrgPositionRestriction
Description Creates a new OrgPositionRestriction. The
OrgPositionRestriction Type and Meta information may not be set
in the supplied data object.
Parameters String orgId ???
String orgPersonRelationTypeKey a unique identifier for
the Type of the new OrgPositionRestriction
OrgPositionRestrictionInfo orgPositionRestrictionInfo the data with which to create
the OrgPositionRestriction
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgPositionRestrictionInfo the new OrgPositionRestriction
Errors DataValidationErrorException supplied data is invalid
DoesNotExistException orgPersonRelationTypeKey does not exist or is
not supported
InvalidParameterException orgPositionRestrictionInfo or contextInfo is not valid
MissingParameterException orgId,
orgPersonRelationTypeKey,
orgPositionRestrictionInfo, or contextInfo is missing
or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred
ReadOnlyException an attempt at supplying information
designated as read only

Back to Operations

Method updateOrgPositionRestriction
Description Updates an existing OrgPositionRestriction. The
OrgPositionRestriction id, Type, and Meta information may not
be changed.
Parameters String orgPositionRestrictionId the identifier for the
OrgPositionRestriction to be updated
OrgPositionRestrictionInfo orgPositionRestrictionInfo the new data for the OrgPositionRestriction
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgPositionRestrictionInfo the updated OrgPositionRestriction
Errors DataValidationErrorException supplied data is invalid
DoesNotExistException orgPositionRestrictionId is not found
InvalidParameterException orgPositionRestrictionInfo or
contextInfo is not valid
MissingParameterException orgPositionRestrictionId,
orgPositionRestrictionInfo, or contextInfo is missing
or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred
ReadOnlyException an attempt at supplying information
designated as read only
VersionMismatchException an optimistic locking failure
or the action was attempted on an out of date version

Back to Operations

Method deleteOrgPositionRestriction
Description Deletes an existing OrgPositionRestriction.
Parameters String orgPositionRestrictionId the identifier for the
OrgPositionRestriction to be deleted
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return StatusInfo the status of the operation. This must always be true.
Errors DoesNotExistException orgPositionRestrictionId is not found
InvalidParameterException contextInfo is not valid
MissingParameterException orgPositionRestrictionId or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

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 String orgId identifier of the "ancestor" organization
String descendantOrgId identifier of the organization to be
checked if it is a descendant
String orgHierarchyId the identifier of the organization
hierarchy to be checked against
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return Boolean true if the organization is a descendant of the other
organization in that hierarchy, false if not a descendant
or does not exist
Errors InvalidParameterException contextInfo is not valid
MissingParameterException orgId, descendantOrgId,
orgHierarchyId, or contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getAllDescendants
Description Retrieves the list of identifiers for all "descendant"
organizations of the specified organization in the given
organization hierarchy, regardless of the distance from the
specified organization. Information about the distance from
the original organization is not returned by this call, so this
can be seen as a flattened and de-duplicated representation.
Parameters String orgId identifier of the "ancestor" organization
String orgHierarchyId identifier of the organization hierarchy
to be checked against
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return StringList a list of identifiers for the "descendant" organizations
for the specified organization
Errors DoesNotExistException rootOrgId or orgHierarchyId is
not found, or orgId not part of orgHierarchyId
InvalidParameterException contextInfo is not valid
MissingParameterException orgId, orgHierarchyId, or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getAllAncestors
Description Retrieves the list of identifiers for all "ancestor"
organizations of the the specified organization in the given
organization hierarchy, regardless of the distance from the
specified organization. Information about the distance from
the original organization is not returned by this call, so this
can be seen as a flattened and de-duplicated representation.
Parameters String orgId identifier of the "descendant" organization
String orgHierarchyId identifier of the organization hierarchy to
be checked against
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return StringList a list of identifiers for the "ancestor" organizations
of the specified organization
Errors DoesNotExistException rootOrgId or orgHierarchyId is
not found, or orgId not part of orgHierarchyId
InvalidParameterException contextInfo is not valid
MissingParameterException orgId, orgHierarchyId, or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations

Method getOrgTree
Description Finds a list of all orgs in the org hierarchy starting at the
root org and going down maxLevels of the tree
Parameters String rootOrgId ???
String orgHierarchyId ???
int maxLevels the max number of levels in the tree to
return. If set to 0 returns all nodes in the tree
ContextInfo contextInfo information containing the principalId and
locale information about the caller of service operation
Return OrgTreeInfoList List of OrgTreeInfo in
Errors DoesNotExistException rootOrgId or orgHierarchyId is
not found, or rootOrgId is not part or orgHierarchyId
InvalidParameterException contextInfo is not valid
MissingParameterException rootOrgId, orgHierarchyId, or
contextInfo is missing or null
OperationFailedException unable to complete request
PermissionDeniedException an authorization failure occurred

Back to Operations