IPrimeSuiteAPI REST API Documentation

ScheduleAppointmentStatusGet

Method: POST

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

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<AppointmentStatusGetRequest>
  <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>
  <Header>
    <SourceSiteID>String Content</SourceSiteID>
    <DestinationSiteID>String Content</DestinationSiteID>
    <PrimeSuiteUserID>0</PrimeSuiteUserID>
  </Header>
  <AppointmentId>0</AppointmentId>
</AppointmentStatusGetRequest>

Request Json Example (schema):

{
  "Credentials": {
    "PrimeSuiteCredential": {
      "PrimeSuiteSiteId": "String Content",
      "PrimeSuiteUserName": "String Content",
      "PrimeSuiteUserPassword": "String Content",
      "PrimeSuiteUserAlias": "String Content"
    },
    "VendorCredential": {
      "VendorLogin": "String Content",
      "VendorPassword": "String Content"
    }
  },
  "Header": {
    "SourceSiteID": "String Content",
    "DestinationSiteID": "String Content",
    "PrimeSuiteUserID": 0
  },
  "AppointmentId": 0
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<AppointmentStatusGetResponse>
  <AppointmentId>String Content</AppointmentId>
  <ChiefComplaint>String Content</ChiefComplaint>
  <Comments>String Content</Comments>
  <AppointmentDate>String Content</AppointmentDate>
  <StartTime>String Content</StartTime>
  <EndTime>String Content</EndTime>
  <Status>0</Status>
  <VisitId>String Content</VisitId>
  <VisitType>String Content</VisitType>
  <CareProviderID>0</CareProviderID>
  <ScheduleLocationID>0</ScheduleLocationID>
  <ScheduleLocation>String Content</ScheduleLocation>
</AppointmentStatusGetResponse>

Response Format: Json

Response Example (schema):

{
  "AppointmentId": "String Content",
  "ChiefComplaint": "String Content",
  "Comments": "String Content",
  "AppointmentDate": "String Content",
  "StartTime": "String Content",
  "EndTime": "String Content",
  "Status": 0,
  "VisitId": "String Content",
  "VisitType": "String Content",
  "CareProviderID": 0,
  "ScheduleLocationID": 0,
  "ScheduleLocation": "String Content"
}