DataService

<back to all web services

PatientSearch

Requires Authentication
The following routes are available for this service:
GET/data-api/v1/{clientid}/patients
PatientSearch Parameters:
NameParameterData TypeRequiredDescription
CaseTypesquerystringNo
GenderquerystringNo
BirthDayIntervalqueryint?No
IsActivequerybool?No
AllowsMarketingquerybool?No
HasConsentForMessagingqueryboolNo
IncludeDemographicsqueryboolNo
IncludeContactqueryboolNo
IncludeProviderqueryboolNo
RequestBase Parameters:
NameParameterData TypeRequiredDescription
ClientIdformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /data-api/v1/{clientid}/patients HTTP/1.1 
Host: dataservice.mychirotouch.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[{"Id":0,"FirstName":"String","MiddleName":"String","LastName":"String","CaseType":"String","ContactInfo":{"Mobile":"String","Email":"String"},"Demographics":{"Birthdate":"0001-01-01T00:00:00.0000000","Sex":"String"},"Provider":{"Id":0,"DisplayName":"String"},"Appointment":{"Purpose":"String","Date":"0001-01-01T00:00:00.0000000","Length":0}}]