GET Schedule/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Schedule| Name | Description | Type | Additional information |
|---|---|---|---|
| ScheduleID | integer |
None. |
|
| ShiftCodeID | integer |
None. |
|
| Shift | integer |
None. |
|
| StartTime | date |
None. |
|
| StopTime | date |
None. |
|
| PostedStartTime | date |
None. |
|
| PostedStopTime | date |
None. |
|
| ClientID | integer |
None. |
|
| ServiceAreaID | integer |
None. |
|
| Location | string |
None. |
|
| CategoryID | integer |
None. |
|
| PayerID | integer |
None. |
|
| RegionID | integer |
None. |
|
| OrderID | integer |
None. |
|
| OrderTypeID | integer |
None. |
|
| AvailabilityID | integer |
None. |
|
| ContractAgency | integer |
None. |
|
| Orientation | integer |
None. |
|
| PayRate | decimal number |
None. |
|
| BillRate | decimal number |
None. |
|
| EmployeeID | integer |
None. |
|
| EmployeeConfirmed | boolean |
None. |
|
| ClientConfirmed | boolean |
None. |
|
| Posted | boolean |
None. |
|
| ClientApproved | boolean |
None. |
|
| ApproveContact | string |
None. |
|
| AgencyApprovedPay | boolean |
None. |
|
| AgencyApprovedBill | boolean |
None. |
|
| Invoiced | boolean |
None. |
|
| Paid | boolean |
None. |
|
| InstantAdvanceApproved | boolean |
None. |
|
| InstantAdvanceApplied | decimal number |
None. |
|
| AddedBy | string |
None. |
|
| AddedDate | date |
None. |
|
| LastModifiedBy | string |
None. |
|
| LastModifiedDate | date |
None. |
|
| AssignedBy | string |
None. |
|
| AssignedDate | date |
None. |
|
| ClientConfirmedBy | string |
None. |
|
| ClientConfirmedDate | date |
None. |
|
| EmployeeConfirmedBy | string |
None. |
|
| EmployeeConfirmedDate | date |
None. |
|
| ApprovedPayBy | string |
None. |
|
| ApprovedPayDate | date |
None. |
|
| ApprovedBillBy | string |
None. |
|
| ApprovedBillDate | date |
None. |
|
| PaidBy | string |
None. |
|
| PaidDate | date |
None. |
|
| InvoicedBy | string |
None. |
|
| InvoicedDate | date |
None. |
|
| ExportedPayBy | string |
None. |
|
| ExportedPayDate | date |
None. |
|
| ExportedBillBy | string |
None. |
|
| ExportedBillDate | date |
None. |
|
| BillingMemo | string |
None. |
|
| PayWeekEnding | date |
None. |
|
| PayCheckNumber | string |
None. |
|
| BillPeriodEnding | date |
None. |
|
| BillInvoiceNumber | integer |
None. |
|
| DeletedBySystem | integer |
None. |
|
| OverridePayBill | integer |
None. |
|
| Comment | string |
None. |
|
| LunchAdjust | integer |
None. |
|
| ClientConfirmContact | string |
None. |
|
| ClientApprovedDate | date |
None. |
|
| InstantAdvanceApprovedBy | string |
None. |
|
| InstantAdvanceApprovedDate | date |
None. |
|
| InstantAdvanceBy | string |
None. |
|
| InstantAdvanceDate | date |
None. |
|
| ExportedAPBy | string |
None. |
|
| ExportedAPDate | date |
None. |
|
| Charge | integer |
None. |
|
| OnCall | integer |
None. |
|
| TimeAndTrouble | integer |
None. |
|
| ContractID | integer |
None. |
|
| TimeClockPostedStart | date |
None. |
|
| TimeClockPostedStop | date |
None. |
|
| TimeClockPostedLunch | date |
None. |
|
| SubClientID | integer |
None. |
|
| GenStarStatus | integer |
None. |
|
| UsesReimbursementRates | integer |
None. |
|
| CareAuthID | integer |
None. |
|
| CopiedFrom | integer |
None. |
|
| BillMinutes | integer |
None. |
|
| Bill15MinuteIncrements | integer |
None. |
|
| NonBillMinutes | integer |
None. |
|
| UserImageId | integer |
None. |
|
| RejectionReasonId | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"ScheduleID": 1,
"ShiftCodeID": 1,
"Shift": 1,
"StartTime": "2026-09-04T01:10:34.8893079-04:00",
"StopTime": "2026-09-04T01:10:34.8893079-04:00",
"PostedStartTime": "2026-09-04T01:10:34.8893079-04:00",
"PostedStopTime": "2026-09-04T01:10:34.8893079-04:00",
"ClientID": 1,
"ServiceAreaID": 1,
"Location": "sample string 2",
"CategoryID": 1,
"PayerID": 1,
"RegionID": 1,
"OrderID": 1,
"OrderTypeID": 1,
"AvailabilityID": 1,
"ContractAgency": 1,
"Orientation": 1,
"PayRate": 1.0,
"BillRate": 1.0,
"EmployeeID": 1,
"EmployeeConfirmed": true,
"ClientConfirmed": true,
"Posted": true,
"ClientApproved": true,
"ApproveContact": "sample string 7",
"AgencyApprovedPay": true,
"AgencyApprovedBill": true,
"Invoiced": true,
"Paid": true,
"InstantAdvanceApproved": true,
"InstantAdvanceApplied": 13.0,
"AddedBy": "sample string 14",
"AddedDate": "2026-09-04T01:10:34.8893079-04:00",
"LastModifiedBy": "sample string 15",
"LastModifiedDate": "2026-09-04T01:10:34.8893079-04:00",
"AssignedBy": "sample string 16",
"AssignedDate": "2026-09-04T01:10:34.8893079-04:00",
"ClientConfirmedBy": "sample string 17",
"ClientConfirmedDate": "2026-09-04T01:10:34.8893079-04:00",
"EmployeeConfirmedBy": "sample string 18",
"EmployeeConfirmedDate": "2026-09-04T01:10:34.8893079-04:00",
"ApprovedPayBy": "sample string 19",
"ApprovedPayDate": "2026-09-04T01:10:34.8893079-04:00",
"ApprovedBillBy": "sample string 20",
"ApprovedBillDate": "2026-09-04T01:10:34.8893079-04:00",
"PaidBy": "sample string 21",
"PaidDate": "2026-09-04T01:10:34.8893079-04:00",
"InvoicedBy": "sample string 22",
"InvoicedDate": "2026-09-04T01:10:34.8893079-04:00",
"ExportedPayBy": "sample string 23",
"ExportedPayDate": "2026-09-04T01:10:34.8893079-04:00",
"ExportedBillBy": "sample string 24",
"ExportedBillDate": "2026-09-04T01:10:34.8893079-04:00",
"BillingMemo": "sample string 25",
"PayWeekEnding": "2026-09-04T01:10:34.8893079-04:00",
"PayCheckNumber": "sample string 26",
"BillPeriodEnding": "2026-09-04T01:10:34.8893079-04:00",
"BillInvoiceNumber": 1,
"DeletedBySystem": 1,
"OverridePayBill": 1,
"Comment": "sample string 27",
"LunchAdjust": 1,
"ClientConfirmContact": "sample string 28",
"ClientApprovedDate": "2026-09-04T01:10:34.8893079-04:00",
"InstantAdvanceApprovedBy": "sample string 29",
"InstantAdvanceApprovedDate": "2026-09-04T01:10:34.8893079-04:00",
"InstantAdvanceBy": "sample string 30",
"InstantAdvanceDate": "2026-09-04T01:10:34.8893079-04:00",
"ExportedAPBy": "sample string 31",
"ExportedAPDate": "2026-09-04T01:10:34.8893079-04:00",
"Charge": 1,
"OnCall": 1,
"TimeAndTrouble": 1,
"ContractID": 1,
"TimeClockPostedStart": "2026-09-04T01:10:34.8893079-04:00",
"TimeClockPostedStop": "2026-09-04T01:10:34.8893079-04:00",
"TimeClockPostedLunch": "2026-09-04T01:10:34.8893079-04:00",
"SubClientID": 1,
"GenStarStatus": 1,
"UsesReimbursementRates": 1,
"CareAuthID": 1,
"CopiedFrom": 1,
"BillMinutes": 1,
"Bill15MinuteIncrements": 1,
"NonBillMinutes": 1,
"UserImageId": 1,
"RejectionReasonId": 1
}
application/xml, text/xml
Sample:
<Schedule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models"> <AddedBy>sample string 14</AddedBy> <AddedDate>2026-09-04T01:10:34.8893079-04:00</AddedDate> <AgencyApprovedBill>true</AgencyApprovedBill> <AgencyApprovedPay>true</AgencyApprovedPay> <ApproveContact>sample string 7</ApproveContact> <ApprovedBillBy>sample string 20</ApprovedBillBy> <ApprovedBillDate>2026-09-04T01:10:34.8893079-04:00</ApprovedBillDate> <ApprovedPayBy>sample string 19</ApprovedPayBy> <ApprovedPayDate>2026-09-04T01:10:34.8893079-04:00</ApprovedPayDate> <AssignedBy>sample string 16</AssignedBy> <AssignedDate>2026-09-04T01:10:34.8893079-04:00</AssignedDate> <AvailabilityID>1</AvailabilityID> <Bill15MinuteIncrements>1</Bill15MinuteIncrements> <BillInvoiceNumber>1</BillInvoiceNumber> <BillMinutes>1</BillMinutes> <BillPeriodEnding>2026-09-04T01:10:34.8893079-04:00</BillPeriodEnding> <BillRate>1</BillRate> <BillingMemo>sample string 25</BillingMemo> <CareAuthID>1</CareAuthID> <CategoryID>1</CategoryID> <Charge>1</Charge> <ClientApproved>true</ClientApproved> <ClientApprovedDate>2026-09-04T01:10:34.8893079-04:00</ClientApprovedDate> <ClientConfirmContact>sample string 28</ClientConfirmContact> <ClientConfirmed>true</ClientConfirmed> <ClientConfirmedBy>sample string 17</ClientConfirmedBy> <ClientConfirmedDate>2026-09-04T01:10:34.8893079-04:00</ClientConfirmedDate> <ClientID>1</ClientID> <Comment>sample string 27</Comment> <ContractAgency>1</ContractAgency> <ContractID>1</ContractID> <CopiedFrom>1</CopiedFrom> <DeletedBySystem>1</DeletedBySystem> <EmployeeConfirmed>true</EmployeeConfirmed> <EmployeeConfirmedBy>sample string 18</EmployeeConfirmedBy> <EmployeeConfirmedDate>2026-09-04T01:10:34.8893079-04:00</EmployeeConfirmedDate> <EmployeeID>1</EmployeeID> <ExportedAPBy>sample string 31</ExportedAPBy> <ExportedAPDate>2026-09-04T01:10:34.8893079-04:00</ExportedAPDate> <ExportedBillBy>sample string 24</ExportedBillBy> <ExportedBillDate>2026-09-04T01:10:34.8893079-04:00</ExportedBillDate> <ExportedPayBy>sample string 23</ExportedPayBy> <ExportedPayDate>2026-09-04T01:10:34.8893079-04:00</ExportedPayDate> <GenStarStatus>1</GenStarStatus> <InstantAdvanceApplied>13</InstantAdvanceApplied> <InstantAdvanceApproved>true</InstantAdvanceApproved> <InstantAdvanceApprovedBy>sample string 29</InstantAdvanceApprovedBy> <InstantAdvanceApprovedDate>2026-09-04T01:10:34.8893079-04:00</InstantAdvanceApprovedDate> <InstantAdvanceBy>sample string 30</InstantAdvanceBy> <InstantAdvanceDate>2026-09-04T01:10:34.8893079-04:00</InstantAdvanceDate> <Invoiced>true</Invoiced> <InvoicedBy>sample string 22</InvoicedBy> <InvoicedDate>2026-09-04T01:10:34.8893079-04:00</InvoicedDate> <LastModifiedBy>sample string 15</LastModifiedBy> <LastModifiedDate>2026-09-04T01:10:34.8893079-04:00</LastModifiedDate> <Location>sample string 2</Location> <LunchAdjust>1</LunchAdjust> <NonBillMinutes>1</NonBillMinutes> <OnCall>1</OnCall> <OrderID>1</OrderID> <OrderTypeID>1</OrderTypeID> <Orientation>1</Orientation> <OverridePayBill>1</OverridePayBill> <Paid>true</Paid> <PaidBy>sample string 21</PaidBy> <PaidDate>2026-09-04T01:10:34.8893079-04:00</PaidDate> <PayCheckNumber>sample string 26</PayCheckNumber> <PayRate>1</PayRate> <PayWeekEnding>2026-09-04T01:10:34.8893079-04:00</PayWeekEnding> <PayerID>1</PayerID> <Posted>true</Posted> <PostedStartTime>2026-09-04T01:10:34.8893079-04:00</PostedStartTime> <PostedStopTime>2026-09-04T01:10:34.8893079-04:00</PostedStopTime> <RegionID>1</RegionID> <RejectionReasonId>1</RejectionReasonId> <ScheduleID>1</ScheduleID> <ServiceAreaID>1</ServiceAreaID> <Shift>1</Shift> <ShiftCodeID>1</ShiftCodeID> <StartTime>2026-09-04T01:10:34.8893079-04:00</StartTime> <StopTime>2026-09-04T01:10:34.8893079-04:00</StopTime> <SubClientID>1</SubClientID> <TimeAndTrouble>1</TimeAndTrouble> <TimeClockPostedLunch>2026-09-04T01:10:34.8893079-04:00</TimeClockPostedLunch> <TimeClockPostedStart>2026-09-04T01:10:34.8893079-04:00</TimeClockPostedStart> <TimeClockPostedStop>2026-09-04T01:10:34.8893079-04:00</TimeClockPostedStop> <UserImageId>1</UserImageId> <UsesReimbursementRates>1</UsesReimbursementRates> </Schedule>
multipart/form-data
Sample:
<Schedule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models"><AddedBy>sample string 14</AddedBy><AddedDate>2026-09-04T01:10:34.8893079-04:00</AddedDate><AgencyApprovedBill>true</AgencyApprovedBill><AgencyApprovedPay>true</AgencyApprovedPay><ApproveContact>sample string 7</ApproveContact><ApprovedBillBy>sample string 20</ApprovedBillBy><ApprovedBillDate>2026-09-04T01:10:34.8893079-04:00</ApprovedBillDate><ApprovedPayBy>sample string 19</ApprovedPayBy><ApprovedPayDate>2026-09-04T01:10:34.8893079-04:00</ApprovedPayDate><AssignedBy>sample string 16</AssignedBy><AssignedDate>2026-09-04T01:10:34.8893079-04:00</AssignedDate><AvailabilityID>1</AvailabilityID><Bill15MinuteIncrements>1</Bill15MinuteIncrements><BillInvoiceNumber>1</BillInvoiceNumber><BillMinutes>1</BillMinutes><BillPeriodEnding>2026-09-04T01:10:34.8893079-04:00</BillPeriodEnding><BillRate>1</BillRate><BillingMemo>sample string 25</BillingMemo><CareAuthID>1</CareAuthID><CategoryID>1</CategoryID><Charge>1</Charge><ClientApproved>true</ClientApproved><ClientApprovedDate>2026-09-04T01:10:34.8893079-04:00</ClientApprovedDate><ClientConfirmContact>sample string 28</ClientConfirmContact><ClientConfirmed>true</ClientConfirmed><ClientConfirmedBy>sample string 17</ClientConfirmedBy><ClientConfirmedDate>2026-09-04T01:10:34.8893079-04:00</ClientConfirmedDate><ClientID>1</ClientID><Comment>sample string 27</Comment><ContractAgency>1</ContractAgency><ContractID>1</ContractID><CopiedFrom>1</CopiedFrom><DeletedBySystem>1</DeletedBySystem><EmployeeConfirmed>true</EmployeeConfirmed><EmployeeConfirmedBy>sample string 18</EmployeeConfirmedBy><EmployeeConfirmedDate>2026-09-04T01:10:34.8893079-04:00</EmployeeConfirmedDate><EmployeeID>1</EmployeeID><ExportedAPBy>sample string 31</ExportedAPBy><ExportedAPDate>2026-09-04T01:10:34.8893079-04:00</ExportedAPDate><ExportedBillBy>sample string 24</ExportedBillBy><ExportedBillDate>2026-09-04T01:10:34.8893079-04:00</ExportedBillDate><ExportedPayBy>sample string 23</ExportedPayBy><ExportedPayDate>2026-09-04T01:10:34.8893079-04:00</ExportedPayDate><GenStarStatus>1</GenStarStatus><InstantAdvanceApplied>13</InstantAdvanceApplied><InstantAdvanceApproved>true</InstantAdvanceApproved><InstantAdvanceApprovedBy>sample string 29</InstantAdvanceApprovedBy><InstantAdvanceApprovedDate>2026-09-04T01:10:34.8893079-04:00</InstantAdvanceApprovedDate><InstantAdvanceBy>sample string 30</InstantAdvanceBy><InstantAdvanceDate>2026-09-04T01:10:34.8893079-04:00</InstantAdvanceDate><Invoiced>true</Invoiced><InvoicedBy>sample string 22</InvoicedBy><InvoicedDate>2026-09-04T01:10:34.8893079-04:00</InvoicedDate><LastModifiedBy>sample string 15</LastModifiedBy><LastModifiedDate>2026-09-04T01:10:34.8893079-04:00</LastModifiedDate><Location>sample string 2</Location><LunchAdjust>1</LunchAdjust><NonBillMinutes>1</NonBillMinutes><OnCall>1</OnCall><OrderID>1</OrderID><OrderTypeID>1</OrderTypeID><Orientation>1</Orientation><OverridePayBill>1</OverridePayBill><Paid>true</Paid><PaidBy>sample string 21</PaidBy><PaidDate>2026-09-04T01:10:34.8893079-04:00</PaidDate><PayCheckNumber>sample string 26</PayCheckNumber><PayRate>1</PayRate><PayWeekEnding>2026-09-04T01:10:34.8893079-04:00</PayWeekEnding><PayerID>1</PayerID><Posted>true</Posted><PostedStartTime>2026-09-04T01:10:34.8893079-04:00</PostedStartTime><PostedStopTime>2026-09-04T01:10:34.8893079-04:00</PostedStopTime><RegionID>1</RegionID><RejectionReasonId>1</RejectionReasonId><ScheduleID>1</ScheduleID><ServiceAreaID>1</ServiceAreaID><Shift>1</Shift><ShiftCodeID>1</ShiftCodeID><StartTime>2026-09-04T01:10:34.8893079-04:00</StartTime><StopTime>2026-09-04T01:10:34.8893079-04:00</StopTime><SubClientID>1</SubClientID><TimeAndTrouble>1</TimeAndTrouble><TimeClockPostedLunch>2026-09-04T01:10:34.8893079-04:00</TimeClockPostedLunch><TimeClockPostedStart>2026-09-04T01:10:34.8893079-04:00</TimeClockPostedStart><TimeClockPostedStop>2026-09-04T01:10:34.8893079-04:00</TimeClockPostedStop><UserImageId>1</UserImageId><UsesReimbursementRates>1</UsesReimbursementRates></Schedule>