POST api/Appointments/ReadAppointmentsFromExcel?filePath={filePath}&appointmentType={appointmentType}&appointmentTypeId={appointmentTypeId}&providerId={providerId}&roleCode={roleCode}

Request Information

URI Parameters

Name	Type	Additional information
filePath	string	Required
appointmentType	string	Required
appointmentTypeId	integer	Required
providerId	integer	Required
roleCode	string	Required

Body Parameters

None.

Response Information

Resource Description

ExcelAppointmentResult

Name	Type	Additional information
Appointments	Collection of PatientAppoitnmentDTO	None.
DuplicateMessages	Collection of string	None.
ValidationMessages	Collection of string	None.
AgeValidations	Collection of string	None.
FileName	string	None.

Response Formats

application/json, text/json

Sample:

{
  "appointments": [
    {
      "patientId": 1,
      "firstName": "sample string 2",
      "lastName": "sample string 3",
      "mrn": "sample string 4",
      "visitType": 1,
      "age": "sample string 5",
      "gender": "sample string 6",
      "reasonOfVisit": "sample string 7",
      "userId": "sample string 8",
      "providerId": 9,
      "appointmentStartDate": "2025-12-18T22:28:00.6418986+05:30",
      "appointmentEndDate": "2025-12-18T22:28:00.6418986+05:30",
      "dateOfService": "2025-12-18T22:28:00.6418986+05:30",
      "isCancelled": true,
      "isActive": true,
      "cancelReason": "sample string 13",
      "timezoneId": 14,
      "tzCode": "sample string 15",
      "timeZoneDescription": "sample string 16",
      "appointmentType": "sample string 17",
      "appointmentTypeId": 18,
      "zoomMeetingId": 19,
      "isStat": true,
      "statTime": 21,
      "isMRNUpdated": true,
      "providerEMRs": "sample string 23",
      "emrPatientId": "sample string 24",
      "preHistoryData": "sample string 25",
      "preChartSummary": "sample string 26",
      "referralRecommendations": "sample string 27",
      "visitSummary": "sample string 28",
      "isPreHistoryRefreshed": true,
      "emrMasterCode": "sample string 30",
      "providerEMRHistoryCode": "sample string 31",
      "isAppointmentEMREnabled": true,
      "providerReference": "sample string 33",
      "type": "sample string 34",
      "uploadAppointmentId": 1,
      "sectionTypeCode": "sample string 35"
    },
    {
      "patientId": 1,
      "firstName": "sample string 2",
      "lastName": "sample string 3",
      "mrn": "sample string 4",
      "visitType": 1,
      "age": "sample string 5",
      "gender": "sample string 6",
      "reasonOfVisit": "sample string 7",
      "userId": "sample string 8",
      "providerId": 9,
      "appointmentStartDate": "2025-12-18T22:28:00.6418986+05:30",
      "appointmentEndDate": "2025-12-18T22:28:00.6418986+05:30",
      "dateOfService": "2025-12-18T22:28:00.6418986+05:30",
      "isCancelled": true,
      "isActive": true,
      "cancelReason": "sample string 13",
      "timezoneId": 14,
      "tzCode": "sample string 15",
      "timeZoneDescription": "sample string 16",
      "appointmentType": "sample string 17",
      "appointmentTypeId": 18,
      "zoomMeetingId": 19,
      "isStat": true,
      "statTime": 21,
      "isMRNUpdated": true,
      "providerEMRs": "sample string 23",
      "emrPatientId": "sample string 24",
      "preHistoryData": "sample string 25",
      "preChartSummary": "sample string 26",
      "referralRecommendations": "sample string 27",
      "visitSummary": "sample string 28",
      "isPreHistoryRefreshed": true,
      "emrMasterCode": "sample string 30",
      "providerEMRHistoryCode": "sample string 31",
      "isAppointmentEMREnabled": true,
      "providerReference": "sample string 33",
      "type": "sample string 34",
      "uploadAppointmentId": 1,
      "sectionTypeCode": "sample string 35"
    }
  ],
  "duplicateMessages": [
    "sample string 1",
    "sample string 2"
  ],
  "validationMessages": [
    "sample string 1",
    "sample string 2"
  ],
  "ageValidations": [
    "sample string 1",
    "sample string 2"
  ],
  "fileName": "sample string 1"
}

application/xml, text/xml

Sample:

<ExcelAppointmentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScribingSoftware.Model.DTO">
  <AgeValidations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </AgeValidations>
  <Appointments>
    <PatientAppoitnmentDTO>
      <Age>sample string 5</Age>
      <AppointmentEndDate>2025-12-18T22:28:00.6418986+05:30</AppointmentEndDate>
      <AppointmentStartDate>2025-12-18T22:28:00.6418986+05:30</AppointmentStartDate>
      <AppointmentType>sample string 17</AppointmentType>
      <AppointmentTypeId>18</AppointmentTypeId>
      <CancelReason>sample string 13</CancelReason>
      <DateOfService>2025-12-18T22:28:00.6418986+05:30</DateOfService>
      <EMRMasterCode>sample string 30</EMRMasterCode>
      <EMRPatientId>sample string 24</EMRPatientId>
      <FirstName>sample string 2</FirstName>
      <Gender>sample string 6</Gender>
      <IsActive>true</IsActive>
      <IsAppointmentEMREnabled>true</IsAppointmentEMREnabled>
      <IsCancelled>true</IsCancelled>
      <IsMRNUpdated>true</IsMRNUpdated>
      <IsPreHistoryRefreshed>true</IsPreHistoryRefreshed>
      <IsStat>true</IsStat>
      <LastName>sample string 3</LastName>
      <MRN>sample string 4</MRN>
      <PatientId>1</PatientId>
      <PreChartSummary>sample string 26</PreChartSummary>
      <PreHistoryData>sample string 25</PreHistoryData>
      <ProviderEMRHistoryCode>sample string 31</ProviderEMRHistoryCode>
      <ProviderEMRs>sample string 23</ProviderEMRs>
      <ProviderId>9</ProviderId>
      <ProviderReference>sample string 33</ProviderReference>
      <ReasonOfVisit>sample string 7</ReasonOfVisit>
      <ReferralRecommendations>sample string 27</ReferralRecommendations>
      <SectionTypeCode>sample string 35</SectionTypeCode>
      <StatTime>21</StatTime>
      <TZCode>sample string 15</TZCode>
      <TimeZoneDescription>sample string 16</TimeZoneDescription>
      <TimezoneId>14</TimezoneId>
      <Type>sample string 34</Type>
      <UploadAppointmentId>1</UploadAppointmentId>
      <UserId>sample string 8</UserId>
      <VisitSummary>sample string 28</VisitSummary>
      <VisitType>1</VisitType>
      <ZoomMeetingId>19</ZoomMeetingId>
    </PatientAppoitnmentDTO>
    <PatientAppoitnmentDTO>
      <Age>sample string 5</Age>
      <AppointmentEndDate>2025-12-18T22:28:00.6418986+05:30</AppointmentEndDate>
      <AppointmentStartDate>2025-12-18T22:28:00.6418986+05:30</AppointmentStartDate>
      <AppointmentType>sample string 17</AppointmentType>
      <AppointmentTypeId>18</AppointmentTypeId>
      <CancelReason>sample string 13</CancelReason>
      <DateOfService>2025-12-18T22:28:00.6418986+05:30</DateOfService>
      <EMRMasterCode>sample string 30</EMRMasterCode>
      <EMRPatientId>sample string 24</EMRPatientId>
      <FirstName>sample string 2</FirstName>
      <Gender>sample string 6</Gender>
      <IsActive>true</IsActive>
      <IsAppointmentEMREnabled>true</IsAppointmentEMREnabled>
      <IsCancelled>true</IsCancelled>
      <IsMRNUpdated>true</IsMRNUpdated>
      <IsPreHistoryRefreshed>true</IsPreHistoryRefreshed>
      <IsStat>true</IsStat>
      <LastName>sample string 3</LastName>
      <MRN>sample string 4</MRN>
      <PatientId>1</PatientId>
      <PreChartSummary>sample string 26</PreChartSummary>
      <PreHistoryData>sample string 25</PreHistoryData>
      <ProviderEMRHistoryCode>sample string 31</ProviderEMRHistoryCode>
      <ProviderEMRs>sample string 23</ProviderEMRs>
      <ProviderId>9</ProviderId>
      <ProviderReference>sample string 33</ProviderReference>
      <ReasonOfVisit>sample string 7</ReasonOfVisit>
      <ReferralRecommendations>sample string 27</ReferralRecommendations>
      <SectionTypeCode>sample string 35</SectionTypeCode>
      <StatTime>21</StatTime>
      <TZCode>sample string 15</TZCode>
      <TimeZoneDescription>sample string 16</TimeZoneDescription>
      <TimezoneId>14</TimezoneId>
      <Type>sample string 34</Type>
      <UploadAppointmentId>1</UploadAppointmentId>
      <UserId>sample string 8</UserId>
      <VisitSummary>sample string 28</VisitSummary>
      <VisitType>1</VisitType>
      <ZoomMeetingId>19</ZoomMeetingId>
    </PatientAppoitnmentDTO>
  </Appointments>
  <DuplicateMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </DuplicateMessages>
  <FileName>sample string 1</FileName>
  <ValidationMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ValidationMessages>
</ExcelAppointmentResult>