GET api/CheckIn

Returns information used in an appointment check in process.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

CheckInInformationModel

Name	Description	Type	Additional information
PreviousAppointment	Information about the previous appointment.	AppointmentModel	None.
CurrentAppointment	Information about the current appointment.	AppointmentModel	None.
NextAppointment	Information about the next appointment.	AppointmentModel	None.

Response Formats

application/json, text/json

Sample:

{
  "PreviousAppointment": {
    "Id": "d61813f7-3c47-4879-b5c6-3c21212096f1",
    "ItemType": "sample string 2",
    "ExternalId": "sample string 3",
    "LocationId": "871ef80c-9ccf-4e94-94de-f1d03ca86a0e",
    "LocationName": "sample string 5",
    "LocationPhoneNumber": "sample string 6",
    "LocationEmailAddress": "sample string 7",
    "LocationPostalAddress": {
      "Id": "adf5c315-d7f6-45c5-8e26-e11db304fcab",
      "Alias": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "CountryId": "59067ac0-ffa5-407b-9193-37f54f940f9c",
      "CountryCode": "sample string 7",
      "CountryName": "sample string 8",
      "Zip": "sample string 9",
      "Default": true,
      "Latitude": 1.0,
      "Longitude": 1.0
    },
    "DoctorId": "060b5011-f7dd-41f2-bc1a-cc7f78e985ab",
    "DoctorFirstName": "sample string 9",
    "DoctorLastName": "sample string 10",
    "DoctorFullName": "sample string 11",
    "Status": "sample string 12",
    "Start": "sample string 13",
    "End": "sample string 14",
    "SelectedDateRange": "sample string 15",
    "PreferredDays": "sample string 16",
    "SelectedPreferredTime": "sample string 17",
    "RequestType": "sample string 18"
  },
  "CurrentAppointment": {
    "Id": "d61813f7-3c47-4879-b5c6-3c21212096f1",
    "ItemType": "sample string 2",
    "ExternalId": "sample string 3",
    "LocationId": "871ef80c-9ccf-4e94-94de-f1d03ca86a0e",
    "LocationName": "sample string 5",
    "LocationPhoneNumber": "sample string 6",
    "LocationEmailAddress": "sample string 7",
    "LocationPostalAddress": {
      "Id": "adf5c315-d7f6-45c5-8e26-e11db304fcab",
      "Alias": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "CountryId": "59067ac0-ffa5-407b-9193-37f54f940f9c",
      "CountryCode": "sample string 7",
      "CountryName": "sample string 8",
      "Zip": "sample string 9",
      "Default": true,
      "Latitude": 1.0,
      "Longitude": 1.0
    },
    "DoctorId": "060b5011-f7dd-41f2-bc1a-cc7f78e985ab",
    "DoctorFirstName": "sample string 9",
    "DoctorLastName": "sample string 10",
    "DoctorFullName": "sample string 11",
    "Status": "sample string 12",
    "Start": "sample string 13",
    "End": "sample string 14",
    "SelectedDateRange": "sample string 15",
    "PreferredDays": "sample string 16",
    "SelectedPreferredTime": "sample string 17",
    "RequestType": "sample string 18"
  },
  "NextAppointment": {
    "Id": "d61813f7-3c47-4879-b5c6-3c21212096f1",
    "ItemType": "sample string 2",
    "ExternalId": "sample string 3",
    "LocationId": "871ef80c-9ccf-4e94-94de-f1d03ca86a0e",
    "LocationName": "sample string 5",
    "LocationPhoneNumber": "sample string 6",
    "LocationEmailAddress": "sample string 7",
    "LocationPostalAddress": {
      "Id": "adf5c315-d7f6-45c5-8e26-e11db304fcab",
      "Alias": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "CountryId": "59067ac0-ffa5-407b-9193-37f54f940f9c",
      "CountryCode": "sample string 7",
      "CountryName": "sample string 8",
      "Zip": "sample string 9",
      "Default": true,
      "Latitude": 1.0,
      "Longitude": 1.0
    },
    "DoctorId": "060b5011-f7dd-41f2-bc1a-cc7f78e985ab",
    "DoctorFirstName": "sample string 9",
    "DoctorLastName": "sample string 10",
    "DoctorFullName": "sample string 11",
    "Status": "sample string 12",
    "Start": "sample string 13",
    "End": "sample string 14",
    "SelectedDateRange": "sample string 15",
    "PreferredDays": "sample string 16",
    "SelectedPreferredTime": "sample string 17",
    "RequestType": "sample string 18"
  }
}

application/xml, text/xml

Sample:

<CheckInInformationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.Appointments">
  <CurrentAppointment>
    <DoctorFirstName>sample string 9</DoctorFirstName>
    <DoctorFullName>sample string 11</DoctorFullName>
    <DoctorId>060b5011-f7dd-41f2-bc1a-cc7f78e985ab</DoctorId>
    <DoctorLastName>sample string 10</DoctorLastName>
    <End>sample string 14</End>
    <ExternalId>sample string 3</ExternalId>
    <Id>d61813f7-3c47-4879-b5c6-3c21212096f1</Id>
    <ItemType>sample string 2</ItemType>
    <LocationEmailAddress>sample string 7</LocationEmailAddress>
    <LocationId>871ef80c-9ccf-4e94-94de-f1d03ca86a0e</LocationId>
    <LocationName>sample string 5</LocationName>
    <LocationPhoneNumber>sample string 6</LocationPhoneNumber>
    <LocationPostalAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.Contacts">
      <d3p1:Address1>sample string 3</d3p1:Address1>
      <d3p1:Address2>sample string 4</d3p1:Address2>
      <d3p1:Alias>sample string 2</d3p1:Alias>
      <d3p1:City>sample string 5</d3p1:City>
      <d3p1:CountryCode>sample string 7</d3p1:CountryCode>
      <d3p1:CountryId>59067ac0-ffa5-407b-9193-37f54f940f9c</d3p1:CountryId>
      <d3p1:CountryName>sample string 8</d3p1:CountryName>
      <d3p1:Default>true</d3p1:Default>
      <d3p1:Id>adf5c315-d7f6-45c5-8e26-e11db304fcab</d3p1:Id>
      <d3p1:Latitude>1</d3p1:Latitude>
      <d3p1:Longitude>1</d3p1:Longitude>
      <d3p1:State>sample string 6</d3p1:State>
      <d3p1:Zip>sample string 9</d3p1:Zip>
    </LocationPostalAddress>
    <PreferredDays>sample string 16</PreferredDays>
    <RequestType>sample string 18</RequestType>
    <SelectedDateRange>sample string 15</SelectedDateRange>
    <SelectedPreferredTime>sample string 17</SelectedPreferredTime>
    <Start>sample string 13</Start>
    <Status>sample string 12</Status>
  </CurrentAppointment>
  <NextAppointment>
    <DoctorFirstName>sample string 9</DoctorFirstName>
    <DoctorFullName>sample string 11</DoctorFullName>
    <DoctorId>060b5011-f7dd-41f2-bc1a-cc7f78e985ab</DoctorId>
    <DoctorLastName>sample string 10</DoctorLastName>
    <End>sample string 14</End>
    <ExternalId>sample string 3</ExternalId>
    <Id>d61813f7-3c47-4879-b5c6-3c21212096f1</Id>
    <ItemType>sample string 2</ItemType>
    <LocationEmailAddress>sample string 7</LocationEmailAddress>
    <LocationId>871ef80c-9ccf-4e94-94de-f1d03ca86a0e</LocationId>
    <LocationName>sample string 5</LocationName>
    <LocationPhoneNumber>sample string 6</LocationPhoneNumber>
    <LocationPostalAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.Contacts">
      <d3p1:Address1>sample string 3</d3p1:Address1>
      <d3p1:Address2>sample string 4</d3p1:Address2>
      <d3p1:Alias>sample string 2</d3p1:Alias>
      <d3p1:City>sample string 5</d3p1:City>
      <d3p1:CountryCode>sample string 7</d3p1:CountryCode>
      <d3p1:CountryId>59067ac0-ffa5-407b-9193-37f54f940f9c</d3p1:CountryId>
      <d3p1:CountryName>sample string 8</d3p1:CountryName>
      <d3p1:Default>true</d3p1:Default>
      <d3p1:Id>adf5c315-d7f6-45c5-8e26-e11db304fcab</d3p1:Id>
      <d3p1:Latitude>1</d3p1:Latitude>
      <d3p1:Longitude>1</d3p1:Longitude>
      <d3p1:State>sample string 6</d3p1:State>
      <d3p1:Zip>sample string 9</d3p1:Zip>
    </LocationPostalAddress>
    <PreferredDays>sample string 16</PreferredDays>
    <RequestType>sample string 18</RequestType>
    <SelectedDateRange>sample string 15</SelectedDateRange>
    <SelectedPreferredTime>sample string 17</SelectedPreferredTime>
    <Start>sample string 13</Start>
    <Status>sample string 12</Status>
  </NextAppointment>
  <PreviousAppointment>
    <DoctorFirstName>sample string 9</DoctorFirstName>
    <DoctorFullName>sample string 11</DoctorFullName>
    <DoctorId>060b5011-f7dd-41f2-bc1a-cc7f78e985ab</DoctorId>
    <DoctorLastName>sample string 10</DoctorLastName>
    <End>sample string 14</End>
    <ExternalId>sample string 3</ExternalId>
    <Id>d61813f7-3c47-4879-b5c6-3c21212096f1</Id>
    <ItemType>sample string 2</ItemType>
    <LocationEmailAddress>sample string 7</LocationEmailAddress>
    <LocationId>871ef80c-9ccf-4e94-94de-f1d03ca86a0e</LocationId>
    <LocationName>sample string 5</LocationName>
    <LocationPhoneNumber>sample string 6</LocationPhoneNumber>
    <LocationPostalAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.Contacts">
      <d3p1:Address1>sample string 3</d3p1:Address1>
      <d3p1:Address2>sample string 4</d3p1:Address2>
      <d3p1:Alias>sample string 2</d3p1:Alias>
      <d3p1:City>sample string 5</d3p1:City>
      <d3p1:CountryCode>sample string 7</d3p1:CountryCode>
      <d3p1:CountryId>59067ac0-ffa5-407b-9193-37f54f940f9c</d3p1:CountryId>
      <d3p1:CountryName>sample string 8</d3p1:CountryName>
      <d3p1:Default>true</d3p1:Default>
      <d3p1:Id>adf5c315-d7f6-45c5-8e26-e11db304fcab</d3p1:Id>
      <d3p1:Latitude>1</d3p1:Latitude>
      <d3p1:Longitude>1</d3p1:Longitude>
      <d3p1:State>sample string 6</d3p1:State>
      <d3p1:Zip>sample string 9</d3p1:Zip>
    </LocationPostalAddress>
    <PreferredDays>sample string 16</PreferredDays>
    <RequestType>sample string 18</RequestType>
    <SelectedDateRange>sample string 15</SelectedDateRange>
    <SelectedPreferredTime>sample string 17</SelectedPreferredTime>
    <Start>sample string 13</Start>
    <Status>sample string 12</Status>
  </PreviousAppointment>
</CheckInInformationModel>