POST api/v1/candidates/{candidateUid}/availability?overlap={overlap}

Creates the candidate availability.

Request Information

URI Parameters

Name	Description	Type	Additional information
candidateUid	The candidate UID.	globally unique identifier	Required
overlap	Allow overlapping events	boolean	Default value is False

Body Parameters

The candidate availability.

CandidateAvailability

Name	Description	Type	Additional information
DiaryType	The type of the diary.	globally unique identifier	Required
Summary	The diary summary.	string	Required String length: inclusive between 0 and 100
Description	The diary description.	string	String length: inclusive between 0 and 255
Start	The start date/time.	date	Required
End	The end date/time.	date	None.

Request Formats

application/json, text/json

Sample:

{
  "DiaryType": "f45ec3c0-3d5c-4a3b-8fe6-59bbfff28b9a",
  "Summary": "sample string 2",
  "Description": "sample string 3",
  "Start": "2025-12-21T17:52:52.9285629+00:00",
  "End": "2025-12-21T17:52:52.9285629+00:00"
}

application/xml, text/xml

Sample:

<CandidateAvailability xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <Description>sample string 3</Description>
  <DiaryType>f45ec3c0-3d5c-4a3b-8fe6-59bbfff28b9a</DiaryType>
  <End>2025-12-21T17:52:52.9285629+00:00</End>
  <Start>2025-12-21T17:52:52.9285629+00:00</Start>
  <Summary>sample string 2</Summary>
</CandidateAvailability>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the created candidate availability item.

CandidateAvailabilityViewModel

Name	Description	Type	Additional information
Candidate	The candidate.	CandidateViewModel	None.
DiaryType	The type of the diary.	DiaryTypeViewModel	None.
Summary	The summary.	string	None.
Description	The description.	string	None.
Start	The start.	date	None.
End	The end.	date	None.
CandidateAvailabilityGuid	Unique, unchanging identifier representing this objct	globally unique identifier	None.
Uid	The GUID.	globally unique identifier	None.
Links	The links.	Collection of Link	None.
DateUpdated	Last time the record was updated	date	None.
UpdatedBy	Who updated the record last	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Candidate": {
    "Title": "sample string 1",
    "Forename": "sample string 2",
    "Surname": "sample string 3",
    "OtherNames": "sample string 4",
    "AddressLine1": "sample string 5",
    "AddressLine2": "sample string 6",
    "AddressLine3": "sample string 7",
    "AddressLine4": "sample string 8",
    "PostCode": "sample string 9",
    "Country": "sample string 10",
    "Telephone": "sample string 11",
    "Mobile": "sample string 12",
    "Email": "sample string 13",
    "Position": "sample string 14",
    "Term": "sample string 15",
    "EarliestStartDate": "2025-12-21T17:52:52.9285629+00:00",
    "Company": {
      "Name": "sample string 1",
      "AddressLine1": "sample string 2",
      "AddressLine2": "sample string 3",
      "AddressLine3": "sample string 4",
      "AddressLine4": "sample string 5",
      "PostCode": "sample string 6",
      "Country": {
        "Iso3Code": "sample string 1",
        "Name": "sample string 2",
        "Portal": {
          "Name": "sample string 1",
          "Uid": "c4c52067-e2a4-4e1a-bb1b-7a67abe2f689",
          "Links": [
            {
              "Href": "http://webapihelppage1.com",
              "Method": "sample string 2",
              "Rel": "sample string 3",
              "Title": "sample string 4",
              "Type": "sample string 5"
            },
            {
              "Href": "http://webapihelppage1.com",
              "Method": "sample string 2",
              "Rel": "sample string 3",
              "Title": "sample string 4",
              "Type": "sample string 5"
            }
          ],
          "DateUpdated": "2025-12-21T17:52:52.9285629+00:00",
          "UpdatedBy": "sample string 3"
        },
        "CountryGuid": "139a8da9-d902-4124-af59-d7e5123531f9",
        "Uid": "c2d4ff4c-d6fc-4560-9828-fedafa008080",
        "Links": [
          {
            "Href": "http://webapihelppage1.com",
            "Method": "sample string 2",
            "Rel": "sample string 3",
            "Title": "sample string 4",
            "Type": "sample string 5"
          },
          {
            "Href": "http://webapihelppage1.com",
            "Method": "sample string 2",
            "Rel": "sample string 3",
            "Title": "sample string 4",
            "Type": "sample string 5"
          }
        ],
        "DateUpdated": "2025-12-21T17:52:52.9285629+00:00",
        "UpdatedBy": "sample string 5"
      },
      "Latitude": "sample string 7",
      "Longitude": "sample string 8",
      "PortalUid": "6bb735e4-9d04-412a-ac26-f9c4d19c376b",
      "PortalGuid": "b2c64668-307a-403a-a2ec-56905ca2b086",
      "CompanyGuid": "ec6ea154-673f-4028-94c9-99498e84635a",
      "Uid": "7bd946f9-7414-4f68-acaf-234923e3e6d1",
      "Links": [
        {
          "Href": "http://webapihelppage1.com",
          "Method": "sample string 2",
          "Rel": "sample string 3",
          "Title": "sample string 4",
          "Type": "sample string 5"
        },
        {
          "Href": "http://webapihelppage1.com",
          "Method": "sample string 2",
          "Rel": "sample string 3",
          "Title": "sample string 4",
          "Type": "sample string 5"
        }
      ],
      "DateUpdated": "2025-12-21T17:52:52.9285629+00:00",
      "UpdatedBy": "sample string 13"
    },
    "ReferenceNumber": "sample string 16",
    "PrimaryIndustry": "sample string 17",
    "PrimaryDiscipline": "sample string 18",
    "PrimarySubDiscipline": "sample string 19",
    "IsPrimaryIndustryDiscipline": true,
    "PersonalStatement": "sample string 21",
    "Latitude": 1.1,
    "Longitude": 1.1,
    "ReferralSource": "sample string 22",
    "Gender": "sample string 23",
    "Location": "sample string 24",
    "Area": "sample string 25",
    "Region": "sample string 26",
    "EclipseStatus": "sample string 27",
    "EclipseLastUpdated": "2025-12-21T17:52:52.9285629+00:00",
    "ComplianceExpires": "2025-12-21T17:52:52.9285629+00:00",
    "CandidateGuid": "6a113da3-f3f7-474d-9a4e-027b1f00c1f7",
    "DateOfBirth": "2025-12-21T17:52:52.9285629+00:00",
    "Nationality": "sample string 29",
    "EmploymentSought": "sample string 30",
    "MinAnnualSalary": 31.1,
    "MaxAnnualSalary": 32.1,
    "MinHourlyPayrate": 33.1,
    "MaxHourlyPayrate": 34.1,
    "Uid": "8f730e19-4dd9-4015-aac7-a47fa28f885a",
    "Links": [
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      },
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      }
    ],
    "DateUpdated": "2025-12-21T17:52:52.9285629+00:00",
    "UpdatedBy": "sample string 36"
  },
  "DiaryType": {
    "Name": "sample string 1",
    "DiaryTypeGuid": "2a059ab1-9aea-439b-beea-385345d998c1",
    "Category": {
      "Name": "sample string 1",
      "IsAvailable": true,
      "Uid": "94795c85-143d-4bd3-845d-688ea63bb7cb",
      "Links": [
        {
          "Href": "http://webapihelppage1.com",
          "Method": "sample string 2",
          "Rel": "sample string 3",
          "Title": "sample string 4",
          "Type": "sample string 5"
        },
        {
          "Href": "http://webapihelppage1.com",
          "Method": "sample string 2",
          "Rel": "sample string 3",
          "Title": "sample string 4",
          "Type": "sample string 5"
        }
      ],
      "DateUpdated": "2025-12-21T17:52:52.9285629+00:00",
      "UpdatedBy": "sample string 4"
    },
    "Uid": "e4ba7f46-3b84-4e70-a242-8baa81f289df",
    "Links": [
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      },
      {
        "Href": "http://webapihelppage1.com",
        "Method": "sample string 2",
        "Rel": "sample string 3",
        "Title": "sample string 4",
        "Type": "sample string 5"
      }
    ],
    "DateUpdated": "2025-12-21T17:52:52.9285629+00:00",
    "UpdatedBy": "sample string 4"
  },
  "Summary": "sample string 1",
  "Description": "sample string 2",
  "Start": "2025-12-21T17:52:52.9285629+00:00",
  "End": "2025-12-21T17:52:52.9285629+00:00",
  "CandidateAvailabilityGuid": "487404ad-f21a-4714-a59a-08576f1cc2ef",
  "Uid": "d497563b-44f9-4ba0-acec-7daba841fb11",
  "Links": [
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    },
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    }
  ],
  "DateUpdated": "2025-12-21T17:52:52.9285629+00:00",
  "UpdatedBy": "sample string 7"
}

application/xml, text/xml

Sample:

<CandidateAvailabilityViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-12-21T17:52:52.9285629+00:00</DateUpdated>
  <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
  </Links>
  <Uid>d497563b-44f9-4ba0-acec-7daba841fb11</Uid>
  <UpdatedBy>sample string 7</UpdatedBy>
  <Candidate>
    <DateUpdated>2025-12-21T17:52:52.9285629+00:00</DateUpdated>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
    </Links>
    <Uid>8f730e19-4dd9-4015-aac7-a47fa28f885a</Uid>
    <UpdatedBy>sample string 36</UpdatedBy>
    <AddressLine1>sample string 5</AddressLine1>
    <AddressLine2>sample string 6</AddressLine2>
    <AddressLine3>sample string 7</AddressLine3>
    <AddressLine4>sample string 8</AddressLine4>
    <Area>sample string 25</Area>
    <CandidateGuid>6a113da3-f3f7-474d-9a4e-027b1f00c1f7</CandidateGuid>
    <Company>
      <DateUpdated>2025-12-21T17:52:52.9285629+00:00</DateUpdated>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
      </Links>
      <Uid>7bd946f9-7414-4f68-acaf-234923e3e6d1</Uid>
      <UpdatedBy>sample string 13</UpdatedBy>
      <AddressLine1>sample string 2</AddressLine1>
      <AddressLine2>sample string 3</AddressLine2>
      <AddressLine3>sample string 4</AddressLine3>
      <AddressLine4>sample string 5</AddressLine4>
      <CompanyGuid>ec6ea154-673f-4028-94c9-99498e84635a</CompanyGuid>
      <Country>
        <DateUpdated>2025-12-21T17:52:52.9285629+00:00</DateUpdated>
        <Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
          <d5p1:Link>
            <d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
            <d5p1:Method>sample string 2</d5p1:Method>
            <d5p1:Rel>sample string 3</d5p1:Rel>
            <d5p1:Title>sample string 4</d5p1:Title>
            <d5p1:Type>sample string 5</d5p1:Type>
          </d5p1:Link>
          <d5p1:Link>
            <d5p1:Href>http://webapihelppage1.com/</d5p1:Href>
            <d5p1:Method>sample string 2</d5p1:Method>
            <d5p1:Rel>sample string 3</d5p1:Rel>
            <d5p1:Title>sample string 4</d5p1:Title>
            <d5p1:Type>sample string 5</d5p1:Type>
          </d5p1:Link>
        </Links>
        <Uid>c2d4ff4c-d6fc-4560-9828-fedafa008080</Uid>
        <UpdatedBy>sample string 5</UpdatedBy>
        <CountryGuid>139a8da9-d902-4124-af59-d7e5123531f9</CountryGuid>
        <Iso3Code>sample string 1</Iso3Code>
        <Name>sample string 2</Name>
        <Portal>
          <DateUpdated>2025-12-21T17:52:52.9285629+00:00</DateUpdated>
          <Links xmlns:d6p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
            <d6p1:Link>
              <d6p1:Href>http://webapihelppage1.com/</d6p1:Href>
              <d6p1:Method>sample string 2</d6p1:Method>
              <d6p1:Rel>sample string 3</d6p1:Rel>
              <d6p1:Title>sample string 4</d6p1:Title>
              <d6p1:Type>sample string 5</d6p1:Type>
            </d6p1:Link>
            <d6p1:Link>
              <d6p1:Href>http://webapihelppage1.com/</d6p1:Href>
              <d6p1:Method>sample string 2</d6p1:Method>
              <d6p1:Rel>sample string 3</d6p1:Rel>
              <d6p1:Title>sample string 4</d6p1:Title>
              <d6p1:Type>sample string 5</d6p1:Type>
            </d6p1:Link>
          </Links>
          <Uid>c4c52067-e2a4-4e1a-bb1b-7a67abe2f689</Uid>
          <UpdatedBy>sample string 3</UpdatedBy>
          <Name>sample string 1</Name>
        </Portal>
      </Country>
      <Latitude>sample string 7</Latitude>
      <Longitude>sample string 8</Longitude>
      <Name>sample string 1</Name>
      <PortalGuid>b2c64668-307a-403a-a2ec-56905ca2b086</PortalGuid>
      <PortalUid>6bb735e4-9d04-412a-ac26-f9c4d19c376b</PortalUid>
      <PostCode>sample string 6</PostCode>
    </Company>
    <ComplianceExpires>2025-12-21T17:52:52.9285629+00:00</ComplianceExpires>
    <Country>sample string 10</Country>
    <DateOfBirth>2025-12-21T17:52:52.9285629+00:00</DateOfBirth>
    <EarliestStartDate>2025-12-21T17:52:52.9285629+00:00</EarliestStartDate>
    <EclipseLastUpdated>2025-12-21T17:52:52.9285629+00:00</EclipseLastUpdated>
    <EclipseStatus>sample string 27</EclipseStatus>
    <Email>sample string 13</Email>
    <EmploymentSought>sample string 30</EmploymentSought>
    <Forename>sample string 2</Forename>
    <Gender>sample string 23</Gender>
    <IsPrimaryIndustryDiscipline>true</IsPrimaryIndustryDiscipline>
    <Latitude>1.1</Latitude>
    <Location>sample string 24</Location>
    <Longitude>1.1</Longitude>
    <MaxAnnualSalary>32.1</MaxAnnualSalary>
    <MaxHourlyPayrate>34.1</MaxHourlyPayrate>
    <MinAnnualSalary>31.1</MinAnnualSalary>
    <MinHourlyPayrate>33.1</MinHourlyPayrate>
    <Mobile>sample string 12</Mobile>
    <Nationality>sample string 29</Nationality>
    <OtherNames>sample string 4</OtherNames>
    <PersonalStatement>sample string 21</PersonalStatement>
    <Position>sample string 14</Position>
    <PostCode>sample string 9</PostCode>
    <PrimaryDiscipline>sample string 18</PrimaryDiscipline>
    <PrimaryIndustry>sample string 17</PrimaryIndustry>
    <PrimarySubDiscipline>sample string 19</PrimarySubDiscipline>
    <ReferenceNumber>sample string 16</ReferenceNumber>
    <ReferralSource>sample string 22</ReferralSource>
    <Region>sample string 26</Region>
    <Surname>sample string 3</Surname>
    <Telephone>sample string 11</Telephone>
    <Term>sample string 15</Term>
    <Title>sample string 1</Title>
  </Candidate>
  <CandidateAvailabilityGuid>487404ad-f21a-4714-a59a-08576f1cc2ef</CandidateAvailabilityGuid>
  <Description>sample string 2</Description>
  <DiaryType>
    <DateUpdated>2025-12-21T17:52:52.9285629+00:00</DateUpdated>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
    </Links>
    <Uid>e4ba7f46-3b84-4e70-a242-8baa81f289df</Uid>
    <UpdatedBy>sample string 4</UpdatedBy>
    <Category>
      <DateUpdated>2025-12-21T17:52:52.9285629+00:00</DateUpdated>
      <Links xmlns:d4p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
        <d4p1:Link>
          <d4p1:Href>http://webapihelppage1.com/</d4p1:Href>
          <d4p1:Method>sample string 2</d4p1:Method>
          <d4p1:Rel>sample string 3</d4p1:Rel>
          <d4p1:Title>sample string 4</d4p1:Title>
          <d4p1:Type>sample string 5</d4p1:Type>
        </d4p1:Link>
      </Links>
      <Uid>94795c85-143d-4bd3-845d-688ea63bb7cb</Uid>
      <UpdatedBy>sample string 4</UpdatedBy>
      <IsAvailable>true</IsAvailable>
      <Name>sample string 1</Name>
    </Category>
    <DiaryTypeGuid>2a059ab1-9aea-439b-beea-385345d998c1</DiaryTypeGuid>
    <Name>sample string 1</Name>
  </DiaryType>
  <End>2025-12-21T17:52:52.9285629+00:00</End>
  <Start>2025-12-21T17:52:52.9285629+00:00</Start>
  <Summary>sample string 1</Summary>
</CandidateAvailabilityViewModel>

text/iCal

Sample:

BEGIN:VCALENDAR
VERSION:2.0
BEGIN:VEVENT
UID:d497563b-44f9-4ba0-acec-7daba841fb11
DTSTART:20251221T175252Z
DTEND:20251221T175252Z
SUMMARY:sample string 1
END:VEVENT
END:VCALENDAR