PUT api/v1/candidates/registeredbodies/{candidateRegisteredBodyUid}

Updates the candidate registered body by the specified UID.

Request Information

URI Parameters

Name	Description	Type	Additional information
candidateRegisteredBodyUid	The candidate registered body UID.	globally unique identifier	Required

Body Parameters

The candidate registered body.

CandidateRegisteredBody

Name	Description	Type	Additional information
RegisteredBody	The registered body.	string	Required String length: inclusive between 0 and 100
RegisteredBodyStatus	The registered body status.	string	Required String length: inclusive between 0 and 100
RegisteredBodyReference	The registered body reference.	string	Required String length: inclusive between 0 and 100
Candidate	The candidate.	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "RegisteredBody": "sample string 1",
  "RegisteredBodyStatus": "sample string 2",
  "RegisteredBodyReference": "sample string 3",
  "Candidate": "7ffb5dec-a847-4453-9c8a-b2b2707c9747"
}

application/xml, text/xml

Sample:

<CandidateRegisteredBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <Candidate>7ffb5dec-a847-4453-9c8a-b2b2707c9747</Candidate>
  <RegisteredBody>sample string 1</RegisteredBody>
  <RegisteredBodyReference>sample string 3</RegisteredBodyReference>
  <RegisteredBodyStatus>sample string 2</RegisteredBodyStatus>
</CandidateRegisteredBody>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns candidate registered bodies.

CandidateRegisteredBodyViewModel

Name	Description	Type	Additional information
RegisteredBody	The registered body.	string	None.
RegisteredBodyStatus	The registered body status.	string	None.
RegisteredBodyReference	The registered body reference.	string	None.
Candidate	The candidate.	CandidateViewModel	None.
CandidateRegisteredBodyGuid	The uniqie identifier	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:

{
  "RegisteredBody": "sample string 1",
  "RegisteredBodyStatus": "sample string 2",
  "RegisteredBodyReference": "sample string 3",
  "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:49:17.2906697+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": "230ce749-3a29-49e2-9195-bec78f2e3c15",
          "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:49:17.2906697+00:00",
          "UpdatedBy": "sample string 3"
        },
        "CountryGuid": "19ca384d-2c40-49df-9808-c80775a76f32",
        "Uid": "526e321c-e484-4dfb-86b4-e6ef45f027d1",
        "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:49:17.2906697+00:00",
        "UpdatedBy": "sample string 5"
      },
      "Latitude": "sample string 7",
      "Longitude": "sample string 8",
      "PortalUid": "1250c0ac-b990-4b87-95d7-5987354d7f85",
      "PortalGuid": "e0f7a888-cc01-4f0d-9933-876f0943d3e5",
      "CompanyGuid": "c2704a5b-b620-4866-aa74-f615ff6b8a14",
      "Uid": "bf49fd4a-4f2b-4b66-9aed-916c41e4ff55",
      "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:49:17.2906697+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:49:17.2906697+00:00",
    "ComplianceExpires": "2025-12-21T17:49:17.2906697+00:00",
    "CandidateGuid": "a363199f-c3c2-4912-9e38-c5d95e6a191c",
    "DateOfBirth": "2025-12-21T17:49:17.2906697+00:00",
    "Nationality": "sample string 29",
    "EmploymentSought": "sample string 30",
    "MinAnnualSalary": 31.1,
    "MaxAnnualSalary": 32.1,
    "MinHourlyPayrate": 33.1,
    "MaxHourlyPayrate": 34.1,
    "Uid": "63f080db-56a8-4985-9b8f-c20149019f30",
    "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:49:17.2906697+00:00",
    "UpdatedBy": "sample string 36"
  },
  "CandidateRegisteredBodyGuid": "260b4497-aaf3-43f0-b3a7-29a60293d84b",
  "Uid": "43e62fc5-f950-4886-a1ab-56d632e4bc28",
  "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:49:17.2906697+00:00",
  "UpdatedBy": "sample string 6"
}

application/xml, text/xml

Sample:

<CandidateRegisteredBodyViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-12-21T17:49:17.2906697+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>43e62fc5-f950-4886-a1ab-56d632e4bc28</Uid>
  <UpdatedBy>sample string 6</UpdatedBy>
  <Candidate>
    <DateUpdated>2025-12-21T17:49:17.2906697+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>63f080db-56a8-4985-9b8f-c20149019f30</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>a363199f-c3c2-4912-9e38-c5d95e6a191c</CandidateGuid>
    <Company>
      <DateUpdated>2025-12-21T17:49:17.2906697+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>bf49fd4a-4f2b-4b66-9aed-916c41e4ff55</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>c2704a5b-b620-4866-aa74-f615ff6b8a14</CompanyGuid>
      <Country>
        <DateUpdated>2025-12-21T17:49:17.2906697+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>526e321c-e484-4dfb-86b4-e6ef45f027d1</Uid>
        <UpdatedBy>sample string 5</UpdatedBy>
        <CountryGuid>19ca384d-2c40-49df-9808-c80775a76f32</CountryGuid>
        <Iso3Code>sample string 1</Iso3Code>
        <Name>sample string 2</Name>
        <Portal>
          <DateUpdated>2025-12-21T17:49:17.2906697+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>230ce749-3a29-49e2-9195-bec78f2e3c15</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>e0f7a888-cc01-4f0d-9933-876f0943d3e5</PortalGuid>
      <PortalUid>1250c0ac-b990-4b87-95d7-5987354d7f85</PortalUid>
      <PostCode>sample string 6</PostCode>
    </Company>
    <ComplianceExpires>2025-12-21T17:49:17.2906697+00:00</ComplianceExpires>
    <Country>sample string 10</Country>
    <DateOfBirth>2025-12-21T17:49:17.2906697+00:00</DateOfBirth>
    <EarliestStartDate>2025-12-21T17:49:17.2906697+00:00</EarliestStartDate>
    <EclipseLastUpdated>2025-12-21T17:49:17.2906697+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>
  <CandidateRegisteredBodyGuid>260b4497-aaf3-43f0-b3a7-29a60293d84b</CandidateRegisteredBodyGuid>
  <RegisteredBody>sample string 1</RegisteredBody>
  <RegisteredBodyReference>sample string 3</RegisteredBodyReference>
  <RegisteredBodyStatus>sample string 2</RegisteredBodyStatus>
</CandidateRegisteredBodyViewModel>