Page Comparison

{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getOrgPersonRelationTypesForOrgType
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the types of relationships between an organization and a person that are allowed for a particular organization type.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}[orgTypeKey|orgTypeKey Structure]
{td}
{td:class=methodParamName}orgTypeKey
{td}
{td:class=methodParamDesc}organization type identifier
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[orgPersonRelationTypeInfoList|orgPersonRelationTypeInfoList Structure]
{td}
{td:class=methodReturnDesc}list of organization person relationship types that are valid for the supplied organization type (may have nothing)
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Errors
{th}
{td:class=methodErrorType|colspan=2}DOES_NOT_EXIST
{td}
{td:class=methodErrorDesc}orgType not found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}INVALID_PARAMETER
{td}
{td:class=methodErrorDesc}invalid orgTypeKey
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}MISSING_PARAMETER
{td}
{td:class=methodErrorDesc}missing orgTypeKey
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}

{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getPositionRestrictionsByOrg
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves a list of organization-specific restrictions on relationships with people for a particular organization.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}[orgId|orgId Structure]
{td}
{td:class=methodParamName}orgId
{td}
{td:class=methodParamDesc}identifier of the organization
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[orgPositionRestrictionInfoList|orgPositionRestrictionInfoList Structure]
{td}
{td:class=methodReturnDesc}list of the organization-specific position restriction information
{td}
{tr}
{tr}
{th:class=h|rowspan=6}Errors
{th}
{td:class=methodErrorType|colspan=2}DATA_VALIDATION_ERROR
{td}
{td:class=methodErrorDesc}One or more values invalid for this operation
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}DOES_NOT_EXIST
{td}
{td:class=methodErrorDesc}the orgId not found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}INVALID_PARAMETER
{td}
{td:class=methodErrorDesc}invalid orgId
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}MISSING_PARAMETER
{td}
{td:class=methodErrorDesc}missing orgId
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}PERMISSION_DENIED
{td}
{td:class=methodErrorDesc}authorization failure
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}

{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}searchForOrgPersonRelations
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Searches for identifiers of organization to person relationships by complex criteria and logic.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}[orgPersonRelationCriteria|orgPersonRelationCriteria Structure]
{td}
{td:class=methodParamName}orgPersonRelationCriteria
{td}
{td:class=methodParamDesc}criteria to be used for search, e.g. by type, by name, by number of members
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[orgPersonRelationIdList|orgPersonRelationIdList Structure]
{td}
{td:class=methodReturnDesc}list of organization to person relationship identifiers that matched the supplied criteria
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Errors
{th}
{td:class=methodErrorType|colspan=2}INVALID_PARAMETER
{td}
{td:class=methodErrorDesc}invalid organization to person relationship criteria
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}MISSING_PARAMETER
{td}
{td:class=methodErrorDesc}missing organization to person relationship criteria
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}PERMISSION_DENIED
{td}
{td:class=methodErrorDesc}authorization failure
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}