WADL for Person Query Service

WADL for Person Query Service

This section provide the WADL document for the Person Query Service. This forms the high-level documentation for all the methods exposed through the Person Query Resource.

        <resource path="/person-query-resource">
            <resource path="/getPersonLinks">
                <method id="getPersonLinks" name="POST">
                    <request>
                        <ns2:representation element="person" mediaType="application/xml" />
                    </request>
                    <response>
                        <ns2:representation element="personLink"
                            mediaType="application/xml" />
                        <ns2:representation element="personLink"
                            mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/getIdentifierDomains">
                <method id="getIdentifierDomains" name="GET">
                    <response>
                        <ns2:representation element="identifierDomain"
                            mediaType="application/xml" />
                        <ns2:representation element="identifierDomain"
                            mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/loadAllUnreviewedPersonLinks">
                <method id="loadAllUnreviewedPersonLinks" name="GET">
                    <response>
                        <ns2:representation element="reviewRecordPair"
                            mediaType="application/xml" />
                        <ns2:representation element="reviewRecordPair"
                            mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/loadUnreviewedPersonLinks">
                <method id="loadUnreviewedPersonLinks" name="GET">
                    <request>
                        <param name="maxRecords" style="query" type="xs:int" />
                    </request>
                    <response>
                        <ns2:representation element="reviewRecordPair"
                            mediaType="application/xml" />
                        <ns2:representation element="reviewRecordPair"
                            mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/loadReviewRecordPair">
                <method id="loadReviewRecordPair" name="GET">
                    <request>
                        <param name="personLinkReviewId" style="query" type="xs:int" />
                    </request>
                    <response>
                        <ns2:representation element="reviewRecordPair"
                            mediaType="application/xml" />
                        <ns2:representation element="reviewRecordPair"
                            mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/findMatchingPersonsByAttributes">
                <method id="findMatchingPersonsByAttributes" name="POST">
                    <request>
                        <ns2:representation element="person" mediaType="application/xml" />
                    </request>
                    <response>
                        <ns2:representation element="person" mediaType="application/xml" />
                        <ns2:representation element="person" mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/findPersonsByAttributes">
                <method id="findPersonsByAttributes" name="POST">
                    <request>
                        <ns2:representation element="person" mediaType="application/xml" />
                    </request>
                    <response>
                        <ns2:representation element="person" mediaType="application/xml" />
                        <ns2:representation element="person" mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/findLinkedPersons">
                <method id="findLinkedPersons" name="POST">
                    <request>
                        <ns2:representation element="personIdentifier"
                            mediaType="application/xml" />
                    </request>
                    <response>
                        <ns2:representation element="person" mediaType="application/xml" />
                        <ns2:representation element="person" mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/loadPerson">
                <method id="loadPerson" name="GET">
                    <request>
                        <param name="personId" style="query" type="xs:int" />
                    </request>
                    <response>
                        <ns2:representation element="person" mediaType="application/xml" />
                        <ns2:representation element="person" mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/getIdentifierDomainTypeCodes">
                <method id="getIdentifierDomainTypeCodes" name="GET">
                    <response>
                        <ns2:representation element="stringList"
                            mediaType="application/xml" />
                        <ns2:representation element="stringList"
                            mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/getPersonModelAllAttributeNames">
                <method id="getPersonModelAllAttributeNames" name="GET">
                    <response>
                        <ns2:representation element="stringList"
                            mediaType="application/xml" />
                        <ns2:representation element="stringList"
                            mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/getPersonModelAttributeNames">
                <method id="getPersonModelAttributeNames" name="GET">
                    <response>
                        <ns2:representation element="stringList"
                            mediaType="application/xml" />
                        <ns2:representation element="stringList"
                            mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/getPersonModelCustomAttributeNames">
                <method id="getPersonModelCustomAttributeNames" name="GET">
                    <response>
                        <ns2:representation element="stringList"
                            mediaType="application/xml" />
                        <ns2:representation element="stringList"
                            mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/loadPersons">
                <method id="loadPersons" name="GET">
                    <request>
                        <param name="personId" style="query" type="xs:string" />
                    </request>
                    <response>
                        <ns2:representation element="person" mediaType="application/xml" />
                        <ns2:representation element="person" mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/findIdentifierDomain">
                <method id="findIdentifierDomain" name="POST">
                    <request>
                        <ns2:representation element="identifierDomain"
                            mediaType="application/xml" />
                    </request>
                    <response>
                        <ns2:representation element="identifierDomain"
                            mediaType="application/xml" />
                        <ns2:representation element="identifierDomain"
                            mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/getIdentifierDomainAttribute">
                <method id="getIdentifierDomainAttribute" name="POST">
                    <request>
                        <ns2:representation element="identifierDomainAttributeRequest"
                            mediaType="application/xml" />
                    </request>
                    <response>
                        <ns2:representation element="identifierDomainAttribute"
                            mediaType="application/xml" />
                        <ns2:representation element="identifierDomainAttribute"
                            mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/getIdentifierDomainAttributes">
                <method id="getIdentifierDomainAttributes" name="POST">
                    <request>
                        <ns2:representation element="identifierDomain"
                            mediaType="application/xml" />
                    </request>
                    <response>
                        <ns2:representation element="identifierDomainAttribute"
                            mediaType="application/xml" />
                        <ns2:representation element="identifierDomainAttribute"
                            mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/findGenderByCode">
                <method id="findGenderByCode" name="GET">
                    <request>
                        <param name="genderCode" style="query" type="xs:string" />
                    </request>
                    <response>
                        <ns2:representation element="gender" mediaType="application/xml" />
                        <ns2:representation element="gender" mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/findRaceByCode">
                <method id="findRaceByCode" name="GET">
                    <request>
                        <param name="raceCode" style="query" type="xs:string" />
                    </request>
                    <response>
                        <ns2:representation element="race" mediaType="application/xml" />
                        <ns2:representation element="race" mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/findGenderByName">
                <method id="findGenderByName" name="GET">
                    <request>
                        <param name="genderName" style="query" type="xs:string" />
                    </request>
                    <response>
                        <ns2:representation element="gender" mediaType="application/xml" />
                        <ns2:representation element="gender" mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/findRaceByName">
                <method id="findRaceByName" name="GET">
                    <request>
                        <param name="raceName" style="query" type="xs:string" />
                    </request>
                    <response>
                        <ns2:representation element="race" mediaType="application/xml" />
                        <ns2:representation element="race" mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/getSingleBestRecord">
                <method id="getSingleBestRecord" name="GET">
                    <request>
                        <param name="personId" style="query" type="xs:int" />
                    </request>
                    <response>
                        <ns2:representation element="person" mediaType="application/xml" />
                        <ns2:representation element="person" mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/findPersonById">
                <method id="findPersonById" name="POST">
                    <request>
                        <ns2:representation element="personIdentifier"
                            mediaType="application/xml" />
                    </request>
                    <response>
                        <ns2:representation element="person" mediaType="application/xml" />
                        <ns2:representation element="person" mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/getGlobalIdentifierById">
                <method id="getGlobalIdentifierById" name="POST">
                    <request>
                        <ns2:representation element="personIdentifier"
                            mediaType="application/xml" />
                    </request>
                    <response>
                        <ns2:representation element="personIdentifier"
                            mediaType="application/xml" />
                        <ns2:representation element="personIdentifier"
                            mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/loadAllPersonsPaged">
                <method id="loadAllPersonsPaged" name="GET">
                    <request>
                        <param name="firstRecord" style="query" type="xs:int" />
                        <param name="maxRecords" style="query" type="xs:int" />
                    </request>
                    <response>
                        <ns2:representation element="person" mediaType="application/xml" />
                        <ns2:representation element="person" mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/findPersonsByAttributesPaged">
                <method id="findPersonsByAttributesPaged" name="POST">
                    <request>
                        <ns2:representation element="personPagedRequest"
                            mediaType="application/xml" />
                    </request>
                    <response>
                        <ns2:representation element="person" mediaType="application/xml" />
                        <ns2:representation element="person" mediaType="application/json" />
                    </response>
                </method>
            </resource>
            <resource path="/getSingleBestRecords">
                <method id="getSingleBestRecords" name="GET">
                    <request>
                        <param name="personId" style="query" type="xs:string" />
                    </request>
                    <response>
                        <ns2:representation element="person" mediaType="application/xml" />
                        <ns2:representation element="person" mediaType="application/json" />
                    </response>
                </method>
            </resource>
        </resource>