String Comparison Resource
URL: /openempi-ws-rest/1.0/records/findByAttributes
Parameters
Parameter | Value Type | Parameter Type | R/O | Description |
|---|---|---|---|---|
entityId | Integer | Query Parameter | R | The unique identifier of the entity type whose records are queried |
| firstResult | Integer | Query Parameter | O | The number of records to skip before the first result record |
| maxResults | Integer | Query Parameter | O | The maximum number of records that should be returned |
| ketVal | String of Key, Value pair | Query Parameter | R | The key value pair that will be used to constrain the set of results returned. This is a repeating parameter and the value of the parameter will be coerced into the datatype of the attribute identified by the key |
Methods
GET
Returns the list of records of the entity type specified that match the query criteria provided in the request in the form of a list of key-value pairs.
Responses
200 - application/json - Returns a JSON representation of the response based on the Accept header
200 - application/xml - Returns an XML representation of the response based on the Accept header
404 - Returned if there is no entity known in the system with that entityId
Example
Version 1.0
Entity id is 7650.
keyVal pairs are
familyName,Hon
givenName,Albert
Return:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><records>
<record>
<entityId>7650</entityId>
<field>
<name>city</name>
<value>Tucson</value>
</field>
<field>
<name>givenName</name>
<value>Albert</value>
</field>
<field>
<name>state</name>
<value>AZ</value>
</field>
<field>
<name>address1</name>
<value>15 N Saguaro</value>
</field>
<field>
<name>gender</name>
<value>M</value>
</field>
<field>
<name>country</name>
<value>USA</value>
</field>
<field>
<name>dateOfBirth</name>
<value>1961-01-01</value>
</field>
<field>
<name>postalCode</name>
<value>85701</value>
</field>
<field>
<name>familyName</name>
<value>Hon</value>
</field>
<identifier>
<dateCreated>2013-10-03T10:52:44.826-04:00</dateCreated>
<identifier>IHERED-999</identifier>
<identifierDomain>
<dateCreated>2013-01-17T11:33:45.903-05:00</dateCreated>
<identifierDomainDescription>IHERED</identifierDomainDescription>
<identifierDomainId>2750</identifierDomainId>
<identifierDomainName>IHERED</identifierDomainName>
<namespaceIdentifier>IHERED</namespaceIdentifier>
<universalIdentifier>1.3.6.1.4.1.21367.13.20.1000</universalIdentifier>
<universalIdentifierTypeCode>ISO</universalIdentifierTypeCode>
</identifierDomain>
<identifierDomainId>2750</identifierDomainId>
<identifierId>9</identifierId>
</identifier>
<recordId>4</recordId>
</record>
</records>