GET api/Order/{id}/VacancyDetails/{clientAgencyId}
Fetch Vacancies for an Order
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | string |
Required |
|
clientAgencyId | string |
Required |
Body Parameters
None.
Response Information
Resource Description
VacancyDetailName | Description | Type | Additional information |
---|---|---|---|
ClientAgencyId | integer |
None. |
|
OrderCode | string |
None. |
|
OrderId | string |
None. |
|
OrderItems | Collection of OrderItem |
None. |
|
ShiftModel | ShiftModel |
None. |
|
DSMWorkOrderCode | string |
None. |
|
IsComplianceDocumentsRequired | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "ClientAgencyId": 1, "OrderCode": "sample string 2", "OrderId": "sample string 3", "OrderItems": [ { "ActualJobTitle": "sample string 1", "ApplicantId": 1, "CalendarAppointmentRecurrenceId": 1, "CalledInBy": "sample string 2", "ClientContactName": "sample string 3", "CreatedOn": "2024-06-29T07:39:30.3252802+10:00", "DayNumber": 1, "Duration": "sample string 4", "EndDate": "2024-06-29T07:39:30.3252802+10:00", "ExpectedEndDate": "2024-06-29T07:39:30.3252802+10:00", "ExpectedEndTime": "sample string 5", "ExpectedStartDate": "2024-06-29T07:39:30.3252802+10:00", "ExpectedStartTime": "sample string 6", "Fullname": "sample string 7", "IsAllDay": true, "IsClientSubmitted": true, "IsUpdateLocked": true, "LastUpdatedOn": "2024-06-29T07:39:30.3252802+10:00", "MlApplicantStatusCode": "sample string 8", "MlLineItemStatusCode": "sample string 9", "MlOrderStatusCode": "sample string 10", "Month": 1, "OccurenceCount": 1, "OrderId": 11, "OrderLineItemId": 12, "OrderRequestCode": "sample string 13", "OrderRequestDate": "2024-06-29T07:39:30.3252802+10:00", "OrderRequestId": 14, "OriginalPositionsRequested": 1, "Periodicity": "sample string 15", "PrimarySiteId": 1, "Range": 1, "ReferenceClientContactId": 1, "ShiftPatternId": 1, "StartDate": "2024-06-29T07:39:30.3252802+10:00", "Type": 1, "WeekDays": 1, "WeekNumber": 1, "WeekOfMonth": 1, "SiteAddress": "sample string 16", "CostCentre": "sample string 17", "PurchaseOrder": "sample string 18", "FulfilmentDue": "2024-06-29T07:39:30.3252802+10:00", "OrderType": "sample string 19", "DSMWorkOrderCode": "sample string 20", "isPOMandatory": true, "CandidateId": 21, "CandidateCode": "sample string 22" }, { "ActualJobTitle": "sample string 1", "ApplicantId": 1, "CalendarAppointmentRecurrenceId": 1, "CalledInBy": "sample string 2", "ClientContactName": "sample string 3", "CreatedOn": "2024-06-29T07:39:30.3252802+10:00", "DayNumber": 1, "Duration": "sample string 4", "EndDate": "2024-06-29T07:39:30.3252802+10:00", "ExpectedEndDate": "2024-06-29T07:39:30.3252802+10:00", "ExpectedEndTime": "sample string 5", "ExpectedStartDate": "2024-06-29T07:39:30.3252802+10:00", "ExpectedStartTime": "sample string 6", "Fullname": "sample string 7", "IsAllDay": true, "IsClientSubmitted": true, "IsUpdateLocked": true, "LastUpdatedOn": "2024-06-29T07:39:30.3252802+10:00", "MlApplicantStatusCode": "sample string 8", "MlLineItemStatusCode": "sample string 9", "MlOrderStatusCode": "sample string 10", "Month": 1, "OccurenceCount": 1, "OrderId": 11, "OrderLineItemId": 12, "OrderRequestCode": "sample string 13", "OrderRequestDate": "2024-06-29T07:39:30.3252802+10:00", "OrderRequestId": 14, "OriginalPositionsRequested": 1, "Periodicity": "sample string 15", "PrimarySiteId": 1, "Range": 1, "ReferenceClientContactId": 1, "ShiftPatternId": 1, "StartDate": "2024-06-29T07:39:30.3252802+10:00", "Type": 1, "WeekDays": 1, "WeekNumber": 1, "WeekOfMonth": 1, "SiteAddress": "sample string 16", "CostCentre": "sample string 17", "PurchaseOrder": "sample string 18", "FulfilmentDue": "2024-06-29T07:39:30.3252802+10:00", "OrderType": "sample string 19", "DSMWorkOrderCode": "sample string 20", "isPOMandatory": true, "CandidateId": 21, "CandidateCode": "sample string 22" } ], "ShiftModel": { "OrderId": "sample string 1", "Comments": "sample string 2", "CalledInBy": "sample string 3", "JobTitle": "sample string 4", "NumberOfShifts": 5, "SiteAddresses": [ { "SiteAddressId": 1, "AddressLine1": "sample string 2", "AddressLine2": "sample string 3", "AddressLine3": "sample string 4", "Suburb": "sample string 5", "State": "sample string 6" }, { "SiteAddressId": 1, "AddressLine1": "sample string 2", "AddressLine2": "sample string 3", "AddressLine3": "sample string 4", "Suburb": "sample string 5", "State": "sample string 6" } ], "StartDate": "2024-06-29T07:39:30.3252802+10:00", "EndDate": "2024-06-29T07:39:30.3252802+10:00", "StartTime": "sample string 6", "EndTime": "sample string 7", "Site": "sample string 8", "FulfilmentDue": "2024-06-29T07:39:30.3252802+10:00", "PurchaseOrder": "sample string 9", "CostCentre": "sample string 10", "SourceSystem": "sample string 11", "UserName": "sample string 12", "VacancyType": "sample string 13", "VacancyRequestReason": "sample string 14", "ListShiftTime": [ { "Day": "sample string 1", "StartTime": "sample string 2", "EndTime": "sample string 3" }, { "Day": "sample string 1", "StartTime": "sample string 2", "EndTime": "sample string 3" } ], "ShiftType": "sample string 15", "VacancyJobTitleCode": "sample string 16" }, "DSMWorkOrderCode": "sample string 4", "IsComplianceDocumentsRequired": true }
text/xml
Sample:
<VacancyDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"> <ClientAgencyId>1</ClientAgencyId> <DSMWorkOrderCode>sample string 4</DSMWorkOrderCode> <IsComplianceDocumentsRequired>true</IsComplianceDocumentsRequired> <OrderCode>sample string 2</OrderCode> <OrderId>sample string 3</OrderId> <OrderItems> <OrderItem> <ActualJobTitle>sample string 1</ActualJobTitle> <ApplicantId>1</ApplicantId> <CalendarAppointmentRecurrenceId>1</CalendarAppointmentRecurrenceId> <CalledInBy>sample string 2</CalledInBy> <CandidateCode>sample string 22</CandidateCode> <CandidateId>21</CandidateId> <ClientContactName>sample string 3</ClientContactName> <CostCentre>sample string 17</CostCentre> <CreatedOn>2024-06-29T07:39:30.3252802+10:00</CreatedOn> <DSMWorkOrderCode>sample string 20</DSMWorkOrderCode> <DayNumber>1</DayNumber> <Duration>sample string 4</Duration> <EndDate>2024-06-29T07:39:30.3252802+10:00</EndDate> <ExpectedEndDate>2024-06-29T07:39:30.3252802+10:00</ExpectedEndDate> <ExpectedEndTime>sample string 5</ExpectedEndTime> <ExpectedStartDate>2024-06-29T07:39:30.3252802+10:00</ExpectedStartDate> <ExpectedStartTime>sample string 6</ExpectedStartTime> <FulfilmentDue>2024-06-29T07:39:30.3252802+10:00</FulfilmentDue> <Fullname>sample string 7</Fullname> <IsAllDay>true</IsAllDay> <IsClientSubmitted>true</IsClientSubmitted> <IsUpdateLocked>true</IsUpdateLocked> <LastUpdatedOn>2024-06-29T07:39:30.3252802+10:00</LastUpdatedOn> <MlApplicantStatusCode>sample string 8</MlApplicantStatusCode> <MlLineItemStatusCode>sample string 9</MlLineItemStatusCode> <MlOrderStatusCode>sample string 10</MlOrderStatusCode> <Month>1</Month> <OccurenceCount>1</OccurenceCount> <OrderId>11</OrderId> <OrderLineItemId>12</OrderLineItemId> <OrderRequestCode>sample string 13</OrderRequestCode> <OrderRequestDate>2024-06-29T07:39:30.3252802+10:00</OrderRequestDate> <OrderRequestId>14</OrderRequestId> <OrderType>sample string 19</OrderType> <OriginalPositionsRequested>1</OriginalPositionsRequested> <Periodicity>sample string 15</Periodicity> <PrimarySiteId>1</PrimarySiteId> <PurchaseOrder>sample string 18</PurchaseOrder> <Range>1</Range> <ReferenceClientContactId>1</ReferenceClientContactId> <ShiftPatternId>1</ShiftPatternId> <SiteAddress>sample string 16</SiteAddress> <StartDate>2024-06-29T07:39:30.3252802+10:00</StartDate> <Type>1</Type> <WeekDays>1</WeekDays> <WeekNumber>1</WeekNumber> <WeekOfMonth>1</WeekOfMonth> <isPOMandatory>true</isPOMandatory> </OrderItem> <OrderItem> <ActualJobTitle>sample string 1</ActualJobTitle> <ApplicantId>1</ApplicantId> <CalendarAppointmentRecurrenceId>1</CalendarAppointmentRecurrenceId> <CalledInBy>sample string 2</CalledInBy> <CandidateCode>sample string 22</CandidateCode> <CandidateId>21</CandidateId> <ClientContactName>sample string 3</ClientContactName> <CostCentre>sample string 17</CostCentre> <CreatedOn>2024-06-29T07:39:30.3252802+10:00</CreatedOn> <DSMWorkOrderCode>sample string 20</DSMWorkOrderCode> <DayNumber>1</DayNumber> <Duration>sample string 4</Duration> <EndDate>2024-06-29T07:39:30.3252802+10:00</EndDate> <ExpectedEndDate>2024-06-29T07:39:30.3252802+10:00</ExpectedEndDate> <ExpectedEndTime>sample string 5</ExpectedEndTime> <ExpectedStartDate>2024-06-29T07:39:30.3252802+10:00</ExpectedStartDate> <ExpectedStartTime>sample string 6</ExpectedStartTime> <FulfilmentDue>2024-06-29T07:39:30.3252802+10:00</FulfilmentDue> <Fullname>sample string 7</Fullname> <IsAllDay>true</IsAllDay> <IsClientSubmitted>true</IsClientSubmitted> <IsUpdateLocked>true</IsUpdateLocked> <LastUpdatedOn>2024-06-29T07:39:30.3252802+10:00</LastUpdatedOn> <MlApplicantStatusCode>sample string 8</MlApplicantStatusCode> <MlLineItemStatusCode>sample string 9</MlLineItemStatusCode> <MlOrderStatusCode>sample string 10</MlOrderStatusCode> <Month>1</Month> <OccurenceCount>1</OccurenceCount> <OrderId>11</OrderId> <OrderLineItemId>12</OrderLineItemId> <OrderRequestCode>sample string 13</OrderRequestCode> <OrderRequestDate>2024-06-29T07:39:30.3252802+10:00</OrderRequestDate> <OrderRequestId>14</OrderRequestId> <OrderType>sample string 19</OrderType> <OriginalPositionsRequested>1</OriginalPositionsRequested> <Periodicity>sample string 15</Periodicity> <PrimarySiteId>1</PrimarySiteId> <PurchaseOrder>sample string 18</PurchaseOrder> <Range>1</Range> <ReferenceClientContactId>1</ReferenceClientContactId> <ShiftPatternId>1</ShiftPatternId> <SiteAddress>sample string 16</SiteAddress> <StartDate>2024-06-29T07:39:30.3252802+10:00</StartDate> <Type>1</Type> <WeekDays>1</WeekDays> <WeekNumber>1</WeekNumber> <WeekOfMonth>1</WeekOfMonth> <isPOMandatory>true</isPOMandatory> </OrderItem> </OrderItems> </VacancyDetail>
multipart/form-data
Sample:
<VacancyDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><ClientAgencyId>1</ClientAgencyId><DSMWorkOrderCode>sample string 4</DSMWorkOrderCode><IsComplianceDocumentsRequired>true</IsComplianceDocumentsRequired><OrderCode>sample string 2</OrderCode><OrderId>sample string 3</OrderId><OrderItems><OrderItem><ActualJobTitle>sample string 1</ActualJobTitle><ApplicantId>1</ApplicantId><CalendarAppointmentRecurrenceId>1</CalendarAppointmentRecurrenceId><CalledInBy>sample string 2</CalledInBy><CandidateCode>sample string 22</CandidateCode><CandidateId>21</CandidateId><ClientContactName>sample string 3</ClientContactName><CostCentre>sample string 17</CostCentre><CreatedOn>2024-06-29T07:39:30.3252802+10:00</CreatedOn><DSMWorkOrderCode>sample string 20</DSMWorkOrderCode><DayNumber>1</DayNumber><Duration>sample string 4</Duration><EndDate>2024-06-29T07:39:30.3252802+10:00</EndDate><ExpectedEndDate>2024-06-29T07:39:30.3252802+10:00</ExpectedEndDate><ExpectedEndTime>sample string 5</ExpectedEndTime><ExpectedStartDate>2024-06-29T07:39:30.3252802+10:00</ExpectedStartDate><ExpectedStartTime>sample string 6</ExpectedStartTime><FulfilmentDue>2024-06-29T07:39:30.3252802+10:00</FulfilmentDue><Fullname>sample string 7</Fullname><IsAllDay>true</IsAllDay><IsClientSubmitted>true</IsClientSubmitted><IsUpdateLocked>true</IsUpdateLocked><LastUpdatedOn>2024-06-29T07:39:30.3252802+10:00</LastUpdatedOn><MlApplicantStatusCode>sample string 8</MlApplicantStatusCode><MlLineItemStatusCode>sample string 9</MlLineItemStatusCode><MlOrderStatusCode>sample string 10</MlOrderStatusCode><Month>1</Month><OccurenceCount>1</OccurenceCount><OrderId>11</OrderId><OrderLineItemId>12</OrderLineItemId><OrderRequestCode>sample string 13</OrderRequestCode><OrderRequestDate>2024-06-29T07:39:30.3252802+10:00</OrderRequestDate><OrderRequestId>14</OrderRequestId><OrderType>sample string 19</OrderType><OriginalPositionsRequested>1</OriginalPositionsRequested><Periodicity>sample string 15</Periodicity><PrimarySiteId>1</PrimarySiteId><PurchaseOrder>sample string 18</PurchaseOrder><Range>1</Range><ReferenceClientContactId>1</ReferenceClientContactId><ShiftPatternId>1</ShiftPatternId><SiteAddress>sample string 16</SiteAddress><StartDate>2024-06-29T07:39:30.3252802+10:00</StartDate><Type>1</Type><WeekDays>1</WeekDays><WeekNumber>1</WeekNumber><WeekOfMonth>1</WeekOfMonth><isPOMandatory>true</isPOMandatory></OrderItem><OrderItem><ActualJobTitle>sample string 1</ActualJobTitle><ApplicantId>1</ApplicantId><CalendarAppointmentRecurrenceId>1</CalendarAppointmentRecurrenceId><CalledInBy>sample string 2</CalledInBy><CandidateCode>sample string 22</CandidateCode><CandidateId>21</CandidateId><ClientContactName>sample string 3</ClientContactName><CostCentre>sample string 17</CostCentre><CreatedOn>2024-06-29T07:39:30.3252802+10:00</CreatedOn><DSMWorkOrderCode>sample string 20</DSMWorkOrderCode><DayNumber>1</DayNumber><Duration>sample string 4</Duration><EndDate>2024-06-29T07:39:30.3252802+10:00</EndDate><ExpectedEndDate>2024-06-29T07:39:30.3252802+10:00</ExpectedEndDate><ExpectedEndTime>sample string 5</ExpectedEndTime><ExpectedStartDate>2024-06-29T07:39:30.3252802+10:00</ExpectedStartDate><ExpectedStartTime>sample string 6</ExpectedStartTime><FulfilmentDue>2024-06-29T07:39:30.3252802+10:00</FulfilmentDue><Fullname>sample string 7</Fullname><IsAllDay>true</IsAllDay><IsClientSubmitted>true</IsClientSubmitted><IsUpdateLocked>true</IsUpdateLocked><LastUpdatedOn>2024-06-29T07:39:30.3252802+10:00</LastUpdatedOn><MlApplicantStatusCode>sample string 8</MlApplicantStatusCode><MlLineItemStatusCode>sample string 9</MlLineItemStatusCode><MlOrderStatusCode>sample string 10</MlOrderStatusCode><Month>1</Month><OccurenceCount>1</OccurenceCount><OrderId>11</OrderId><OrderLineItemId>12</OrderLineItemId><OrderRequestCode>sample string 13</OrderRequestCode><OrderRequestDate>2024-06-29T07:39:30.3252802+10:00</OrderRequestDate><OrderRequestId>14</OrderRequestId><OrderType>sample string 19</OrderType><OriginalPositionsRequested>1</OriginalPositionsRequested><Periodicity>sample string 15</Periodicity><PrimarySiteId>1</PrimarySiteId><PurchaseOrder>sample string 18</PurchaseOrder><Range>1</Range><ReferenceClientContactId>1</ReferenceClientContactId><ShiftPatternId>1</ShiftPatternId><SiteAddress>sample string 16</SiteAddress><StartDate>2024-06-29T07:39:30.3252802+10:00</StartDate><Type>1</Type><WeekDays>1</WeekDays><WeekNumber>1</WeekNumber><WeekOfMonth>1</WeekOfMonth><isPOMandatory>true</isPOMandatory></OrderItem></OrderItems></VacancyDetail>