RESTful Web Services Interface (legacy API)

Person Query Resource Documentation

1 min read 28 subsections

This is the top-level page for the documentation of the individual methods that are accessible through the Person Query Resource.

NOTE: This Resource has been deprecated as of version 3.5.0 of OpenEMPI and will be removed in a later major version of OpenEMPI. Please use the Entity REST API in its place.

In this section

findGenderByCode The findGenderByCodemethod returns a Gender record that match with the gender code that was provided.
findGenderByName The findGenderByName returns a Gender record that match with the gender name that was provided.
findIdentifierDomain The findIdentifierDomain method returns an identifier domain located using whichever key is provided for looking up the…
findLinkedPersons This method returns a list of linked person records that linked with the person provided by the identifier.
findMatchingPersonsByAttributes The findMatchingPersonsByAttributes method returns a list of all person records that match any of the person attributes…
findPersonById The findPersonById method returns a person record that match with the identifier that was provided.
findPersonsByAttributes The findPersonsByAttributes method returns a list of Person records that match any of the person attributes that are…
findPersonsByAttributesPaged The findPersonsByAttributesPaged method returns a page of Person records that match any of the person attributes that…
findPersonsById The findPersonsById method returns a list of all person records that have either an exact or partial match with the…
findRaceByCode The findRaceByCode method returns a Race record that match with the race code that was provided.
findRaceByName The findRaceByName method returns a Race record that match with the race name that was provided.
getGlobalIdentifierById The getGlobalIdentifierById method returns a person global identifier record that match with the person identifier that…
getIdentifierDomainAttribute The getIdentifierDomainAttribute method returns an instance of an Identifier Domain Attribute associated with the…
getIdentifierDomainAttributes The getIdentifierDomainAttributes method returns a list of all the identifier domain attributes associated with a given…
getIdentifierDomains The getIdentifierDomains method returns the list of identifier domains known by the system
getIdentifierDomainTypeCodes The getIdentifierDomainTypeCodes method returns the list of distinct identifier domain type codes.
getPersonLinks The getPersonLinks method returns all the person links associated with the person whose record is passed as a parameter.
getPersonModelAllAttributeNames The getPersonModelAllAttributeNames method returns a list of all person attributes that are supported by the current…
getPersonModelAttributeNames The getPersonModelAttributeNames method returns a list of all person attributes that are supported by the current…
getPersonModelCustomAttributeNames The getPersonModelCustomAttributeNames method returns a list of all person attributes which designated to be custom…
getSingleBestRecord The getSingleBestRecord method returns an individual Person record by filtering out the single best record associated…
getSingleBestRecords The getSingleBestRecords method returns an list of Person data entries. For each Person id passed in, method filter out…
loadAllPersonsPaged The loadAllPersonsPaged method returns a page of Person records .
loadAllUnreviewedPersonLinks The loadAllUnreviewedPersonLinks method returns a list of unreviewed record pair element which requires human…
loadPerson The loadPerson method returns an individual Person data entry.
loadUnreviewedPersonLinks The loadUnreviewedPersonLinks method with maximum results retrieved returns a list of unreviewed record pair element…
loadReviewRecordPair The loadReviewRecordPair method returns an individual data entry that describes a possible record pair that was…
loadPersons The loadPersons method returns a list of Person data entry.

Up to RESTful Web Services Interface (legacy API)