GET api/Bookings
Used to fetch bookings for a logged in user
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
COMPLETE
Collection of BookingDTOName | Description | Type | Additional information |
---|---|---|---|
FinishDate |
This is the day the booking ends |
date |
None. |
BookingNo |
This is the Booking Number |
string |
None. |
StartDate |
This is the day the booking starts |
date |
None. |
Status |
This is the Status of the booking eg AwaitingStart, Checked In, Current, Ending, Future, Past, Pending Confirm |
string |
None. |
JobTitle |
This is the Job title |
string |
None. |
Office |
This is the Office |
string |
None. |
SiteLocation |
This is the Site Location |
string |
None. |
ClientName |
This is the Client Name |
string |
None. |
ConsultantName |
This is the Consultant Name |
string |
None. |
ConsultantEmail |
This is the Consultant Email |
string |
None. |
ContactName |
This is the Contact Name |
string |
None. |
EmployeeName |
This is the Employee Name |
string |
None. |
PayCycleFrequency |
This is the Pay cycle Frequency : Weekly, Monthly |
string |
None. |
PayCycleDay |
This is the Pay cycle Day: MON-SUN or day for monthly eg 30, 15 |
string |
None. |
CountryCode |
This is the County code in 2 digit format |
string |
None. |
LeaveTypes |
This is a list of leave types which can be selected when entering leave in a timesheet |
Collection of string |
None. |
ExpenseTypes |
This is a list of expense types which can be selected when entering expense in a timesheet |
Collection of string |
None. |
AllowanceTypes |
This is a list of allowance types which can be selected when entering allowance in a timesheet |
Collection of string |
None. |
CostCentre |
This is a used to store CostCentre |
string |
None. |
CostCode |
This is a used to store CostCode |
string |
None. |
PurchaseOrder |
This is a used to store PurchaseOrder |
string |
None. |
ProjectNumber |
This is a used to store ProjectNumber |
string |
None. |
ShowCostCentre |
This is a used to determine if CostCentre is to be used |
boolean |
None. |
ShowCostCode |
This is a used to determine if CostCode is to be used |
boolean |
None. |
ShowPurchaseOrder |
This is a used to determine if PurchaseOrder is to be used |
boolean |
None. |
ShowProjectNumber |
This is a used to determine if ProjectNumber is to be used |
boolean |
None. |
ReportsTo |
Reporting contact based on booking |
string |
None. |
TimesheetLayout |
Timesheet Layout for Booking |
string |
None. |
RateSets |
Rate Set for Client or Candidate |
Collection of RateSet |
None. |
ClientCode | string |
None. |
|
EmployeeCode | string |
None. |
|
BookingType | string |
None. |
|
TimesheetCycleEnd | string |
None. |
|
TimesheetFrequency | string |
None. |
|
StartTime | time interval |
None. |
|
EndTime | time interval |
None. |
Response Formats
application/json, text/json
[ { "FinishDate": "2024-06-29T02:52:07.977604+10:00", "BookingNo": "sample string 2", "StartDate": "2024-06-29T02:52:07.977604+10:00", "Status": "sample string 4", "JobTitle": "sample string 5", "Office": "sample string 6", "SiteLocation": "sample string 7", "ClientName": "sample string 8", "ConsultantName": "sample string 9", "ConsultantEmail": "sample string 10", "ContactName": "sample string 11", "EmployeeName": "sample string 12", "PayCycleFrequency": "sample string 13", "PayCycleDay": "sample string 14", "CountryCode": "sample string 15", "LeaveTypes": [ "sample string 1", "sample string 2" ], "ExpenseTypes": [ "sample string 1", "sample string 2" ], "AllowanceTypes": [ "sample string 1", "sample string 2" ], "CostCentre": "sample string 16", "CostCode": "sample string 17", "PurchaseOrder": "sample string 18", "ProjectNumber": "sample string 19", "ShowCostCentre": true, "ShowCostCode": true, "ShowPurchaseOrder": true, "ShowProjectNumber": true, "ReportsTo": "sample string 24", "TimesheetLayout": "sample string 25", "RateSets": [ { "EffectiveDate": "2024-06-29T02:52:07.9786052+10:00", "RateSetItems": [ { "ProductCode": "sample string 1", "ProductName": "sample string 2", "Rate": 1.1 }, { "ProductCode": "sample string 1", "ProductName": "sample string 2", "Rate": 1.1 } ] }, { "EffectiveDate": "2024-06-29T02:52:07.9786052+10:00", "RateSetItems": [ { "ProductCode": "sample string 1", "ProductName": "sample string 2", "Rate": 1.1 }, { "ProductCode": "sample string 1", "ProductName": "sample string 2", "Rate": 1.1 } ] } ], "ClientCode": "sample string 26", "EmployeeCode": "sample string 27", "BookingType": "sample string 28", "TimesheetCycleEnd": "sample string 29", "TimesheetFrequency": "sample string 30", "StartTime": "00:00:00.1234567", "EndTime": "00:00:00.1234567" }, { "FinishDate": "2024-06-29T02:52:07.977604+10:00", "BookingNo": "sample string 2", "StartDate": "2024-06-29T02:52:07.977604+10:00", "Status": "sample string 4", "JobTitle": "sample string 5", "Office": "sample string 6", "SiteLocation": "sample string 7", "ClientName": "sample string 8", "ConsultantName": "sample string 9", "ConsultantEmail": "sample string 10", "ContactName": "sample string 11", "EmployeeName": "sample string 12", "PayCycleFrequency": "sample string 13", "PayCycleDay": "sample string 14", "CountryCode": "sample string 15", "LeaveTypes": [ "sample string 1", "sample string 2" ], "ExpenseTypes": [ "sample string 1", "sample string 2" ], "AllowanceTypes": [ "sample string 1", "sample string 2" ], "CostCentre": "sample string 16", "CostCode": "sample string 17", "PurchaseOrder": "sample string 18", "ProjectNumber": "sample string 19", "ShowCostCentre": true, "ShowCostCode": true, "ShowPurchaseOrder": true, "ShowProjectNumber": true, "ReportsTo": "sample string 24", "TimesheetLayout": "sample string 25", "RateSets": [ { "EffectiveDate": "2024-06-29T02:52:07.9786052+10:00", "RateSetItems": [ { "ProductCode": "sample string 1", "ProductName": "sample string 2", "Rate": 1.1 }, { "ProductCode": "sample string 1", "ProductName": "sample string 2", "Rate": 1.1 } ] }, { "EffectiveDate": "2024-06-29T02:52:07.9786052+10:00", "RateSetItems": [ { "ProductCode": "sample string 1", "ProductName": "sample string 2", "Rate": 1.1 }, { "ProductCode": "sample string 1", "ProductName": "sample string 2", "Rate": 1.1 } ] } ], "ClientCode": "sample string 26", "EmployeeCode": "sample string 27", "BookingType": "sample string 28", "TimesheetCycleEnd": "sample string 29", "TimesheetFrequency": "sample string 30", "StartTime": "00:00:00.1234567", "EndTime": "00:00:00.1234567" } ]
text/xml
<ArrayOfBookingDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"> <BookingDTO> <AllowanceTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </AllowanceTypes> <BookingNo>sample string 2</BookingNo> <BookingType>sample string 28</BookingType> <ClientCode>sample string 26</ClientCode> <ClientName>sample string 8</ClientName> <ConsultantEmail>sample string 10</ConsultantEmail> <ConsultantName>sample string 9</ConsultantName> <ContactName>sample string 11</ContactName> <CostCentre>sample string 16</CostCentre> <CostCode>sample string 17</CostCode> <CountryCode>sample string 15</CountryCode> <EmployeeCode>sample string 27</EmployeeCode> <EmployeeName>sample string 12</EmployeeName> <EndTime>PT0.1234567S</EndTime> <ExpenseTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </ExpenseTypes> <FinishDate>2024-06-29T02:52:07.977604+10:00</FinishDate> <JobTitle>sample string 5</JobTitle> <LeaveTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </LeaveTypes> <Office>sample string 6</Office> <PayCycleDay>sample string 14</PayCycleDay> <PayCycleFrequency>sample string 13</PayCycleFrequency> <ProjectNumber>sample string 19</ProjectNumber> <PurchaseOrder>sample string 18</PurchaseOrder> <RateSets> <RateSet> <EffectiveDate>2024-06-29T02:52:07.9786052+10:00</EffectiveDate> <RateSetItems> <RateSetItem> <ProductCode>sample string 1</ProductCode> <ProductName>sample string 2</ProductName> <Rate>1.1</Rate> </RateSetItem> <RateSetItem> <ProductCode>sample string 1</ProductCode> <ProductName>sample string 2</ProductName> <Rate>1.1</Rate> </RateSetItem> </RateSetItems> </RateSet> <RateSet> <EffectiveDate>2024-06-29T02:52:07.9786052+10:00</EffectiveDate> <RateSetItems> <RateSetItem> <ProductCode>sample string 1</ProductCode> <ProductName>sample string 2</ProductName> <Rate>1.1</Rate> </RateSetItem> <RateSetItem> <ProductCode>sample string 1</ProductCode> <ProductName>sample string 2</ProductName> <Rate>1.1</Rate> </RateSetItem> </RateSetItems> </RateSet> </RateSets> <ReportsTo>sample string 24</ReportsTo> <ShowCostCentre>true</ShowCostCentre> <ShowCostCode>true</ShowCostCode> <ShowProjectNumber>true</ShowProjectNumber> <ShowPurchaseOrder>true</ShowPurchaseOrder> <SiteLocation>sample string 7</SiteLocation> <StartDate>2024-06-29T02:52:07.977604+10:00</StartDate> <StartTime>PT0.1234567S</StartTime> <Status>sample string 4</Status> <TimesheetCycleEnd>sample string 29</TimesheetCycleEnd> <TimesheetFrequency>sample string 30</TimesheetFrequency> <TimesheetLayout>sample string 25</TimesheetLayout> </BookingDTO> <BookingDTO> <AllowanceTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </AllowanceTypes> <BookingNo>sample string 2</BookingNo> <BookingType>sample string 28</BookingType> <ClientCode>sample string 26</ClientCode> <ClientName>sample string 8</ClientName> <ConsultantEmail>sample string 10</ConsultantEmail> <ConsultantName>sample string 9</ConsultantName> <ContactName>sample string 11</ContactName> <CostCentre>sample string 16</CostCentre> <CostCode>sample string 17</CostCode> <CountryCode>sample string 15</CountryCode> <EmployeeCode>sample string 27</EmployeeCode> <EmployeeName>sample string 12</EmployeeName> <EndTime>PT0.1234567S</EndTime> <ExpenseTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </ExpenseTypes> <FinishDate>2024-06-29T02:52:07.977604+10:00</FinishDate> <JobTitle>sample string 5</JobTitle> <LeaveTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </LeaveTypes> <Office>sample string 6</Office> <PayCycleDay>sample string 14</PayCycleDay> <PayCycleFrequency>sample string 13</PayCycleFrequency> <ProjectNumber>sample string 19</ProjectNumber> <PurchaseOrder>sample string 18</PurchaseOrder> <RateSets> <RateSet> <EffectiveDate>2024-06-29T02:52:07.9786052+10:00</EffectiveDate> <RateSetItems> <RateSetItem> <ProductCode>sample string 1</ProductCode> <ProductName>sample string 2</ProductName> <Rate>1.1</Rate> </RateSetItem> <RateSetItem> <ProductCode>sample string 1</ProductCode> <ProductName>sample string 2</ProductName> <Rate>1.1</Rate> </RateSetItem> </RateSetItems> </RateSet> <RateSet> <EffectiveDate>2024-06-29T02:52:07.9786052+10:00</EffectiveDate> <RateSetItems> <RateSetItem> <ProductCode>sample string 1</ProductCode> <ProductName>sample string 2</ProductName> <Rate>1.1</Rate> </RateSetItem> <RateSetItem> <ProductCode>sample string 1</ProductCode> <ProductName>sample string 2</ProductName> <Rate>1.1</Rate> </RateSetItem> </RateSetItems> </RateSet> </RateSets> <ReportsTo>sample string 24</ReportsTo> <ShowCostCentre>true</ShowCostCentre> <ShowCostCode>true</ShowCostCode> <ShowProjectNumber>true</ShowProjectNumber> <ShowPurchaseOrder>true</ShowPurchaseOrder> <SiteLocation>sample string 7</SiteLocation> <StartDate>2024-06-29T02:52:07.977604+10:00</StartDate> <StartTime>PT0.1234567S</StartTime> <Status>sample string 4</Status> <TimesheetCycleEnd>sample string 29</TimesheetCycleEnd> <TimesheetFrequency>sample string 30</TimesheetFrequency> <TimesheetLayout>sample string 25</TimesheetLayout> </BookingDTO> </ArrayOfBookingDTO>
multipart/form-data
<ArrayOfBookingDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><BookingDTO><AllowanceTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d3p1:string>sample string 1</d3p1:string><d3p1:string>sample string 2</d3p1:string></AllowanceTypes><BookingNo>sample string 2</BookingNo><BookingType>sample string 28</BookingType><ClientCode>sample string 26</ClientCode><ClientName>sample string 8</ClientName><ConsultantEmail>sample string 10</ConsultantEmail><ConsultantName>sample string 9</ConsultantName><ContactName>sample string 11</ContactName><CostCentre>sample string 16</CostCentre><CostCode>sample string 17</CostCode><CountryCode>sample string 15</CountryCode><EmployeeCode>sample string 27</EmployeeCode><EmployeeName>sample string 12</EmployeeName><EndTime>PT0.1234567S</EndTime><ExpenseTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d3p1:string>sample string 1</d3p1:string><d3p1:string>sample string 2</d3p1:string></ExpenseTypes><FinishDate>2024-06-29T02:52:07.977604+10:00</FinishDate><JobTitle>sample string 5</JobTitle><LeaveTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d3p1:string>sample string 1</d3p1:string><d3p1:string>sample string 2</d3p1:string></LeaveTypes><Office>sample string 6</Office><PayCycleDay>sample string 14</PayCycleDay><PayCycleFrequency>sample string 13</PayCycleFrequency><ProjectNumber>sample string 19</ProjectNumber><PurchaseOrder>sample string 18</PurchaseOrder><RateSets><RateSet><EffectiveDate>2024-06-29T02:52:07.9786052+10:00</EffectiveDate><RateSetItems><RateSetItem><ProductCode>sample string 1</ProductCode><ProductName>sample string 2</ProductName><Rate>1.1</Rate></RateSetItem><RateSetItem><ProductCode>sample string 1</ProductCode><ProductName>sample string 2</ProductName><Rate>1.1</Rate></RateSetItem></RateSetItems></RateSet><RateSet><EffectiveDate>2024-06-29T02:52:07.9786052+10:00</EffectiveDate><RateSetItems><RateSetItem><ProductCode>sample string 1</ProductCode><ProductName>sample string 2</ProductName><Rate>1.1</Rate></RateSetItem><RateSetItem><ProductCode>sample string 1</ProductCode><ProductName>sample string 2</ProductName><Rate>1.1</Rate></RateSetItem></RateSetItems></RateSet></RateSets><ReportsTo>sample string 24</ReportsTo><ShowCostCentre>true</ShowCostCentre><ShowCostCode>true</ShowCostCode><ShowProjectNumber>true</ShowProjectNumber><ShowPurchaseOrder>true</ShowPurchaseOrder><SiteLocation>sample string 7</SiteLocation><StartDate>2024-06-29T02:52:07.977604+10:00</StartDate><StartTime>PT0.1234567S</StartTime><Status>sample string 4</Status><TimesheetCycleEnd>sample string 29</TimesheetCycleEnd><TimesheetFrequency>sample string 30</TimesheetFrequency><TimesheetLayout>sample string 25</TimesheetLayout></BookingDTO><BookingDTO><AllowanceTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d3p1:string>sample string 1</d3p1:string><d3p1:string>sample string 2</d3p1:string></AllowanceTypes><BookingNo>sample string 2</BookingNo><BookingType>sample string 28</BookingType><ClientCode>sample string 26</ClientCode><ClientName>sample string 8</ClientName><ConsultantEmail>sample string 10</ConsultantEmail><ConsultantName>sample string 9</ConsultantName><ContactName>sample string 11</ContactName><CostCentre>sample string 16</CostCentre><CostCode>sample string 17</CostCode><CountryCode>sample string 15</CountryCode><EmployeeCode>sample string 27</EmployeeCode><EmployeeName>sample string 12</EmployeeName><EndTime>PT0.1234567S</EndTime><ExpenseTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d3p1:string>sample string 1</d3p1:string><d3p1:string>sample string 2</d3p1:string></ExpenseTypes><FinishDate>2024-06-29T02:52:07.977604+10:00</FinishDate><JobTitle>sample string 5</JobTitle><LeaveTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d3p1:string>sample string 1</d3p1:string><d3p1:string>sample string 2</d3p1:string></LeaveTypes><Office>sample string 6</Office><PayCycleDay>sample string 14</PayCycleDay><PayCycleFrequency>sample string 13</PayCycleFrequency><ProjectNumber>sample string 19</ProjectNumber><PurchaseOrder>sample string 18</PurchaseOrder><RateSets><RateSet><EffectiveDate>2024-06-29T02:52:07.9786052+10:00</EffectiveDate><RateSetItems><RateSetItem><ProductCode>sample string 1</ProductCode><ProductName>sample string 2</ProductName><Rate>1.1</Rate></RateSetItem><RateSetItem><ProductCode>sample string 1</ProductCode><ProductName>sample string 2</ProductName><Rate>1.1</Rate></RateSetItem></RateSetItems></RateSet><RateSet><EffectiveDate>2024-06-29T02:52:07.9786052+10:00</EffectiveDate><RateSetItems><RateSetItem><ProductCode>sample string 1</ProductCode><ProductName>sample string 2</ProductName><Rate>1.1</Rate></RateSetItem><RateSetItem><ProductCode>sample string 1</ProductCode><ProductName>sample string 2</ProductName><Rate>1.1</Rate></RateSetItem></RateSetItems></RateSet></RateSets><ReportsTo>sample string 24</ReportsTo><ShowCostCentre>true</ShowCostCentre><ShowCostCode>true</ShowCostCode><ShowProjectNumber>true</ShowProjectNumber><ShowPurchaseOrder>true</ShowPurchaseOrder><SiteLocation>sample string 7</SiteLocation><StartDate>2024-06-29T02:52:07.977604+10:00</StartDate><StartTime>PT0.1234567S</StartTime><Status>sample string 4</Status><TimesheetCycleEnd>sample string 29</TimesheetCycleEnd><TimesheetFrequency>sample string 30</TimesheetFrequency><TimesheetLayout>sample string 25</TimesheetLayout></BookingDTO></ArrayOfBookingDTO>