POST api/Order/{id}/Vacancy

Used for creating a new vacancy for an order

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required

Body Parameters

NewVacancyDTO

Name	Type	Additional information
ShiftModel	ShiftModel	None.
ClientAgencyId	integer	None.
ClientContactAgencyId	integer	None.
OrderId	string	None.
SupplierIds	Collection of integer	None.
IsIndigenousPreferred	boolean	None.
CustomCodes	Collection of CustomCode	None.
IsSelectPreferredCandidates	boolean	None.
IsComplianceDocumentsRequired	boolean	None.
ComplianceDocumentsDescription	string	None.

Request Formats

application/json, text/json

Sample:

{
  "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-28T22:15:07.7938448+10:00",
    "EndDate": "2024-06-28T22:15:07.7938448+10:00",
    "StartTime": "sample string 6",
    "EndTime": "sample string 7",
    "Site": "sample string 8",
    "FulfilmentDue": "2024-06-28T22:15:07.7948459+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"
  },
  "ClientAgencyId": 1,
  "ClientContactAgencyId": 2,
  "OrderId": "sample string 3",
  "SupplierIds": [
    1,
    2
  ],
  "IsIndigenousPreferred": true,
  "CustomCodes": [
    {
      "CustomCodeCategoryValueId": 1,
      "CategoryCode": "sample string 1",
      "Code": "sample string 2",
      "Value": "sample string 3",
      "Description": "sample string 4"
    },
    {
      "CustomCodeCategoryValueId": 1,
      "CategoryCode": "sample string 1",
      "Code": "sample string 2",
      "Value": "sample string 3",
      "Description": "sample string 4"
    }
  ],
  "IsSelectPreferredCandidates": true,
  "IsComplianceDocumentsRequired": true,
  "ComplianceDocumentsDescription": "sample string 7"
}

text/xml

Sample:

<NewVacancyDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO">
  <ClientAgencyId>1</ClientAgencyId>
  <ClientContactAgencyId>2</ClientContactAgencyId>
  <ComplianceDocumentsDescription>sample string 7</ComplianceDocumentsDescription>
  <CustomCodes xmlns:d2p1="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models">
    <d2p1:CustomCode>
      <d2p1:CategoryCode>sample string 1</d2p1:CategoryCode>
      <d2p1:Code>sample string 2</d2p1:Code>
      <d2p1:CustomCodeCategoryValueId>1</d2p1:CustomCodeCategoryValueId>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:CustomCode>
    <d2p1:CustomCode>
      <d2p1:CategoryCode>sample string 1</d2p1:CategoryCode>
      <d2p1:Code>sample string 2</d2p1:Code>
      <d2p1:CustomCodeCategoryValueId>1</d2p1:CustomCodeCategoryValueId>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:CustomCode>
  </CustomCodes>
  <IsComplianceDocumentsRequired>true</IsComplianceDocumentsRequired>
  <IsIndigenousPreferred>true</IsIndigenousPreferred>
  <IsSelectPreferredCandidates>true</IsSelectPreferredCandidates>
  <OrderId>sample string 3</OrderId>
  <SupplierIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SupplierIds>
</NewVacancyDTO>

multipart/form-data

Sample:

<NewVacancyDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><ClientAgencyId>1</ClientAgencyId><ClientContactAgencyId>2</ClientContactAgencyId><ComplianceDocumentsDescription>sample string 7</ComplianceDocumentsDescription><CustomCodes xmlns:d2p1="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models"><d2p1:CustomCode><d2p1:CategoryCode>sample string 1</d2p1:CategoryCode><d2p1:Code>sample string 2</d2p1:Code><d2p1:CustomCodeCategoryValueId>1</d2p1:CustomCodeCategoryValueId><d2p1:Description>sample string 4</d2p1:Description><d2p1:Value>sample string 3</d2p1:Value></d2p1:CustomCode><d2p1:CustomCode><d2p1:CategoryCode>sample string 1</d2p1:CategoryCode><d2p1:Code>sample string 2</d2p1:Code><d2p1:CustomCodeCategoryValueId>1</d2p1:CustomCodeCategoryValueId><d2p1:Description>sample string 4</d2p1:Description><d2p1:Value>sample string 3</d2p1:Value></d2p1:CustomCode></CustomCodes><IsComplianceDocumentsRequired>true</IsComplianceDocumentsRequired><IsIndigenousPreferred>true</IsIndigenousPreferred><IsSelectPreferredCandidates>true</IsSelectPreferredCandidates><OrderId>sample string 3</OrderId><SupplierIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:int>1</d2p1:int><d2p1:int>2</d2p1:int></SupplierIds></NewVacancyDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

JsonResponse

Name	Type	Additional information
Success	boolean	None.
ErrorMessage	Collection of string	None.
EntityId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "EntityId": 1,
  "Success": true
}

text/xml

Sample:

<JsonResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models">
  <EntityId>1</EntityId>
  <ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorMessage>
  <Success>true</Success>
</JsonResponse>

multipart/form-data

Sample:

<JsonResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models"><EntityId>1</EntityId><ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>sample string 1</d2p1:string><d2p1:string>sample string 2</d2p1:string></ErrorMessage><Success>true</Success></JsonResponse>