DataService

<back to all web services

PatientForRetentionSearchV2

Requires Authentication
The following routes are available for this service:
GET/data-api/v2/{clientid}/patients-for-retention
PatientForRetentionSearchV2 Parameters:
NameParameterData TypeRequiredDescription
CaseTypesquerystringNo
ProviderIdsquerystringNo
HasFutureAppointmentquerybool?No
MissedVisitIntervalqueryint?No
InitialVisitIntervalqueryint?No
RequestBase Parameters:
NameParameterData TypeRequiredDescription
ClientIdformstringNo

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

HTTP + XML

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

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

<ArrayOfPatientDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ips.ChiroTouch.DataService.Model.Core">
  <PatientDto>
    <Appointment>
      <Date>0001-01-01T00:00:00</Date>
      <Length>0</Length>
      <Purpose>String</Purpose>
    </Appointment>
    <CaseType>String</CaseType>
    <ContactInfo>
      <Email>String</Email>
      <Mobile>String</Mobile>
    </ContactInfo>
    <Demographics>
      <Birthdate>0001-01-01T00:00:00</Birthdate>
      <Sex>String</Sex>
    </Demographics>
    <FirstName>String</FirstName>
    <Id>0</Id>
    <LastName>String</LastName>
    <MiddleName>String</MiddleName>
    <Provider xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ips.ChiroTouch.DataService.Model">
      <d3p1:DisplayName>String</d3p1:DisplayName>
      <d3p1:Id>0</d3p1:Id>
    </Provider>
  </PatientDto>
</ArrayOfPatientDto>