IPrimeSuiteAPI REST API Documentation

RecallsListGetByDetails

Method: POST

URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/RecallsListGetByDetails

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<RecallsListGetByDetailsRequest>
  <Header>
    <SourceSiteID>String Content</SourceSiteID>
    <DestinationSiteID>String Content</DestinationSiteID>
    <PrimeSuiteUserID>0</PrimeSuiteUserID>
  </Header>
  <Credentials>
    <PrimeSuiteCredential>
      <PrimeSuiteSiteId>String Content</PrimeSuiteSiteId>
      <PrimeSuiteUserName>String Content</PrimeSuiteUserName>
      <PrimeSuiteUserPassword>String Content</PrimeSuiteUserPassword>
      <PrimeSuiteUserAlias>String Content</PrimeSuiteUserAlias>
    </PrimeSuiteCredential>
    <VendorCredential>
      <VendorLogin>String Content</VendorLogin>
      <VendorPassword>String Content</VendorPassword>
    </VendorCredential>
  </Credentials>
  <PageSize>0</PageSize>
  <PageStart>0</PageStart>
  <FromDate>0001-01-01T00:00:00</FromDate>
  <ToDate>0001-01-01T00:00:00</ToDate>
  <CriteriaSearch>
    <ResourceIDs>0</ResourceIDs>
    <LocationIDs>0</LocationIDs>
    <StatusIDs>0</StatusIDs>
    <AppointmentTypeIDs>0</AppointmentTypeIDs>
    <CommunicationIDs>0</CommunicationIDs>
  </CriteriaSearch>
</RecallsListGetByDetailsRequest>

Request Json Example (schema):

Could not generate example for request. Failed with error: Specified cast is not valid.

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<RecallsListGetResponse>
  <Recalls>
    <Communication>0</Communication>
    <RecallID>0</RecallID>
    <PatientID>0</PatientID>
    <PatientName>String Content</PatientName>
    <RequestDate>0001-01-01T00:00:00</RequestDate>
    <CareProviders>String Content</CareProviders>
    <AppointmentType>
      <Abbr>String Content</Abbr>
      <AppointmentTypeID>0</AppointmentTypeID>
      <Duration>0</Duration>
      <Name>String Content</Name>
      <PatientInstructions>String Content</PatientInstructions>
    </AppointmentType>
    <RecallStatus>0</RecallStatus>
    <Location>
      <LocationID>0</LocationID>
      <Description>String Content</Description>
      <Name>String Content</Name>
      <bCanView>false</bCanView>
      <bCanSchedule>false</bCanSchedule>
      <Address>
        <AddressLine1>String Content</AddressLine1>
        <AddressLine2>String Content</AddressLine2>
        <City>String Content</City>
        <County>String Content</County>
        <State>String Content</State>
        <Country>String Content</Country>
        <PostalCode>String Content</PostalCode>
        <PhoneNumber1>String Content</PhoneNumber1>
        <PhoneNumber2>String Content</PhoneNumber2>
        <FaxNumber>String Content</FaxNumber>
      </Address>
    </Location>
  </Recalls>
  <TotalRows>0</TotalRows>
</RecallsListGetResponse>

Response Format: Json

Response Example (schema):

Could not generate example for response. Failed with error: Specified cast is not valid.