GET /hcp/referrer/search


Get record(s) by mixed criteria on most of the referrer table fields.

Resource URL

http://www.lsitampa.com/hcp/referrer/search.{response_format}

Method

GET

Response Format

json

Parameters

from - optional
Date in format YYYY-MM-DD. This uses the updated_at field for selection. If omitted it will default to today.
to - optional
Date in format YYYY-MM-DD. This uses the updated_at field for selection. If omitted it will default to today.
ids - optional
Collection of Referrer ids. (delimited by dashes)
first_name - optional
First Name of the Referrer. (uses wildcard %)
last_name - optional
Last Name of the Referrer. (uses wildcard %)
name - optional
First or Last Name of the Referrer. (uses wildcard %)
discovering_liason_id - optional
Liaison ID of the Referrer.
suffix_id - optional
Suffix ID (aka Title) of the Referrer.
profession_id - optional
Profession ID (aka Specialty) of the Referrer.
practice_id - optional
Practice ID of the Referrer.
address - optional
Address of the Referrer. (uses wildcard %)
city - optional
City of the Referrer. (uses wildcard %)
postal_code - optional
Postal/Zipcode of the Referrer. (uses wildcard %)
state_province - optional
State abbreviation of the Referrer.
region_id - optional
Region ID of the Referrer.
phone - optional
Phone of the Referrer.
mobile - optional
Mobile of the Referrer.
fax - optional
Fax of the Referrer.
email - optional
Email of the Referrer. (uses wildcard %)
website - optional
Website of the Referrer. (uses wildcard %)
social_media - optional
Social Media of the Referrer. (uses wildcard %)
category_id - optional
Category ID of the Referrer.
newsletter - optional
Newsletter of the Referrer.
active - optional
Checks for active records only. Usable values yes, 1 or true, case insensitive.
debug - optional
Used for debugging purposes
orderby - optional
Used to set the returned ordering of rows. ex. field ASC field ASC,field2 DESC
offset - optional
The record offset from which point on to return records as a non-negative integer value. This is equivalent to the first parameter in the MySql LIMIT clause. If omitted: 0.
rowcount - optional
A non-negative integer value that specifies the number of records to return. If omitted: 100.
jsonp_callback - optional
If making cross domain Ajax calls use this as the call-back method name in your Ajax request.

HTTP Errors

400
{
  "error": {
    "code": 400,
    "message": "Bad request (if set by the developer, specific reason for bad request)"
  }
}
404
{
  "error": {
    "code": 404,
    "message": "Not found"
  }
}
500
{
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}