GET api/DSM/ShiftRequest/{shiftRequestCode}/ShiftPreference
Used to get ShiftPreferences
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
shiftRequestCode |
Code of ShiftRequest which is used to get ShiftPreference |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
ShiftPreferenceName | Description | Type | Additional information |
---|---|---|---|
ShiftProcessStatus |
This is ShiftProcessStatus |
string |
None. |
PreferenceType |
This is PreferenceType |
string |
None. |
AllAvailablePreferredCandidates |
This is PreferredCandidates |
Collection of PreferredCandidate |
None. |
DelayMinutes |
This is Delay Minutes |
integer |
None. |
SelectedPreferredCandidates |
This is SelectedPreferredCandidates |
Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ShiftProcessStatus": "sample string 1", "PreferenceType": "sample string 2", "AllAvailablePreferredCandidates": [ { "Name": "sample string 1", "Qualifications": [ "sample string 1", "sample string 2" ], "ExternalCandidateCode": "sample string 2" }, { "Name": "sample string 1", "Qualifications": [ "sample string 1", "sample string 2" ], "ExternalCandidateCode": "sample string 2" } ], "DelayMinutes": 3, "SelectedPreferredCandidates": [ "sample string 1", "sample string 2" ] }
text/xml
Sample:
<ShiftPreference xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DSM"> <AllAvailablePreferredCandidates> <PreferredCandidate> <ExternalCandidateCode>sample string 2</ExternalCandidateCode> <Name>sample string 1</Name> <Qualifications xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Qualifications> </PreferredCandidate> <PreferredCandidate> <ExternalCandidateCode>sample string 2</ExternalCandidateCode> <Name>sample string 1</Name> <Qualifications xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Qualifications> </PreferredCandidate> </AllAvailablePreferredCandidates> <DelayMinutes>3</DelayMinutes> <PreferenceType>sample string 2</PreferenceType> <SelectedPreferredCandidates xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </SelectedPreferredCandidates> <ShiftProcessStatus>sample string 1</ShiftProcessStatus> </ShiftPreference>
multipart/form-data
Sample:
<ShiftPreference xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DSM"><AllAvailablePreferredCandidates><PreferredCandidate><ExternalCandidateCode>sample string 2</ExternalCandidateCode><Name>sample string 1</Name><Qualifications xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d4p1:string>sample string 1</d4p1:string><d4p1:string>sample string 2</d4p1:string></Qualifications></PreferredCandidate><PreferredCandidate><ExternalCandidateCode>sample string 2</ExternalCandidateCode><Name>sample string 1</Name><Qualifications xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d4p1:string>sample string 1</d4p1:string><d4p1:string>sample string 2</d4p1:string></Qualifications></PreferredCandidate></AllAvailablePreferredCandidates><DelayMinutes>3</DelayMinutes><PreferenceType>sample string 2</PreferenceType><SelectedPreferredCandidates xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>sample string 1</d2p1:string><d2p1:string>sample string 2</d2p1:string></SelectedPreferredCandidates><ShiftProcessStatus>sample string 1</ShiftProcessStatus></ShiftPreference>