ManageUser
API | Description |
---|---|
GET api/ManageUser/{email}/Details |
Ussed to fetch details of user for email ID |
POST api/ManageUser/New |
Create a new user account in the portal |
POST api/ManageUser/{email}/Unlock |
Unlock a user account |
PUT api/ManageUser/{email}/SecurityGroup |
Enable/Disable Security Group for a user |
PUT api/ManageUser/{email}/ActivationEmail |
Resend user activation email |
PUT api/ManageUser/{email}/ResetPassword |
Send Reset Password email to user |
PUT api/ManageUser/{email}/SocialMedia |
Used to update social media settings of a user |
GET api/ManageUser/UserList |
Get list of Users to manage |
POST api/User/Register |
Create a new Client user account in the portal. For WorkPocket. |
GET api/StaffLoginAuthO/{accessToken} |
validate access token to Login for Randstad staff - AuthO |
Candidate
Event
API | Description |
---|---|
POST api/Events |
Logs Events using Evently |
TimesheetExternal
DSM
Booking
API | Description |
---|---|
GET api/Bookings |
Used to fetch bookings for a logged in user |
GET api/Bookings/{BookingNo} |
Used to fetch a single booking for a logged in user |
GET api/Bookings/{BookingNo}/PeriodEndDates |
Used to fetch a list of (DateTime) PeriodEndDate for a booking for a logged in user |
GET api/Bookings/{BookingNo}/Approvers |
Fetch list of approvers for booking |
GET api/Bookings/{BookingNo}/MaxWorkingTime |
Get Max working time for the booking |
GET api/Bookings/{BookingNo}/screenconfig |
Used to fetch a screen config booking for a logged in user |
Account
API | Description |
---|---|
GET api/TestError/{code} |
Test Multiple Error Codes |
POST api/AccountValidateToken?token={token} |
Used to check if a token has not expired Note: this should only be used when an application needs to specifically check if token has expired (eg. when app has been in background and then is put in foreground state, need to specially check if token hasnt expired so unauthorised users cannot see data) Dont use this for each API request because valid tokens are already checked and updated |
GET api/IsRandstadEmail?email={email} |
Used for Checking if the Email provided is Possibly a Randstad APAC Internal Email. Does not check if the actual user exists. Just provides information if the email is considered internal to Randstad. |
PUT api/AccountUpdatePassword |
Used to update password for current auth code |
POST api/StaffLogin |
Login for Randstad staff |
POST api/SocialLogin |
Social Login for user through Facebook, Google etc. |
POST api/CheckLinkSocial |
Used for checking if current social profile is linked with a Randstad internal account |
POST api/LinkSocial |
Used for linking a validated social media account with Randstad's internal account |
POST api/ChangeRole |
Used for changing role of an already authenticated user |
POST api/Impersonate |
No documentation available. |
POST api/Signout |
Used for signing out user on logout |
POST api/Impersonate/End |
Used for ending current impersonation session |
POST api/ForgotPassword |
Used for handling forgotten password |
POST api/ResetPassword |
Used for resetting the user's password |
PUT api/ChangeStatus |
Used for changing the status of a user |
PUT api/ActivateAccount |
Used for activating a new user account |
POST api/Account |
Used to login and get a token which can be used for all requests in the API |
MasterVendor
Timesheet
API | Description |
---|---|
GET api/Timesheets?BookingNo={BookingNo}&searchType={searchType}&startDate={startDate}&endDate={endDate}&rowFrom={rowFrom}&rowTo={rowTo} |
Used to fetch the list of timesheets for a logged in user |
GET api/Timesheets/{id} |
Gets the timesheet details for a single timesheet, no image data returned with this call |
POST api/Timesheets |
Adds a timesheet |
PUT api/Timesheets/{id}/EmployeeComment |
update the timesheet employee comment for a single timesheet |
GET api/Timesheets/Bookings |
Get Bookings for selecting during Timsheet creation |
PUT api/Timesheets/{id}/Header |
update the timesheet header data for a single timesheet |
PUT api/Timesheets/{id}/CostCentre |
update the timesheet Cost Centre for a single timesheet |
PUT api/Timesheets/{id}/CostCode |
update the timesheet Cost Code for a single timesheet |
PUT api/Timesheets/{id}/PurchaseOrder |
update the timesheet Purchase Order for a single timesheet |
PUT api/Timesheets/{id}/ProductCode |
update the timesheet Product Code for a single timesheet |
PUT api/Timesheets/{id}/TimesheetStatus?Status={Status} |
update the timesheet status for a single timesheet |
PUT api/Timesheets/{id}/TimesheetApproval |
Approve/Reject by approver for a single timesheet |
PUT api/Timesheets/TimesheetsApproval |
Approve/Reject by approver for a multiple timesheets |
GET api/Timesheets/{id}/shifts |
Gets the timesheet shifts for a single timesheet |
POST api/Timesheets/{id}/shifts |
Adds the timesheet shift for a single timesheet |
POST api/Timesheets/{id}/Multishifts |
Deletes existing shifts, then adds a number of timesheet shifts for a single timesheet |
PUT api/Timesheets/{id}/shifts |
update the timesheet shift for a single timesheet |
DELETE api/Timesheets/{id}/shifts/{shiftId} |
Delete the timesheet shift for a single timesheet |
GET api/Timesheets/{id}/expenses |
Gets the timesheet Expenses for a single timesheet |
POST api/Timesheets/{id}/expenses |
Adds the timesheet Expense for a single timesheet |
PUT api/Timesheets/{id}/expenses |
update the timesheet Expense for a single timesheet |
DELETE api/Timesheets/{id}/expenses/{expenseId} |
Delete the timesheet Expense for a single timesheet |
GET api/Timesheets/{id}/allowances |
Gets the timesheet allowances for a single timesheet |
POST api/Timesheets/{id}/allowances |
Adds the timesheet Allowance for a single timesheet |
PUT api/Timesheets/{id}/allowances |
update the timesheet Allowance for a single timesheet |
DELETE api/Timesheets/{id}/allowances/{allowanceId} |
Delete the timesheet Allowance for a single timesheet |
GET api/Timesheets/{id}/leaves |
Gets the timesheet leaves for a single timesheet |
POST api/Timesheets/{id}/leaves |
Adds the timesheet Leave for a single timesheet |
PUT api/Timesheets/{id}/leaves |
update the timesheet Leave for a single timesheet |
DELETE api/Timesheets/{id}/leaves/{leaveId} |
Delete the timesheet Leave for a single timesheet |
GET api/Timesheets/{id}/attachments |
Gets the timesheet Attachments for a single timesheet |
GET api/Timesheets/{id}/attachments/new |
Gets the timesheet Attachments for a single timesheet with thumbnails using the Timesheet Number |
POST api/Timesheets/{id}/attachments |
Adds the timesheet Attachments for a single timesheet |
PUT api/Timesheets/{id}/attachments |
update the timesheet Attachments for a single timesheet |
DELETE api/Timesheets/{id}/attachments/{attachmentId} |
Delete the timesheet Attachments for a single timesheet |
GET api/Timesheets/{id}/attachmentBase64/{attachmentId} |
Used to get a Timesheet Attachment Image in string |
GET api/Timesheets/{id}/attachmentimages/{attachmentId} |
Used to get a Timesheet Attachment Image in JPG |
PUT api/Timesheets/{id}/SingleInterval |
Update first date and last date for monthly timesheet as a single interval |
GET api/MultiTimesheets |
Get the MultiTimesheets Batch list |
GET api/MultiTimesheets/{batchNumber} |
Get MultiTimesheet by Batch number |
GET api/MultiTimesheets/{batchNumber}/Bookings |
Get MultiTimesheet Bookings by Period End Date |
POST api/MultiTimesheets |
API for creating new Multi Timesheet Batch |
POST api/MultiTimesheets/Timesheets |
API for creating Timesheets in MultiTimesheets |
DELETE api/MultiTimesheets/{batchNumber} |
Void MultiTimesheet by Batch number |
POST api/MultiTimesheets/Product/Timesheets/{timesheetid} |
Add list of Produt Summaries to Timesheet in MultiTimesheet Batch |
PUT api/MultiTimesheets/Product/Timesheets/{timesheetid}/Comment |
Update Approver Comment in Timesheet in MultiTimesheet Batch |
PUT api/MultiTimesheets/{batchNumber}/Approve |
Approve MultiTimesheet Batch by Client |
PUT api/MultiTimesheets/{batchNumber}/Unlock |
Unlock a MultiTimesheet batch |
GET api/PublicHolidays?bookingNo={bookingNo}&fromDate={fromDate}&toDate={toDate} |
Get public holidays based on booking number and period |
GET api/Timesheets/{timesheetNumber}/EstimatedCharges |
Gets the timesheet details for a single timesheet, no image data returned with this call |
GET api/Timesheets/count?startDate={startDate}&endDate={endDate} |
Gets the timesheet count within Date range |
RatesManagement
Order
API | Description |
---|---|
GET api/Order |
Used to fetch the timeline for a logged in user |
GET api/Order/{id}/VacancyDetails/{clientAgencyId} |
Fetch Vacancies for an Order |
GET api/Order/{id}/Sites/{clientAgencyId} |
Fetch Sites for an Order |
GET api/Order/{ordercode}/Contacts |
Fetch client contacts for an Order |
POST api/Order/{id}/Vacancy |
Used for creating a new vacancy for an order |
PUT api/Order/{authCode}VacancyApproval |
Approve/Reject by approver for OrderRequest |
POST api/Order/{id}/Document |
Upload file for a new vacancy. Note: Currently the document is stored at the order level only. |
PUT api/Order/{id}/Vacancy/Cancel |
Delete a Vacancy |
POST api/Order |
Used for creating a new order |
PUT api/Order |
Used for update existing order |
DELETE api/Order |
Used for close existing order |
GET api/Order/AcceptedShift/{authCode} |
From sms/email user can able see order vacancy detail by authcode |
GET api/Order/VacancyShiftTimes/{id} |
for temp order and selected multi day dispaly each vacancy times |
GET api/Order/VacancyDetails/{orderLineItemId} |
Used for getting vacancy details by OrderLineItemId |
GET api/Order/Personality |
Used for getting a consultant default order list |
GET api/Order/{OrderCode} |
Used for getting a consultant default order list |
GET api/Order/Personality/{SearchFilter} |
Used for getting a consultant default order list |
GET api/Order/VacancyRequestReasons |
Get Vacancy request reasons |
GET api/Order/{id}/VacancyJobTitle |
Get Vacancy request job titles |
POST api/Order/{OrderCode}/DSM/{WorkOrderCode}/Link |
No documentation available. |
GET api/Order/{orderId}/ClientAgency/{clientAgencyId}/AddVacancy |
This is used to get order details for add vacancy. This method was implemented based on GetVacanciesForOrder method but with additional DSM related details. |
GET api/Order/Vacancy/Open?startDate={startDate}&endDate={endDate} |
This is used to get list of open vacancies for client. |
GET api/Order/Vacancy/Fill?startDate={startDate}&endDate={endDate} |
This is used to get list of fill vacancies for client. |
GET api/Order/Vacancy/Worktime?entityId={entityId}&entityType={entityType} |
No documentation available. |
GET api/Order/List |
This is used to get list of order for client |
GET api/Order/OrderRequest/{orderRequestId}/SourceCode/{sourceCode} |
This is used to get order request external reference code |
GET api/Order/Vacancy/OpenCount?startDate={startDate}&endDate={endDate} |
This is used to get list of open vacancies for client. |
PUT api/Order/{OrderCode}/DSM/{WorkOrderCode}/Unlink |
This is used to unlink DSM work order with Stratos order. |
PUT api/Order/DSM/ShiftRequest/{ShiftRequestCode}/Status/{Status} |
This is used to update the stratos order request external status |
Invoice
API | Description |
---|---|
GET api/Invoices |
Used to fetch the list of invoices for a logged in user |
GET api/Invoices/{id} |
Used to get a Invoice file in PDF |
Timeline
API | Description |
---|---|
GET api/Timeline |
Used to fetch the timeline for a logged in user |
MasterList
API | Description |
---|---|
GET api/MasterLists/{MasterList}/{Country}/{Filter} |
Used to fetch MasterLists |
GET api/MasterLists/Lens/{MasterList}/{Filter} |
This method is used to fetch the Lens MasterList. |
GET api/MasterLists/Lens/{MasterList} |
This method is used to fetch the Lens MasterList. |
GET api/MasterLists/SearchLocation |
This method is used to fetch the Lens MasterList. |
GET api/MasterLists/SearchLocation/{Filter} |
This method is used to fetch the Lens MasterList. |
GET api/MasterLists/SearchLocationCSV |
This method is used to fetch the SearchLocationCSV List in the form of Country,State,Suburb,PostCode. |
GET api/MasterLists/SearchLocationCSV/{Filter} |
This method is used to fetch the SearchLocationCSV List in the form of Country,State,Suburb,PostCode with Filter. |
GET api/MasterLists/SearchOrganization |
This method is used to fetch the SearchOrganization. |
GET api/MasterLists/SearchSalary |
This method is used to fetch the SearchSalary. |
GET api/MasterLists/SearchYearsOfExp |
This method is used to fetch the SearchYearsOfExp. |
GET api/MasterLists/Personalities |
This method is used to fetch the MFront Personalities. |
POST api/MasterLists/Personalities |
This method is used to fetch the MFront Personalities. |
GET api/MasterLists/SearchOrganization/{Filter} |
This method is used to fetch the SearchOrganization with Filter. |
GET api/MasterLists/LensDistribution |
This method is used to fetch the LensDistribution. |
GET api/Products/AllowanceTypes |
No documentation available. |
GET api/Products/ExpenseTypes |
Use to fetch Mfront MasterLists |
GET api/MasterLists/GetMasterLists/{listType} |
Get Mfront MasterList |
GET api/MasterLists/GetBrandOffice |
Get Branch Office data |
GET api/MasterLists/GetAllLocations |
Get All locations |
GET api/MasterLists/GetAllSpecialism/{jobTitle} |
Get all specialisms |
GET api/MasterLists/GetAllJobTitle/{specialism} |
Get all job titles |
WebEnvelope
API | Description |
---|---|
PUT api/envelope/{EnvelopeID}/notify |
Used to notify the envelope status update |
GET api/envelope/{EnvelopeID}/additional?SourceReference={SourceReference}&SourceSystem={SourceSystem} |
Used to get additional details of envelope |
Questionnaire
API | Description |
---|---|
GET api/Questionnaire/Template/{TemplateID} |
Used to fetch a Questionnaire template |
GET api/Questionnaire/{QuestionnaireID} |
Used to fetch a Questionnaire |
PUT api/Questionnaire |
Used to save a Questionnaire |
Report
API | Description |
---|---|
GET api/Report/TimesheetDetails?templateId={templateId}&fromDate={fromDate}&toDate={toDate} |
Used to fetch the report by timesheet template, and range of date |
GET api/Report/InvoiceDetails?templateId={templateId}&fromDate={fromDate}&toDate={toDate} |
Used to fetch the report by invoice template, and range of date |
ClientSettings
API | Description |
---|---|
GET api/Client/{clientcode}/Settings |
Get Client settings for client code |
PUT api/Client/{clientcode}/Settings |
Entitlement
API | Description |
---|---|
GET api/Entitlement/Balances |
Used to fetch login user leave dashboard balance |
GET api/Entitlement |
Used to fetch the list of Leaves for a logged in user |
GET api/Entitlement/Types |
Get entitlement types list by user login. |
POST api/Entitlement |
Create entitlement/leave application |
GET api/Entitlement/{id} |
Gets the leave details for a single Leave, no image data returned with this call |
PUT api/Entitlement/Status |
Approve/Reject by approver for a Leave application Useing Same function as use by timesheet |
GET api/Entitlement/BalanceByEntitlementType?entitlementTypeName={entitlementTypeName}&leaveStartDate={leaveStartDate}&leaveEndDate={leaveEndDate} |
Get balance by entitlement type name. |
GET api/Entitlement/{timesheetId}/Attachment/{attachmentId} |
return url for attachment |
GET api/Entitlement/PublicHolidays |
Get public holidays list by user login. |
PUT api/Entitlement/{id}/Status?Status={Status} |
Update Leave Application Status (use same function in Timesheet) |
GET api/Entitlement/AppliedLeavesDetails?fromDate={fromDate}&toDate={toDate}&bookingNo={bookingNo} |
Get applied leaves list with details by fromDate, todDate and bookingNo. |
GET api/Entitlement/AccrualHistoryByEntitlementType?entitlementTypeName={entitlementTypeName} |
Get accrual history details by entitlement type name. |
ScreenConfig
PaySummary
API | Description |
---|---|
GET api/PaySummaries |
Used to fetch the list of annual payslip summary for a logged in user |
GET api/PaySummaries/{documentNumber} |
Used to get a PaySummary document in PDF |
Consultant
API | Description |
---|---|
GET api/Consultant/Personality |
Used to fetch a consultant personalities |
GET api/Consultant/Personality/Candidates?name={name}&email={email}&deactivated={deactivated} |
Used to fetch a consultant personalities candidates |
GET api/Consultant/Personality/TaxDocuments?consultantName={consultantName}&candidateName={candidateName}&sentFromDate={sentFromDate}&sentToDate={sentToDate} |
Used to fetch a consultant Tax documents |
GET api/Consultant/Personality/Questionnaire/{TemplateType} |
Used to fetch a consultant Questionnaire list |
GET api/Consultant/Personality/EmailTemplates |
Used to fetch a consultant email template list |
GET api/Consultant/Personality/EmailTemplates/{TemplateID} |
Used to fetch a consultant email template |
GET api/Consultant/GoogleValidation |
Used to fetch a consultant google token |
POST api/Consultant/GoogleValidation |
Used to update a consultant google token |
GET api/Consultant/EmailSignature |
Used to get then consultant signature |
Payslip
API | Description |
---|---|
GET api/Payslips |
Used to fetch the list of payslips for a logged in user |
GET api/Payslips/{id} |
Used to get a PaySlip Image in PDF |
GET api/documents/count?startDate={startDate}&endDate={endDate} |
Get pay transaction count within Date range |
Dashboard
API | Description |
---|---|
GET api/Reports/Clients |
Used to fetch Dashboard data for Employee count |
GET api/Reports/ClientEmployeeCount |
Used to fetch Dashboard data for Employee count |
GET api/Reports/ClientBilledHours |
Used to fetch Dashboard data for Billed Hours |
GET api/Reports/ClientInvoiceCount |
Used to fetch Dashboard data for Invoice count |
GET api/Reports/ClientVacancyCount |
Used to fetch Dashboad data for Vacancy count |
GET api/Reports/CurrentEmployees |
Used to get Dashboard data for Current employees |
GET api/Reports/WeeklyEmployeeCount |
Used to get Dashboard data for Current 5 weeks employees count |
GET api/Reports/CurrentEmployeesByJobCatergory |
Used to get Dashboard data for Current employees by Job category |
GET api/Reports/MonthlySpendByArea?serviceType={serviceType} |
Used to get Dashboard data for Monthly SpendBy Area |
GET api/Reports/MonthlySpendOnOvertime |
Used to get Dashboard data for Monthly SpendBy Over Time |
GET api/Reports/CurrentYearSpendOnOvertime |
Used to get Dashboard data for Current Year Spend On Overtime |
GET api/Reports/YTDSpendByArea |
Used to get Dashboard data for YTD Spend By Area |
GET api/Reports/TurnoverPerMonth |
Used to get Dashboard data for Turnover Per Month |
GET api/Reports/ClientEmployeeCountRollingFiveWeeksDetails |
Used to get Dashboard data for client Employee Count Details Result |
GET api/Reports/CurrentMonthSpend?serviceType={serviceType} |
Used to get Dashboard data for current Month Spend Details Result |
GET api/Reports/CurrentYearSpendPerPercent |
Used to get Dashboard data for current Month Spend Per Percent Details Result |
GET api/Reports/ClientEmployeeCountDetails |
Used to get Dashboard data for current Month Spend Per Percent Details Result |
GET api/Reports/CurrentYearEmployeeTurnover |
Used to get Dashboard data for current year employee turnover |
GET api/Reports/AnnualSpentByProduct |
Used to get Dashboard data for current year annual spent by product |
GET api/Reports/NewStaffCountByMonth |
Used to get Dashboard data for current new staff count by month |
GET api/Reports/NewStaffByMonthDetails |
Used to get Dashboard data for new staff by month details |
GET api/Reports/GenderDiversity |
No documentation available. |
GET api/Reports/BookingDaysLeft |
Used to get Dashboard data for upcoming booking ending ( Booking Days Left) Results |
GET api/Reports/PermSpendPerMonth |
Used to get Dashboard data for Perm Spend Per Month Results |
GET api/Reports/CandidateAgeDiversity |
Used to get Dashboard data for Candidate Age Diversity Results |
GET api/Reports/DaysToFillTempVacancies |
Used to get Dashboard data for Days To Fill Temp Vacancies Results |
GET api/Reports/DaysToFillTempVacanciesSummary |
Used to get Dashboard data for Days To Fill Temp Vacancies Summary Results |
GET api/Reports/TenureAtClientForCandidate |
Used to get Dashboard data for Days To Tenure At Client For Candidate Results |
GET api/Reports/GetCandidatessEthnicityDiversity |
Used to get Dashboard data for ethnicity diversity monthly summary data for export |
GET api/Reports/SupplierActivityForLastMonth |
Used to get Dashboard data for supplier activity monthly summary data |
GET api/Reports/SupplierActivityByYear |
Used to get Dashboard data for supplier activity yearly summary data |
Setting
API | Description |
---|---|
GET api/UserProfile |
Used to fetch the user profile for a logged in user |
PUT api/NotificationPreferences |
Used to fetch the notification prefernces of a user |
PUT api/ConsolidatePreferences |
Used to enable/disable consolidated preferences for a user |
PUT api/SocialMedia |
Used to update social media settings of a user |
EntitlementExternal
API | Description |
---|---|
PUT api/EntitlementExternal/{authCode}/Approval |
Gets the Leave details for a single timesheet by external user |
GET api/EntitlementExternal/{authCode} |
Gets the Leave details for a single timesheet by external user |
GET api/EntitlementExternal/{authCode}/Attachment/{attachmentId} |
return url for attachment by external user |
PUT api/EntitlementExternal/{authCode}/Status?status={status} |
update Leave Application & Cancellation Status by Auth Code (use same function in Timesheet) |
PreferenceCenter
API | Description |
---|---|
POST api/PreferenceCenter/GetPreferences |
Use to fetch Preferences data |
PUT api/PreferenceCenter/UpdatePreferences |
Use to update candidate Preferences data |
Document
API | Description |
---|---|
POST api/Document/DocumentExternal | |
POST api/Document/UploadDocument |
upload document as base64 string |
GET api/Document/{DocumentId}/Url |
Gets document Image |
Availability
API | Description |
---|---|
GET api/Availability/{email}?fromDate={fromDate}&toDate={toDate} |
Used to fetch availability for a requested candidate email ID |
PUT api/Availability |
Used to set availability for a logged in user |
GET api/Availability?fromDate={fromDate}&toDate={toDate} | |
POST api/Availability | |
DELETE api/Availability |