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
NameDescriptionTypeAdditional 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": "83de4e3b-c75b-4a8e-99e2-80649c366cc1",
    "ItemType": "sample string 2",
    "ExternalId": "sample string 3",
    "LocationId": "ffb4b777-d30b-4bf8-9c22-32e2d3b718be",
    "LocationName": "sample string 5",
    "LocationPhoneNumber": "sample string 6",
    "LocationEmailAddress": "sample string 7",
    "LocationPostalAddress": {
      "Id": "3832d8bf-b14f-4c67-a424-d62b53cf2873",
      "Alias": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "CountryId": "1a653296-08e2-4901-923c-6ac19caaf8c1",
      "CountryCode": "sample string 7",
      "CountryName": "sample string 8",
      "Zip": "sample string 9",
      "Default": true,
      "Latitude": 1.0,
      "Longitude": 1.0
    },
    "DoctorId": "537e2b5b-9422-4ebf-9a79-dcd9ed44befa",
    "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": "83de4e3b-c75b-4a8e-99e2-80649c366cc1",
    "ItemType": "sample string 2",
    "ExternalId": "sample string 3",
    "LocationId": "ffb4b777-d30b-4bf8-9c22-32e2d3b718be",
    "LocationName": "sample string 5",
    "LocationPhoneNumber": "sample string 6",
    "LocationEmailAddress": "sample string 7",
    "LocationPostalAddress": {
      "Id": "3832d8bf-b14f-4c67-a424-d62b53cf2873",
      "Alias": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "CountryId": "1a653296-08e2-4901-923c-6ac19caaf8c1",
      "CountryCode": "sample string 7",
      "CountryName": "sample string 8",
      "Zip": "sample string 9",
      "Default": true,
      "Latitude": 1.0,
      "Longitude": 1.0
    },
    "DoctorId": "537e2b5b-9422-4ebf-9a79-dcd9ed44befa",
    "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": "83de4e3b-c75b-4a8e-99e2-80649c366cc1",
    "ItemType": "sample string 2",
    "ExternalId": "sample string 3",
    "LocationId": "ffb4b777-d30b-4bf8-9c22-32e2d3b718be",
    "LocationName": "sample string 5",
    "LocationPhoneNumber": "sample string 6",
    "LocationEmailAddress": "sample string 7",
    "LocationPostalAddress": {
      "Id": "3832d8bf-b14f-4c67-a424-d62b53cf2873",
      "Alias": "sample string 2",
      "Address1": "sample string 3",
      "Address2": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "CountryId": "1a653296-08e2-4901-923c-6ac19caaf8c1",
      "CountryCode": "sample string 7",
      "CountryName": "sample string 8",
      "Zip": "sample string 9",
      "Default": true,
      "Latitude": 1.0,
      "Longitude": 1.0
    },
    "DoctorId": "537e2b5b-9422-4ebf-9a79-dcd9ed44befa",
    "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>537e2b5b-9422-4ebf-9a79-dcd9ed44befa</DoctorId>
    <DoctorLastName>sample string 10</DoctorLastName>
    <End>sample string 14</End>
    <ExternalId>sample string 3</ExternalId>
    <Id>83de4e3b-c75b-4a8e-99e2-80649c366cc1</Id>
    <ItemType>sample string 2</ItemType>
    <LocationEmailAddress>sample string 7</LocationEmailAddress>
    <LocationId>ffb4b777-d30b-4bf8-9c22-32e2d3b718be</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>1a653296-08e2-4901-923c-6ac19caaf8c1</d3p1:CountryId>
      <d3p1:CountryName>sample string 8</d3p1:CountryName>
      <d3p1:Default>true</d3p1:Default>
      <d3p1:Id>3832d8bf-b14f-4c67-a424-d62b53cf2873</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>537e2b5b-9422-4ebf-9a79-dcd9ed44befa</DoctorId>
    <DoctorLastName>sample string 10</DoctorLastName>
    <End>sample string 14</End>
    <ExternalId>sample string 3</ExternalId>
    <Id>83de4e3b-c75b-4a8e-99e2-80649c366cc1</Id>
    <ItemType>sample string 2</ItemType>
    <LocationEmailAddress>sample string 7</LocationEmailAddress>
    <LocationId>ffb4b777-d30b-4bf8-9c22-32e2d3b718be</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>1a653296-08e2-4901-923c-6ac19caaf8c1</d3p1:CountryId>
      <d3p1:CountryName>sample string 8</d3p1:CountryName>
      <d3p1:Default>true</d3p1:Default>
      <d3p1:Id>3832d8bf-b14f-4c67-a424-d62b53cf2873</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>537e2b5b-9422-4ebf-9a79-dcd9ed44befa</DoctorId>
    <DoctorLastName>sample string 10</DoctorLastName>
    <End>sample string 14</End>
    <ExternalId>sample string 3</ExternalId>
    <Id>83de4e3b-c75b-4a8e-99e2-80649c366cc1</Id>
    <ItemType>sample string 2</ItemType>
    <LocationEmailAddress>sample string 7</LocationEmailAddress>
    <LocationId>ffb4b777-d30b-4bf8-9c22-32e2d3b718be</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>1a653296-08e2-4901-923c-6ac19caaf8c1</d3p1:CountryId>
      <d3p1:CountryName>sample string 8</d3p1:CountryName>
      <d3p1:Default>true</d3p1:Default>
      <d3p1:Id>3832d8bf-b14f-4c67-a424-d62b53cf2873</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>