POST api/Candidates/CVDistribution

Used to Get the CVDistribution data for Candidate Search.

Request Information

URI Parameters

None.

Body Parameters

SearchInputData
NameDescriptionTypeAdditional information
SearchType

This holds the SearchType

SearchType

None.

BranchIdCSV

This holds the BranchId CSV based on the what user selects.

string

None.

DivisionIdCSV

This holds the division of the BranchCSV selected by the User

string

None.

ConsultantIdCSV

This holds the consultant ids.

string

None.

IncludeInActiveCandidates

This holds whether the user need InActive Candidates

boolean

None.

CVLocation

This holds the location selected by the user.

string

None.

CVCustomQuery

This holds the CSV/Custom Query user inputs.

string

None.

CVSkills

This holds the BGSkills user has selected.

string

None.

CVJobTitles

This holds the BGJobtitles user has selected

string

None.

CVIndustries

This holds the BGIndustries user has selected

string

None.

CVLicenses

This holds the BGIndustries user has selected

string

None.

CVResumeUpdated

This holds the ResumeUpdateDate code

string

None.

CVLastContacted

This holds the LastContactDate code

string

None.

CVFreshness

This holds the FreshnessDate code

string

None.

CVCandidateStatus

This holds the csv of Candidate Status.

string

None.

YearsOfExp

This holds the YearsOfExp code.

string

None.

Suburb

This holds the Suburb of the Resides in field.

string

None.

State

This holds the State of the Resides in field.

string

None.

Country

This holds the Country of the Resides in field.

string

None.

MFrontSkills

This holds the MFront Skills user chooses

string

None.

MFrontJobTitles

This holds the MFront JobTitles user chooses.

string

None.

MFrontCandidateStatus

This holds the MFront CandidateStatus user chooses.

string

None.

StaticListIdCSV

This holds the MFront StaticListIds user chooses.

string

None.

TempSalaryFrom

This holds the MFront Temp Salary From

string

None.

TempSalaryTo

This holds the MFront Temp Salary To

string

None.

TempSalaryType

This holds the MFront Temp Salary Type

string

None.

PermSalaryFrom

This holds the MFront Perm Salary From

string

None.

PermSalaryTo

This holds the MFront Perm Salary To

string

None.

PermSalaryType

This holds the MFront Perm Salary Type

string

None.

MFrontKeywordSearch

This holds the MFront keyword custom query entered by the user.

string

None.

PostalCode

This holds the Postal Code selected by the user.

string

None.

DistanceInKms

This holds the DistinctInKms user for Radius based on the PostCode field.

string

None.

PersonalityId

This holds the MFront PersonalityId

integer

None.

NoOfSearchResult

This holds the No of Search Results that needs to be returned.

integer

None.

CVWhiteBoard

This holds the keyword/custom query than needs to be search within the CVWhiteBoard.

string

None.

SearchEntireCV

This holds the boolean to search within recent two jobbs

boolean

None.

JobTitlesSearchedWithIn

This holds the value to search jobtitle within recent job, first two jobs or entire cv. The values should be 1,2,0 respectively.

integer

None.

SkillsSearchedWithIn

This holds the value to search skills within recent job, first two jobs or entire cv. The values should be 1,2,0 respectively.

integer

None.

KeywordsSearchedWithIn

This holds the value to search keywords within recent job, first two jobs or entire cv. The values should be 1,2,0 respectively.

integer

None.

ExcludeKeywords

This holds the value to exculde the keywords while searching.

string

None.

LicenseExpiry

This holds the LicenseExpiryCode.

string

None.

MFrontFilterDataList

This holds the MFront distribution filters selected by the user.

Collection of FilterData

None.

CVFilterDataList

This holds the CV distribution filters selected by the user.

Collection of FilterData

None.

TrackingID

This holds the Search TrackingID

string

None.

JobDescriptionHtml

This holds the JobDesciotion HTML text

string

None.

JobDescriptionOriginalText

This holds the JobDescriptionOriginalText

string

None.

OrderCode

This hold the OrderCode for matching candidates

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SearchType": "CV",
  "BranchIdCSV": "sample string 1",
  "DivisionIdCSV": "sample string 2",
  "ConsultantIdCSV": "sample string 3",
  "IncludeInActiveCandidates": true,
  "CVLocation": "sample string 5",
  "CVCustomQuery": "sample string 6",
  "CVSkills": "sample string 7",
  "CVJobTitles": "sample string 8",
  "CVIndustries": "sample string 9",
  "CVLicenses": "sample string 10",
  "CVResumeUpdated": "sample string 11",
  "CVLastContacted": "sample string 12",
  "CVFreshness": "sample string 13",
  "CVCandidateStatus": "sample string 14",
  "YearsOfExp": "sample string 15",
  "Suburb": "sample string 16",
  "State": "sample string 17",
  "Country": "sample string 18",
  "MFrontSkills": "sample string 19",
  "MFrontJobTitles": "sample string 20",
  "MFrontCandidateStatus": "sample string 21",
  "StaticListIdCSV": "sample string 22",
  "TempSalaryFrom": "sample string 23",
  "TempSalaryTo": "sample string 24",
  "TempSalaryType": "sample string 25",
  "PermSalaryFrom": "sample string 26",
  "PermSalaryTo": "sample string 27",
  "PermSalaryType": "sample string 28",
  "MFrontKeywordSearch": "sample string 29",
  "PostalCode": "sample string 30",
  "DistanceInKms": "sample string 31",
  "PersonalityId": 32,
  "NoOfSearchResult": 33,
  "CVWhiteBoard": "sample string 34",
  "SearchEntireCV": true,
  "JobTitlesSearchedWithIn": 36,
  "SkillsSearchedWithIn": 37,
  "KeywordsSearchedWithIn": 38,
  "ExcludeKeywords": "sample string 39",
  "LicenseExpiry": "sample string 40",
  "MFrontFilterDataList": [
    {
      "Code": "sample string 1",
      "ValueCSV": "sample string 2",
      "Count": "sample string 3",
      "IsFilterListRequired": true
    },
    {
      "Code": "sample string 1",
      "ValueCSV": "sample string 2",
      "Count": "sample string 3",
      "IsFilterListRequired": true
    }
  ],
  "CVFilterDataList": [
    {
      "Code": "sample string 1",
      "ValueCSV": "sample string 2",
      "Count": "sample string 3",
      "IsFilterListRequired": true
    },
    {
      "Code": "sample string 1",
      "ValueCSV": "sample string 2",
      "Count": "sample string 3",
      "IsFilterListRequired": true
    }
  ],
  "TrackingID": "sample string 41",
  "JobDescriptionHtml": "sample string 42",
  "JobDescriptionOriginalText": "sample string 43",
  "OrderCode": "sample string 44"
}

text/xml

Sample:
<SearchInputData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models">
  <BranchIdCSV>sample string 1</BranchIdCSV>
  <CVCandidateStatus>sample string 14</CVCandidateStatus>
  <CVCustomQuery>sample string 6</CVCustomQuery>
  <CVFilterDataList>
    <FilterData>
      <Code>sample string 1</Code>
      <Count>sample string 3</Count>
      <IsFilterListRequired>true</IsFilterListRequired>
      <ValueCSV>sample string 2</ValueCSV>
    </FilterData>
    <FilterData>
      <Code>sample string 1</Code>
      <Count>sample string 3</Count>
      <IsFilterListRequired>true</IsFilterListRequired>
      <ValueCSV>sample string 2</ValueCSV>
    </FilterData>
  </CVFilterDataList>
  <CVFreshness>sample string 13</CVFreshness>
  <CVIndustries>sample string 9</CVIndustries>
  <CVJobTitles>sample string 8</CVJobTitles>
  <CVLastContacted>sample string 12</CVLastContacted>
  <CVLicenses>sample string 10</CVLicenses>
  <CVLocation>sample string 5</CVLocation>
  <CVResumeUpdated>sample string 11</CVResumeUpdated>
  <CVSkills>sample string 7</CVSkills>
  <CVWhiteBoard>sample string 34</CVWhiteBoard>
  <ConsultantIdCSV>sample string 3</ConsultantIdCSV>
  <Country>sample string 18</Country>
  <DistanceInKms>sample string 31</DistanceInKms>
  <DivisionIdCSV>sample string 2</DivisionIdCSV>
  <ExcludeKeywords>sample string 39</ExcludeKeywords>
  <IncludeInActiveCandidates>true</IncludeInActiveCandidates>
  <JobDescriptionHtml>sample string 42</JobDescriptionHtml>
  <JobDescriptionOriginalText>sample string 43</JobDescriptionOriginalText>
  <JobTitlesSearchedWithIn>36</JobTitlesSearchedWithIn>
  <KeywordsSearchedWithIn>38</KeywordsSearchedWithIn>
  <LicenseExpiry>sample string 40</LicenseExpiry>
  <MFrontCandidateStatus>sample string 21</MFrontCandidateStatus>
  <MFrontFilterDataList>
    <FilterData>
      <Code>sample string 1</Code>
      <Count>sample string 3</Count>
      <IsFilterListRequired>true</IsFilterListRequired>
      <ValueCSV>sample string 2</ValueCSV>
    </FilterData>
    <FilterData>
      <Code>sample string 1</Code>
      <Count>sample string 3</Count>
      <IsFilterListRequired>true</IsFilterListRequired>
      <ValueCSV>sample string 2</ValueCSV>
    </FilterData>
  </MFrontFilterDataList>
  <MFrontJobTitles>sample string 20</MFrontJobTitles>
  <MFrontKeywordSearch>sample string 29</MFrontKeywordSearch>
  <MFrontSkills>sample string 19</MFrontSkills>
  <NoOfSearchResult>33</NoOfSearchResult>
  <OrderCode>sample string 44</OrderCode>
  <PermSalaryFrom>sample string 26</PermSalaryFrom>
  <PermSalaryTo>sample string 27</PermSalaryTo>
  <PermSalaryType>sample string 28</PermSalaryType>
  <PersonalityId>32</PersonalityId>
  <PostalCode>sample string 30</PostalCode>
  <SearchEntireCV>true</SearchEntireCV>
  <SearchType>CV</SearchType>
  <SkillsSearchedWithIn>37</SkillsSearchedWithIn>
  <State>sample string 17</State>
  <StaticListIdCSV>sample string 22</StaticListIdCSV>
  <Suburb>sample string 16</Suburb>
  <TempSalaryFrom>sample string 23</TempSalaryFrom>
  <TempSalaryTo>sample string 24</TempSalaryTo>
  <TempSalaryType>sample string 25</TempSalaryType>
  <TrackingID>sample string 41</TrackingID>
  <YearsOfExp>sample string 15</YearsOfExp>
</SearchInputData>

multipart/form-data

Sample:
<SearchInputData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models"><BranchIdCSV>sample string 1</BranchIdCSV><CVCandidateStatus>sample string 14</CVCandidateStatus><CVCustomQuery>sample string 6</CVCustomQuery><CVFilterDataList><FilterData><Code>sample string 1</Code><Count>sample string 3</Count><IsFilterListRequired>true</IsFilterListRequired><ValueCSV>sample string 2</ValueCSV></FilterData><FilterData><Code>sample string 1</Code><Count>sample string 3</Count><IsFilterListRequired>true</IsFilterListRequired><ValueCSV>sample string 2</ValueCSV></FilterData></CVFilterDataList><CVFreshness>sample string 13</CVFreshness><CVIndustries>sample string 9</CVIndustries><CVJobTitles>sample string 8</CVJobTitles><CVLastContacted>sample string 12</CVLastContacted><CVLicenses>sample string 10</CVLicenses><CVLocation>sample string 5</CVLocation><CVResumeUpdated>sample string 11</CVResumeUpdated><CVSkills>sample string 7</CVSkills><CVWhiteBoard>sample string 34</CVWhiteBoard><ConsultantIdCSV>sample string 3</ConsultantIdCSV><Country>sample string 18</Country><DistanceInKms>sample string 31</DistanceInKms><DivisionIdCSV>sample string 2</DivisionIdCSV><ExcludeKeywords>sample string 39</ExcludeKeywords><IncludeInActiveCandidates>true</IncludeInActiveCandidates><JobDescriptionHtml>sample string 42</JobDescriptionHtml><JobDescriptionOriginalText>sample string 43</JobDescriptionOriginalText><JobTitlesSearchedWithIn>36</JobTitlesSearchedWithIn><KeywordsSearchedWithIn>38</KeywordsSearchedWithIn><LicenseExpiry>sample string 40</LicenseExpiry><MFrontCandidateStatus>sample string 21</MFrontCandidateStatus><MFrontFilterDataList><FilterData><Code>sample string 1</Code><Count>sample string 3</Count><IsFilterListRequired>true</IsFilterListRequired><ValueCSV>sample string 2</ValueCSV></FilterData><FilterData><Code>sample string 1</Code><Count>sample string 3</Count><IsFilterListRequired>true</IsFilterListRequired><ValueCSV>sample string 2</ValueCSV></FilterData></MFrontFilterDataList><MFrontJobTitles>sample string 20</MFrontJobTitles><MFrontKeywordSearch>sample string 29</MFrontKeywordSearch><MFrontSkills>sample string 19</MFrontSkills><NoOfSearchResult>33</NoOfSearchResult><OrderCode>sample string 44</OrderCode><PermSalaryFrom>sample string 26</PermSalaryFrom><PermSalaryTo>sample string 27</PermSalaryTo><PermSalaryType>sample string 28</PermSalaryType><PersonalityId>32</PersonalityId><PostalCode>sample string 30</PostalCode><SearchEntireCV>true</SearchEntireCV><SearchType>CV</SearchType><SkillsSearchedWithIn>37</SkillsSearchedWithIn><State>sample string 17</State><StaticListIdCSV>sample string 22</StaticListIdCSV><Suburb>sample string 16</Suburb><TempSalaryFrom>sample string 23</TempSalaryFrom><TempSalaryTo>sample string 24</TempSalaryTo><TempSalaryType>sample string 25</TempSalaryType><TrackingID>sample string 41</TrackingID><YearsOfExp>sample string 15</YearsOfExp></SearchInputData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

COMPLETE

Collection of CVDistributionDO
NameDescriptionTypeAdditional information
Code

string

None.

Name

string

None.

Count

string

None.

TotalDistributions

string

None.

DistributionDOList

Collection of DistributionDO

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Code": "sample string 1",
    "Name": "sample string 2",
    "Count": "sample string 3",
    "TotalDistributions": "sample string 4",
    "DistributionDOList": [
      {
        "Code": "sample string 1",
        "Name": "sample string 2",
        "Count": 3
      },
      {
        "Code": "sample string 1",
        "Name": "sample string 2",
        "Count": 3
      }
    ]
  },
  {
    "Code": "sample string 1",
    "Name": "sample string 2",
    "Count": "sample string 3",
    "TotalDistributions": "sample string 4",
    "DistributionDOList": [
      {
        "Code": "sample string 1",
        "Name": "sample string 2",
        "Count": 3
      },
      {
        "Code": "sample string 1",
        "Name": "sample string 2",
        "Count": 3
      }
    ]
  }
]

text/xml

Sample:
<ArrayOfCVDistributionDO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models">
  <CVDistributionDO>
    <Code>sample string 1</Code>
    <Count>sample string 3</Count>
    <DistributionDOList>
      <DistributionDO>
        <Code>sample string 1</Code>
        <Count>3</Count>
        <Name>sample string 2</Name>
      </DistributionDO>
      <DistributionDO>
        <Code>sample string 1</Code>
        <Count>3</Count>
        <Name>sample string 2</Name>
      </DistributionDO>
    </DistributionDOList>
    <Name>sample string 2</Name>
    <TotalDistributions>sample string 4</TotalDistributions>
  </CVDistributionDO>
  <CVDistributionDO>
    <Code>sample string 1</Code>
    <Count>sample string 3</Count>
    <DistributionDOList>
      <DistributionDO>
        <Code>sample string 1</Code>
        <Count>3</Count>
        <Name>sample string 2</Name>
      </DistributionDO>
      <DistributionDO>
        <Code>sample string 1</Code>
        <Count>3</Count>
        <Name>sample string 2</Name>
      </DistributionDO>
    </DistributionDOList>
    <Name>sample string 2</Name>
    <TotalDistributions>sample string 4</TotalDistributions>
  </CVDistributionDO>
</ArrayOfCVDistributionDO>

multipart/form-data

Sample:
<ArrayOfCVDistributionDO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models"><CVDistributionDO><Code>sample string 1</Code><Count>sample string 3</Count><DistributionDOList><DistributionDO><Code>sample string 1</Code><Count>3</Count><Name>sample string 2</Name></DistributionDO><DistributionDO><Code>sample string 1</Code><Count>3</Count><Name>sample string 2</Name></DistributionDO></DistributionDOList><Name>sample string 2</Name><TotalDistributions>sample string 4</TotalDistributions></CVDistributionDO><CVDistributionDO><Code>sample string 1</Code><Count>sample string 3</Count><DistributionDOList><DistributionDO><Code>sample string 1</Code><Count>3</Count><Name>sample string 2</Name></DistributionDO><DistributionDO><Code>sample string 1</Code><Count>3</Count><Name>sample string 2</Name></DistributionDO></DistributionDOList><Name>sample string 2</Name><TotalDistributions>sample string 4</TotalDistributions></CVDistributionDO></ArrayOfCVDistributionDO>