ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

Companies

A Company describes an individual company in the Eclipse Web API.

API	Description
GET api/v1/portals/{portalUid}/companies	Gets the companies by the specified portal UID.
GET api/v1/companies/{companyUid}	Gets the company by the specified company UID.
GET api/v1/companies	Gets a list of companies for all portals.
PUT api/v1/companies/{companyUid}	Updates the company by the specified company UID.
POST api/v1/portals/{portalUid}/companies	Creates the company with a specified Portal UID.
DELETE api/v1/companies/{companyUid}	Deletes the company by the specified company UID.
PUT api/v1/portals/{portalUid}/customer/reset	Gets the companies by the specified portal UID.

CandidateTimesheets

Describes a timesheet for the candidate.

API	Description
GET api/v1/candidates/timesheets/{timesheetUid}	Gets the candidate timesheet item by the specified timesheet UID.
GET api/v1/candidates/{candidateUid}/timesheets/pending	Gets the candidate pending timesheet by the specified candidate UID.
GET api/v1/candidates/{candidateUid}/timesheets/pending/paged/{page}/{pageSize}/{orderBy}	Gets the candidate pending timesheet by the specified candidate UID.
GET api/v1/candidates/{candidateUid}/timesheets?status={status}&periodStart={periodStart}&periodEnd={periodEnd}&clientName={clientName}	Gets the candidate timesheets for the specified candidate UID.
GET api/v1/candidates/{candidateUid}/timesheets/search?status={status}&periodStart={periodStart}&periodEnd={periodEnd}&keyword={keyword}	Search the candidate timesheets by keyword from job title and client name
GET api/v1/candidates/timesheets/{timesheetUid}/items	Gets the candidate timesheet items by the specified timesheet UID.
GET api/v1/candidates/timesheets/{timesheetUid}/times	Gets the candidate timesheet times by the specified timesheet UID.
GET api/v1/candidates/timesheets/items/{itemUid}	Gets the candidate timesheet item by the timesheet item UID.
GET api/v1/candidates/timesheets/times/{itemUid}	Gets the candidate timesheet time by the timesheet time UID.
POST api/v1/candidates/{candidateUid}/timesheets	Creates the candidate timesheet for the specified candidate UID.
POST api/v1/candidates/timesheets/{timesheetUid}/items	Creates the candidate timesheet item for the specified timesheet UID.
PUT api/v1/candidates/timesheets/{timesheetUid}/submit	Submits the timesheet by the specified timesheet UID.
PUT api/v1/candidates/timesheets/{timesheetUid}	Updates the candidate timesheet by the specified timesheet UID.
PUT api/v1/candidates/timesheets/items/{itemUid}	Updates the candidate timesheet item by the specified timesheet item UID.
PUT api/v1/candidates/timesheets/times/{timeUid}	Updates an individual timesheet time record
DELETE api/v1/candidates/timesheets/{timesheetUid}	Deletes the candidate timesheet item by the specified timesheet UID.
DELETE api/v1/candidates/timesheets/items/{itemUid}	Deletes the candidate timesheet item by the specified timesheet item UID.
GET api/v1/portals/{portalUid}/customer/timesheets/{timesheetGuid}	Gets the candidate timesheet item by the specified timesheet Guid.
POST api/v1/portals/{portalUid}/customer/timesheets	Create a new timesheet in the portal
DELETE api/v1/portals/{portalUid}/customer/timesheets/{timesheetGuid}	Delete a timesheet from the customers portal
GET api/v1/portals/{portalUid}/customer/timesheets/paged?PageSize={PageSize}&PageNumber={PageNumber}&UpdatedSince={UpdatedSince}&UpdatedBy={UpdatedBy}&NotUpdatedBy={NotUpdatedBy}	Search the customer portal for timeshets
PUT api/v1/portals/{portalUid}/customer/timesheets/{timesheetGuid}	Update an existing timesheet in the customer portal

CandidateComplianceAttachments

Describes a Compliance Attachment belonging to a Candidate.

API	Description
GET api/v1/candidates/{candidateUid}/compliance/attachments	Gets all the candidate compliance attachments for the specified candidate UID.
GET api/v1/candidates/compliance/{candidateComplianceUid}/attachments	Gets the attachments by the specified candidate compliances UID.
GET api/v1/candidates/compliance/attachments/{attachmentUid}	Gets the candidate compliance attachment by the specified UID.
POST api/v1/candidates/{candidateUid}/compliance/{candidateComplianceUid}/attachments	Creates the candidate compliance attachment for a specified Candidate UID.
DELETE api/v1/candidates/compliance/attachments/{attachmentUid}	Deletes the candidate compliance attachment by the specified UID.
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/compliance/attachments	Gets all the candidate compliance attachments for the specified candidate GUID.
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/compliance/{complianceGuid}/attachments?download={download}	Get all attachments for a candidate/compliance combination
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/compliance/attachments/{attachmentUid}	Get a specific attachment based on the uid
POST api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/compliance/{complianceGuid}/attachments	Create a new attachment for the candidate and given compliance
DELETE api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/compliance/attachments/{attachmentUid}	Delete a compliance attachment in the cutomer portal

Passwords

Describes changing a registered Eclipse Web API user password.

API	Description
PUT api/v1/users/changepassword	Change the registered users logon password.
POST api/v1/users/forgotpassword	Send a password reset request to the registered Eclipse Web API user.
POST api/v1/users/passwordreset/{requestGuid}	Resets the users password.

Placement

Controller providing API handlers for the placement

API	Description
GET api/v1/portals/{portalUid}/customer/placements/{placementGuid}	Get a placement by the given guid
POST api/v1/portals/{portalUid}/customer/placements	Creates a new placement in the customer poral
PUT api/v1/portals/{portalUid}/customer/placements/{placementGuid}	Updates an existing placement
DELETE api/v1/portals/{portalUid}/customer/placements/{placementGuid}	Delete an existing placement
GET api/v1/portals/{PortalUid}/customer/placements/paged?PageSize={PageSize}&PageNumber={PageNumber}&CompanyGuid={CompanyGuid}&RefNo={RefNo}&ClientGuid={ClientGuid}&UpdatedSince={UpdatedSince}&UpdatedBy={UpdatedBy}	Search the current portal for placments
GET api/v1/portals/{portalUid}/customer/placements/{placementGuid}/timesheets	Get a list of timesheet guids related to this placement
GET api/v1/portals/{portalUid}/customer/placements/{placementGuid}/timesheets/paged?PageSize={PageSize}&PageNumber={PageNumber}&TimesheetGuid={TimesheetGuid}&UpdatedSince={UpdatedSince}&UpdatedBy={UpdatedBy}	Search the placement in the customer portal for timeshets

JobTypes

Describes the type of job e.g. Contract, Permanent.

API	Description
GET api/v1/portals/{portalUid}/jobtypes	Gets all the job types for the specified portal UID.
GET api/v1/jobtypes/{jobTypeUid}	Gets the job type by the specified UID.
PUT api/v1/jobtypes/{jobTypeUid}	Updates the job type by the specified UID.
POST api/v1/portals/{portalUid}/jobtypes	Creates a job type for the specified portal UID.
DELETE api/v1/jobtypes/{jobTypeUid}	Deletes the job type by the specified UID.

Logon

Describes the logon functions.

API	Description
POST api/v1/users/logon	Admins the user logon.
PUT api/v1/portals/{portalUid}/users/logon/secretkey2fa	Update the two factor authentication secret key.
PUT api/v1/portals/{portalUid}/users/logon/{Logon}/secretkey2fa/{is2FASiteWide}	Update the two factor authentication secret key type.
GET api/v1/portals/{portalUid}/users/logon/{logon}/2fainfo	Get logon two factor authentication info
POST api/v1/portals/{portalUid}/users/logon	Allows an anonymous user to logon using logon/password credentials.
POST api/v1/portals/{portalUid}/candidates/logon	Allows an anonymous candidate to login using logon/password credentials.
POST api/v1/portals/{portalUid}/clients/logon	Allows an anonymous client to login using logon/password credentials.
POST api/v1/portals/{portalUid}/agents/logon	Allows and anonymous agent to login using logon/password credentials.

ClientVacancies

Describes a vacancy within the Eclipse Web API.

API	Description
GET api/v1/clients/{clientUid}/vacancies	Get the vacancies for the specified client UID.
GET api/v1/clients/{clientUid}/vacancies/{vacancyUid}	Get the client vacancy by the client vacancy UID.
POST api/v1/clients/{clientUid}/vacancies	Create a new vacancy for the specified client UID.
PUT api/v1/clients/{clientUid}/vacancies/{vacancyUid}	Update the client vacancy by the specified client vacancy UID.

CandidateSkills

Describes the skills belonging to a Candidate.

API	Description
GET api/v1/candidates/{candidateUid}/skills	Gets all the candidate skills by the specified candidate UID.
GET api/v1/candidates/skills/{candidateSkillUid}	Gets the candidate skill by the specified UID.
PUT api/v1/candidates/skills/{candidateSkillUid}	Updates the candidate skill by the specified UID.
POST api/v1/candidates/{candidateUid}/skills	Creates a candidate skill for the specified candidate UID.
DELETE api/v1/candidates/skills/{candidateSkillUid}	Deletes the candidate skill by the specified UID.
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/skills	Get the given candidates skills
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/skills/{candidateSkillGuid}	Get a specific candidate skill
PUT api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/skills/{candidateSkillGuid}	Update a candidate skill
POST api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/skills	Creates a new candidate skill
DELETE api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/skills/{candidateSkillGuid}	Delete a skill from a candidate

CandidateRegisteredBodies

Describes the registered bodies that a candidate is registered with.

API	Description
GET api/v1/candidates/{candidateUid}/registeredbodies	Gets all the candidate registered bodies by the specified candidate UID.
GET api/v1/candidates/registeredbodies/{candidateRegisteredBodyUid}	Gets the candidate registered body by the specified UID.
PUT api/v1/candidates/registeredbodies/{candidateRegisteredBodyUid}	Updates the candidate registered body by the specified UID.
POST api/v1/candidates/{candidateUid}/registeredbodies	Creates the candidate registered body by the specified candidate UID.
DELETE api/v1/candidates/registeredbodies/{candidateregisteredBodyUid}	Deletes the candidate registered body by the specified UID.
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/registeredbodies	Get the given candidates registeredBodies
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/registeredbodies/{candidateRegisteredBodyGuid}	Get a specific candidate registeredBody
PUT api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/registeredbodies/{candidateRegisteredBodyGuid}	Update a candidate registeredBody
POST api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/registeredbodies	Creates a new candidate registeredBody
DELETE api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/registeredbodies/{candidateRegisteredBodyGuid}	Delete a registeredBody from a candidate

Languages

Describes a language e.g. English, French.

API	Description
GET api/v1/languages	Gets all the languages.
GET api/v1/languages/{languageUid}	Gets the language by the specified UID.
GET api/v1/portals/{portalUid}/languages	Gets all the languages by the specified portal UID.
GET api/v1/companies/{companyUid}/languages	Gets all the languages by the specified company UID.
PUT api/v1/languages/{languageUid}	Updates the language by the specified UID.
POST api/v1/portals/{portalUid}/languages	Creates the language by the specified portal UID.
POST api/v1/companies/{companyUid}/languages	Creates the language for the specified company UID.
DELETE api/v1/languages/{languageUid}	Deletes the language by the specified UID.

SalaryBandings

Describes the type of salary banding.

API	Description
GET api/v1/salarybandings/{salaryBandingUid}	Gets the salary banding by UID.
GET api/v1/portals/{portalUid}/salarybandings	Gets the salary bandings by portal.
PUT api/v1/salarybandings/{salaryBandingUid}	Updates the salary banding.
POST api/v1/portals/{portalUid}/salarybandings	Creates the salary banding.
DELETE api/v1/salarybandings/{salaryBandingUid}	Deletes the salary banding.
DELETE api/v1/salarybandings	Deletes all salary bandings.

ClientContactRequests

Describes the client request by a client.

API	Description
GET api/v1/clients/{clientUid}/requests	Get the client requests by the specified client.
GET api/v1/clientcontacts/{clientContactUid}/requests	Get the client requests by the specified client contact.
GET api/v1/portals/{portalUid}/requests	Get the client contact requests for the specified portal UID.
GET api/v1/companies/{companyUid}/requests	Get the client contact requests for the specified company UID.
GET api/v1/clientcontacts/requests/{clientClientRequestUid}	Get a client contact request by the specified client contact request UID.
PUT api/v1/clientcontacts/requests/{clientContactRequestUid}	Update the client contact request.
POST api/v1/clientcontacts/{clientContactUid}/requests	Create a client contact request.
DELETE api/v1/clientcontacts/requests/{clientContactRequestUid}	Delete a client contact request.

Import

Controller for the vacancies posted to the API

API	Description
POST api/v1/portals/{portalUid}/companies/{companyUid}/customer/import/requirements	No documentation available.
GET api/v1/portals/{portalUid}/companies/{companyUid}/customer/import/requirements/{requirementImportGuid}	No documentation available.
GET api/v1/portals/{portalUid}/companies/{companyUid}/customer/import/requirements/process	No documentation available.
PUT api/v1/portals/{portalUid}/companies/{companyUid}/customer/import/requirements/process/{requirementGuid}	No documentation available.

CandidateApplications

Describes a candidates job application.

API	Description
GET api/v1/candidates/applications/{candidateApplicationUid}	Gets the candidate application.
GET api/v1/candidates/{candidateUid}/applications	Gets the candidate applications by candidate.
GET api/v1/jobs/{jobUid}/applications	Gets the candidate applications by job.
POST api/v1/candidates/{candidateUid}/applications	Creates the candidate application.
DELETE api/v1/candidates/applications/{candidateApplicationUid}	Deletes the candidate application.
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/applications/paged?PageSize={PageSize}&PageNumber={PageNumber}&UpdatedSince={UpdatedSince}&UpdatedBy={UpdatedBy}&NotUpdatedBy={NotUpdatedBy}	Gets the applications by the candidate
GET api/v1/portals/{portalUid}/customer/candidates/applications/paged?PageSize={PageSize}&PageNumber={PageNumber}&UpdatedSince={UpdatedSince}&UpdatedBy={UpdatedBy}&NotUpdatedBy={NotUpdatedBy}	Gets the applications by the candidate

Attachments

Describes a document attachment.

API	Description
GET api/v1/attachments/{attachmentUid}	Gets the attachment by UID.

Qualifications

Describes a qualification.

API	Description
GET api/v1/qualifications	Gets the qualifications.
GET api/v1/qualifications/{qualificationUid}	Gets the qualification.
GET api/v1/portals/{portalUid}/qualifications	Gets the qualifications by portal.
GET api/v1/companies/{companyUid}/qualifications	Gets the qualifications by company.
PUT api/v1/qualifications/{qualificationUid}	Updates the qualification.
POST api/v1/portals/{portalUid}/qualifications	Creates the qualification.
POST api/v1/companies/{companyUid}/qualifications	Creates the qualification.
DELETE api/v1/qualifications/{qualificationUid}	Deletes the qualification.
GET api/v1/portals/{portalUid}/customer/qualifications	Gets the qualifications in the customers portal.
GET api/v1/portals/{portalUid}/customer/qualifications/{qualificationGuid}	Gets an individual qualification.
PUT api/v1/portals/{portalUid}/customer/qualifications/{qualificationGuid}	Updates the qualification.
POST api/v1/portals/{portalUid}/customer/qualifications	Creates the qualification in the customers portal.
DELETE api/v1/portals/{portalUid}/customer/qualifications/{qualificationGuid}	Deletes the qualification.

ClientCandidatePool

Describes the list of candidates within a clients candidate pool.

API	Description
GET api/v1/clients/{clientUid}/candidatepool	Gets the client candidate pool.
GET api/v1/clients/{clientUid}/candidatepool/search?count={count}&notSetValue={notSetValue}&anyValue={anyValue}&employmentTypes={employmentTypes}&employmentTerms={employmentTerms}&earliestStartDate={earliestStartDate}&industries={industries}&disciplines={disciplines}&skills={skills}&qualifications={qualifications}&locations={locations}	Search the current client candidate pool for suitable candidates matching a defined set of criteria.
GET api/v1/clients/candidatepool/{itemUid}	Gets the client candidate pool item.
POST api/v1/clients/{clientUid}/candidatepool	Creates the client candidate pool.
DELETE api/v1/clients/{clientUid}/candidatepool	Deletes the client candidate pool.
DELETE api/v1/clients/candidatepool/{itemUid}	Deletes the candidate pool item.

Countries

Describes a country within the Eclipse Web API.

API	Description
GET api/v1/portals/{portalUid}/countries	Gets a list of countries for a specified portal UID.
GET api/v1/countries/{countryUid}	Gets the country by the specified country UID.
PUT api/v1/countries/{countryUid}	Updates the country by the specified country UID.
POST api/v1/portals/{portalUid}/countries	Creates the country for a specified portal UID.
DELETE api/v1/countries/{countryUid}	Deletes the country by the specified country UID.
DELETE api/v1/portals/{portalUid}/customer/countries/{countryGuid}	Deletes the country by the specified country GUID.
GET api/v1/portals/{portalUid}/customer/countries	Gets a list of countries for a specified portal UID.
GET api/v1/portals/{portalUid}/customer/countries/{countryGuid}	Gets the country by the specified country GUID.
PUT api/v1/portals/{portalUid}/customer/countries/{countryGuid}	Updates the country by the specified country GUID.
POST api/v1/portals/{portalUid}/customer/countries	Creates the country for a specified portal UID.

ClientTimesheets

Describes a timesheet for the client.

API	Description
GET api/v1/clients/{clientUid}/timesheets?status={status}&periodStart={periodStart}&periodEnd={periodEnd}	Get the timesheets by the specified timesheet status, period start and end date.
GET api/v1/clients/{clientUid}/timesheets/paged?PageSize={PageSize}&PageNumber={PageNumber}&Status={Status}&orderBy={orderBy}&CanApprove={CanApprove}&CanAuthorise={CanAuthorise}&CanEdit={CanEdit}	Returns a paged list of client timesheets based on the given search parameters
GET api/v1/clients/{clientUid}/candidatetimesheets/paged?PageSize={PageSize}&PageNumber={PageNumber}&CanApprove={CanApprove}&CanAuthorise={CanAuthorise}&CanEdit={CanEdit}&Status={Status}&OrderBy={OrderBy}	Returns a paged list of candidate timesheets based on the given search parameters
GET api/v1/clients/{clientUid}/archive/timesheets?status={status}&timesheetRef={timesheetRef}&candidateName={candidateName}&periodStart={periodStart}&periodEnd={periodEnd}&pageSize={pageSize}&pageNumber={pageNumber}&orderBy={orderBy}	Get the timesheets by the specified timesheet status, period start and end date.

ClientSites

Describes the Client site/office location.

API	Description
GET api/v1/clients/{clientUid}/sites	Gets the lists of client sites by the specified client UID.
GET api/v1/clients/sites/{clientSiteUid}	Gets the client site by the specified client site UID.
PUT api/v1/clients/sites/{clientSiteUid}	Update the client site by the specified client site UID.
POST api/v1/clients/{clientUid}/sites	Creates a client site for the specified client UID.
DELETE api/v1/clients/sites/{clientSiteUid}	Deletes the client site by the specified client site UID.
GET api/v1/portals/{portalUid}/customer/clients/{clientGuid}/sites	Gets the client sites for the client.
GET api/v1/portals/{portalUid}/customer/clients/{clientGuid}/sites/{clientSiteGuid}	Gets the client site by the client site Guid.
PUT api/v1/portals/{portalUid}/customer/clients/{clientGuid}/sites/{clientSiteGuid}	Updates the client site by the specified client site Guid.
POST api/v1/portals/{portalUid}/customer/clients/{clientGuid}/sites	Creates the client site for the specified client Guid.
DELETE api/v1/clients/sites/{clientSiteUid}?portalUid={portalUid}&clientGuid={clientGuid}&clientSiteGuid={clientSiteGuid}	Deletes the client site by the specified client site Guid.
DELETE api/v1/portals/{portalUid}/customer/clients/{clientGuid}/sites/{clientSiteGuid}	Deletes the client site by the specified client site Guid.

Consultants

Describes the details relating to a consultant.

API	Description
GET api/v1/companies/{companyUid}/consultants	Gets the consultants by specified company UID.
GET api/v1/consultants/{consultantUid}	Gets the consultant by specified consultant UID.
PUT api/v1/consultants/{consultantUid}	Updates the consultant by the specified consultant UID.
POST api/v1/companies/{companyUid}/consultants	Creates the consultant by the specified company UID.
DELETE api/v1/consultants/{consultantUid}	Deletes the consultant by the specified consultant UID.
GET api/v1/consultants/{consultantUid}/photo	Gets the consultant photo for the specified consultant UID.
POST api/v1/consultants/{consultantUid}/photo	Creates the consultant photo for the specified consultant UID.

Agents

Describes an Agent with the Eclipse Web API.

API	Description
GET api/v1/agents/{agentUid}	Gets the agent by the specified agent UID.
POST api/v1/portals/{portalUid}/agents	Creates the agent by the specified portal UID.
POST api/v1/companies/{companyUid}/agents	Creates the agent by the specified company UID.
POST api/v1/agents/{agentUid}/logo	Creates the agent logo by the specified agent UID.
PUT api/v1/agents/{agentUid}	Updates the agent by the specified agent UID.

CandidateCompliance

Describes a candidates compliance details.

API	Description
GET api/v1/candidates/{candidateUid}/compliance	Gets the candidate compliance.
GET api/v1/candidates/compliance/{candidateComplianceUid}	Gets the candidate compliance by UID.
PUT api/v1/candidates/compliance/{candidateComplianceUid}	Updates the candidate compliance.
POST api/v1/candidates/{candidateUid}/compliance	Creates the candidate compliance.
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/compliance	Get a list of compliance items for the given candidate
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/compliance/{complianceGuid}	Get the latest copy of the given compliance item for the candidate
POST api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/compliance/{complianceGuid}	Create a new compliance item in the customers portal
PUT api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/compliance/{complianceGuid}	Update a candidates compliance item in the customers portal
DELETE api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/compliance/{complianceGuid}	Deletes the candidate compliance.

Status

Describes the current status of the Eclipse Web API.

API	Description
GET api/v1/status	Gets the API Status and version.

Staff

Describes the staff details.

API	Description
GET api/v1/staff	Gets the staff.
GET api/v1/staff/{staffUid}	Gets the staff by UID.
GET api/v1/portals/{portalUid}/staff	Gets the staff by portal.
GET api/v1/companies/{companyUid}/staff	Gets the staff by company.
GET api/v1/staffcategories/{staffCategoryUid}/staff	Gets the staff by staff category.
GET api/v1/sites/{siteUid}/staff	Gets the staff by site.
PUT api/v1/staff/{staffUid}	Updates the staff.
POST api/v1/portals/{portalUid}/staff	Creates the staff.
POST api/v1/companies/{companyUid}/staff	Creates the staff.
DELETE api/v1/staff/{staffUid}	Deletes the staff.
DELETE api/v1/staff	Deletes all staff.

UserBaskets

Describes a user and the job basket.

API	Description
GET api/v1/users/baskets/{userBasketUid}	Gets the user basket by UID.
GET api/v1/users/{userUid}/baskets	Gets the user basket by specified user UID.
POST api/v1/users/{userUid}/baskets	Creates the user baskets by job UIDs and specified user UID.
DELETE api/v1/users/baskets/{userBasketUid}	Deletes the user basket by the specified user basket UID.
DELETE api/v1/users/{userUid}/baskets	Deletes all users baskets items for the specified user UID.

Skills

Describes the skill.

API	Description
GET api/v1/skills	Gets the skills.
GET api/v1/skills/{skillUid}	Gets the skill.
GET api/v1/portals/{portalUid}/skills	Gets the skills by portal.
GET api/v1/companies/{companyUid}/skills	Gets the skills by company.
PUT api/v1/skills/{skillUid}	Updates the skill.
POST api/v1/portals/{portalUid}/skills	Creates the skill.
POST api/v1/companies/{skillUid}/skills	Creates the skill.
DELETE api/v1/skills/{skillUid}	Deletes the skill.
DELETE api/v1/skills	Deletes all skills.
GET api/v1/portals/{portalUid}/customer/skills	Gets the skills for the customers portal.
GET api/v1/portals/{portalUid}/customer/skills/{skillGuid}	Gets and individual skill.
PUT api/v1/portals/{portalUid}/customer/skills/{skillGuid}	Updates the skill.
POST api/v1/portals/{portalUid}/customer/skills	Creates the skill.
DELETE api/v1/portals/{portalUid}/customer/skills/{skillGuid}	Deletes the skill.

CandidateIndustryDisciplines

Describes the industry disciplines for a candidate.

API	Description
GET api/v1/candidates/{candidateUid}/industrydisciplines	Gets the candidate industry disciplines.
GET api/v1/candidates/industrydisciplines/{industryDisciplineUid}	Gets the candidate industry discipline.
PUT api/v1/candidates/industrydisciplines/{industryDisciplineUid}	Updates the candidate industry discipline.
POST api/v1/candidates/{candidateUid}/industrydisciplines	Creates the candidate industry discipline.
DELETE api/v1/candidates/industrydisciplines/{industryDisciplineUid}	Deletes the candidate industry discipline.
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/industrydisciplines	Gets the candidate industry disciplines.
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/industrydisciplines/{candidateIndustryDisciplineGuid}	Get a specific candidate industry discipline
POST api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/industrydisciplines	Create a new candidate industry discipline
PUT api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/industrydisciplines/{candidateIndustryDisciplineGuid}	Update a specific candidate industry discipline
DELETE api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/industrydisciplines/{candidateIndustryDisciplineGuid}	Delete a specific candidate industry discipline

ClientContacts

Describes the contact details for a client.

API	Description
GET api/v1/clients/{clientUid}/contacts	Gets the client contacts for the client.
GET api/v1/clients/contacts/{clientContactUid}	Gets the client contact by the client contact UID.
PUT api/v1/clients/contacts/{clientContactUid}	Updates the client contact by the specified client contact UID.
POST api/v1/clients/{clientUid}/contacts	Creates the client contact for the specified client UID.
DELETE api/v1/clients/contacts/{clientContactUid}	Deletes the client contact by the specified client contact UID.
GET api/v1/clients/contacts/{clientContactUid}/photo	Returns the photo for the specified client contact UID.
POST api/v1/clients/contacts/{clientContactUid}/photo	Creates a photo for the specified client contact UID.
GET api/v1/portals/{portalUid}/customer/clients/{clientGuid}/contacts	Gets the client contacts for the client.
GET api/v1/portals/{portalUid}/customer/clients/{clientGuid}/contacts/{clientContactGuid}	Gets the client contact by the client contact Guid.
PUT api/v1/portals/{portalUid}/customer/clients/{clientGuid}/contacts/{clientContactGuid}	Updates the client contact by the specified client contact Guid.
POST api/v1/portals/{portalUid}/customer/clients/{clientGuid}/contacts	Creates the client contact for the specified client Guid.
DELETE api/v1/clients/contacts/{clientContactUid}?portalUid={portalUid}&clientGuid={clientGuid}&clientContactGuid={clientContactGuid}	Deletes the client contact by the specified client contact Guid.
DELETE api/v1/portals/{portalUid}/customer/clients/{clientGuid}/contacts/{clientContactGuid}	Deletes the client contact by the specified client contact Guid.
GET api/v1/portals/{portalUid}/customer/clients/{clientGuid}/contacts/{clientContactGuid}/logon	No documentation available.
PUT api/v1/portals/{portalUid}/customer/clients/{clientGuid}/contacts/{clientContactGuid}/logon	No documentation available.

TimesheetStatus

Describes a timesheet status held against the portal.

API	Description
GET api/v1/portal/{portalUid}/timesheet/status	Returns a list of timesheet statuses that have been configured for this portal

AgentCandidates

Describes the relationship between an Agent and a Candidate.

API	Description
POST api/v1/agents/{agentUid}/candidates/{candidateUid}	Assign a candidate to an agency.
DELETE api/v1/agents/candidates/{agentCandidateUid}	Deletes the agent candidate record by the specified UID.
DELETE api/v1/agents/{agentUid}/candidates	Delete all candidates for the specified agent UID.
GET api/v1/agents/candidates/{agentCandidateUid}	Gets the agent candidate.
GET api/v1/agents/{agentUid}/candidates	Gets all the candidates for the specified agency UID.

CandidateCv

Describes the candidate CV.

API	Description
GET api/v1/candidates/{candidateUid}/cv/{latestOnly}	Gets the candidate CV by the specified candidate UID.
GET api/v1/candidates/cv/{candidateCvUid}	Gets the candidate CV by the specified candidate CV UID.
GET api/v1/candidates/cv/{candidateCvUid}/attachment	Gets the candidate CV attachment by the specified candidate CV UID.
POST api/v1/candidates/{candidateUid}/cv	Creates the candidate CV for the specified candidate UID.
DELETE api/v1/candidates/cv/{candidateCvUid}	Deletes the candidate CV.
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/cv/lastupdated?latestOnly={latestOnly}	Gets the candidate CV by the specified candidate GUID.
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/cv/{latestOnly}	Gets the candidate CV by the specified candidate GUID.
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/cv/{candidateCvGuid}	Gets the candidate CV by the specified candidate CV GUID.
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/cv/{candidateCvGuid}/attachment	Gets the candidate CV attachment by the specified candidate CV GUID.
POST api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/cv	Creates the candidate CV for the specified candidate UID.
DELETE api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/cv/{candidateCvGuid}	Deletes the candidate CV.

CompanySites

Describes the site belong to a portal or company.

API	Description
GET api/v1/companies/sites	Gets all the sites.
GET api/v1/companies/sites/{siteUid}	Gets the site.
GET api/v1/portals/{portalUid}/companies/sites	Gets the sites by portal.
GET api/v1/companies/{companyUid}/sites	Gets the sites by company.
PUT api/v1/companies/sites/{siteUid}	Updates the site.
POST api/v1/portals/{portalUid}/companies/sites	Creates the site by portal.
POST api/v1/companies/{companyUid}/sites	Creates the site by company.
DELETE api/v1/companies/sites/{siteUid}	Deletes the site by the specified UID.
DELETE api/v1/companies/sites	Deletes all sites.

Registration

Describes registration of a candidate/client within the Eclipse Web API.

API	Description
POST api/v1/portals/{portalUid}/candidates/registration	Registers a candidate for the Eclipse Web API.
POST api/v1/portals/{portalUid}/customer/candidates	Registers and confirms the candidate in the API Requires a customer role to perform this action for b2b integration
POST api/v1/portals/{portalUid}/agents/registration	Registers an agent for the Eclipse Web API.
POST api/v1/portals/{portalUid}/clients/registration	Registers a client for the Eclipse Web API.
POST api/v1/registration/confirmation/{requestUid}	Confirms the user registration.
POST api/v1/registration/confirmation/resend?userLogon={userLogon}	Res the send user confirmation.

CandidateLanguages

Describes the languages for a candidate.

API	Description
GET api/v1/candidates/{candidateUid}/languages	Gets the candidate languages.
GET api/v1/candidates/languages/{candidateLanguageUid}	Gets the candidate language.
PUT api/v1/candidates/languages/{candidateLanguageUid}	Updates the candidate language.
POST api/v1/candidates/{candidateUid}/languages	Creates the candidate language.
DELETE api/v1/candidates/languages/{candidateLanguageUid}	Deletes the candidate language.
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/languages	Get the given candidates languages
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/languages/{candidateLanguageGuid}	Get a specific candidate language
PUT api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/languages/{candidateLanguageGuid}	Update a candidate language
POST api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/languages	Creates a new candidate language
DELETE api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/languages/{candidateLanguageGuid}	Delete a language from a candidate

RegisteredBodyStatuses

Describves a status for the registered body.

API	Description
GET api/v1/portals/{portalUid}/registeredbodies/statuses	Gets the registered body statuses by portal.
GET api/v1/registeredbodies/statuses/{registeredBodyStatusUid}	Gets the registered body statuses by UID.
PUT api/v1/registeredbodies/statuses/{registeredBodyStatusUid}	Updates the registered body.
PUT api/v1/portals/{portalUid}/customer/registeredbodies/statuses/{registeredBodyStatusGuid}	Updates the registered body.
POST api/v1/portals/{portalUid}/registeredbodies/statuses	Creates the registered body status.
DELETE api/v1/registeredbodies/statuses/{statusUid}	Deletes the registered body status.
DELETE api/v1/portals/{portalUid}/customer/registeredbodies/statuses/{registeredBodyStatusGuid}	Deletes the registered body status.
GET api/v1/portals/{portalUid}/customer/registeredbodies/statuses	Gets the customers registered body statuses.
GET api/v1/portals/{portalUid}/customer/registeredbodies/statuses/{registeredBodyStatusGuid}	Gets the registered body status by GUID.
POST api/v1/portals/{portalUid}/customer/registeredbodies/statuses	Creates the registered body status.

Clients

Describes details for a client within the Eclipse Web API.

API	Description
POST api/v1/portals/{portalUid}/clients	Registers a client.
GET api/v1/companies/{companyUid}/clients	Gets the clients by the specified company UID.
GET api/v1/clients/{clientUid}	Gets the client by the specified client UID.
GET api/v1/portals/{portalUid}/customer/clients/{clientGuid}	Creates a new client in the customer poral
GET api/v1/clients/{clientUid}/logo	Gets the client logo by the specified client UID.
GET api/v1/clients	Gets a list of all clients.
PUT api/v1/clients/{clientUid}	Updates the client by the specified client UID.
PUT api/v1/portals/{portalUid}/customer/clients/{clientGuid}	Update an existing client
POST api/v1/clients/{clientUid}/logo	Uploads the client logo by the specified client UID.
POST api/v1/companies/{companyUid}/clients	Creates the client by the specified company UID.
POST api/v1/clients	Creates the client.
POST api/v1/portals/{portalUid}/customer/clients	Creates a new client in the customer poral
DELETE api/v1/clients/{clientUid}	Deletes the client by the specified client UID.
DELETE api/v1/portals/{portalUid}/customer/clients/{clientGuid}	Deletes a client in the given customers portal
GET api/v1/clients/{clientUid}/candidates/search?count={count}&notSetValue={notSetValue}&anyValue={anyValue}&employmentTypes={employmentTypes}&employmentTerms={employmentTerms}&earliestStartDate={earliestStartDate}&industries={industries}&disciplines={disciplines}&skills={skills}&qualifications={qualifications}&locations={locations}	Search the clients list of candidates for suitable candidates matching a defined set of criteria.
GET api/v1/portals/{PortalUid}/customer/clients/paged?PageSize={PageSize}&PageNumber={PageNumber}&CompanyGuid={CompanyGuid}&RefNo={RefNo}&Name={Name}&UpdatedSince={UpdatedSince}&UpdatedBy={UpdatedBy}&NotUpdatedBy={NotUpdatedBy}	No documentation available.
GET api/v1/portals/{PortalUid}/customer/clients/paged/guids?PageSize={PageSize}&PageNumber={PageNumber}&CompanyGuid={CompanyGuid}&RefNo={RefNo}&Name={Name}&UpdatedSince={UpdatedSince}&UpdatedBy={UpdatedBy}&NotUpdatedBy={NotUpdatedBy}	No documentation available.

Industries

Describes an Industry.

API	Description
GET api/v1/portals/{portalUid}/industries	Gets the industries by the specified portal UID.
GET api/v1/industries/{industryUid}	Gets the industry by the specified industry UID.
GET api/v1/portals/{portalUid}/industries/{industryS}	Gets the industryUID by the specified industry (name) - SI
PUT api/v1/industries/{industryUid}	Updates the industry by the specified industry UID.
POST api/v1/portals/{portalUid}/industries	Creates the industry by specified portal UID.
DELETE api/v1/industries/{industryUid}	Deletes the industry by specified industry UID.
GET api/v1/portals/{portalUid}/customer/industries	Gets the industries by the specified portal UID.
GET api/v1/portals/{portalUid}/customer/industries/{industryGuid}	Gets the industry by the specified industry GUID.
PUT api/v1/portals/{portalUid}/customer/industries/{industryGuid}	Updates the industry by the specified industry GUID.
POST api/v1/portals/{portalUid}/customer/industries	Creates the industry by specified portal UID.
DELETE api/v1/portals/{portalUid}/customer/industries/{industryGuid}	Deletes the industry by specified industry GUID.

IndustryDisciplines

Describes the link between an Industry and a Discipline.

API	Description
GET api/v1/portals/{portalUid}/industrydisciplines	Gets the industry disciplines by portal.
GET api/v1/portals/{portalUid}/industrydisciplines/{industryUid}	Gets the industry disciplines by portal industry.
GET api/v1/industrydisciplines/{industryDisciplineUid}	Gets the industry discipline by UID.
POST api/v1/industrydisciplines	Creates the industry discipline.
DELETE api/v1/industrydisciplines/{industryDisciplineUid}	Deletes the industry discipline.
DELETE api/v1/portals/{portalUid}/customer/industrydisciplines/{industryDisciplineGuid}	Deletes the industry discipline.
GET api/v1/portals/{portalUid}/customer/industrydisciplines	Gets the industry disciplines by portal.
GET api/v1/portals/{portalUid}/customer/industrydisciplines/{industryGuid}	Gets the industry disciplines by portal industry.
GET api/v1/portals/{portalUid}/customer/industrydisciplines/{industryDisciplineGuid}	Gets the industry discipline by GUID.
POST api/v1/portals/{portalUid}/customer/industrydisciplines	Creates the industry discipline.

AgentContacts

Describes an Agent Contact within the Eclipse Web API.

API	Description
GET api/v1/agents/{agentUid}/contacts	Gets the agent contacts by the specified agent UID.
GET api/v1/agents/contacts/{agentContactUid}	Gets the agent contact by the specified Agent Contact UID.
PUT api/v1/agents/contacts/{agentContactUid}	Updates the agent contact with the specified agent contact UID.
POST api/v1/agents/contacts/{agentContactUid}/photo	Creates the agent contact photo for the specified agent contact UID.

RegisteredBodies

Describes a Registered Body, Society or Organisation.

API	Description
GET api/v1/portals/{portalUid}/registeredbodies	Gets the registered bodies by specified portal UID.
GET api/v1/registeredbodies/{registeredBodyUid}	Gets the registered bodies by the specified registered body UID.
PUT api/v1/registeredbodies/{registeredBodyUid}	Updates the registered body by the specified registered body UID.
POST api/v1/portals/{portalUid}/registeredbodies	Creates the registered body for the specified portal UID.
DELETE api/v1/registeredbodies/{registeredBodyUid}	Deletes the registered body by the specified registered body UID.
GET api/v1/portals/{portalUid}/customer/registeredbodies	Gets the registered bodies by specified portal UID.
GET api/v1/portals/{portalUid}/customer/registeredbodies/{registeredBodyGuid}	Gets the registered bodies by the specified registered body GUID.
PUT api/v1/portals/{portalUid}/customer/registeredbodies/{registeredBodyGuid}	Updates the registered body by the specified registered body UID.
POST api/v1/portals/{portalUid}/customer/registeredbodies	Creates the registered body for the specified portal UID.
DELETE api/v1/portals/{portalUid}/customer/registeredbodies/{registeredBodyGuid}	Deletes the registered body by the specified registered body UID.

Shortlist

Describes the list of candidates assigned to a clients vacancy shortlist pool.

API	Description
GET api/v1/vacancies/{vacancyUid}/shortlist	Gets the shortlist for a clients vacancy.
GET api/v1/vacancies/shortlist/{vacancyShortListUid}	Gets an individual shortlist item for a client
POST api/v1/vacancies/{vacancyUid}/shortlist	Adds the candidate to vacancy shortlist.
DELETE api/v1/vacancies/shortlist/{vacancyShortListUid}	Removes the shortlist item.
GET api/v1/candidates/{candidateUid}/shortlist?status={status}&from={from}	Gets the candidates shortlist
GET api/v1/candidates/shortlist/{shortListUid}	Gets an individual shortlist item for a client
PUT api/v1/candidates/shortlist/{shortlistUid}	Updates an individual shortlist item for a candidate

CandidateTimesheetAttachment

Describes a Timesheet Attachment belonging to a Candidate.

API	Description
GET api/v1/candidates/{candidateUid}/timesheet/attachments	Gets all the candidate timesheet attachments for the specified candidate UID.
GET api/v1/candidates/timesheet/{timesheetUid}/attachments	Gets the attachments by the specified candidate timesheets UID.
GET api/v1/candidates/timesheet/attachments/{attachmentUid}	Gets the candidate timesheet attachment by the specified UID.
POST api/v1/candidates/{candidateUid}/timesheet/{timesheetUid}/attachment?timesheetAttachmentType={timesheetAttachmentType}&attachmentName={attachmentName}	Creates the candidate timesheet attachment for a specified Candidate UID.
DELETE api/v1/candidates/timesheet/attachments/{attachmentUid}	Deletes the candidate timesheet attachment by the specified UID.
GET api/v1/portals/{portalUid}/customer/candidates/timesheets/{timesheetGuid}/attachments/{latestOnly}	Gets the attachments by the specified candidate timesheets UID.
GET api/v1/portals/{portalUid}/customer/candidates/timesheets/attachments/{attachmentGuid}	Gets the candidate timesheet attachment from the given customer portal by the specified guid.
POST api/v1/portals/{portalUid}/customer/candidates/timesheets/{timesheetGuid}/attachments/expenses	Creates the candidate timesheet attachment for a specified Candidate UID.
POST api/v1/portals/{portalUid}/customer/candidates/timesheets/{timesheetGuid}/attachments/timesheet	No documentation available.
DELETE api/v1/portals/{portalUid}/customer/candidates/timesheets/attachments/{attachmentGuid}	Deletes a candidate timesheet attachment from the customer portal by the specified attachment guid.

ClientTimesheetAttachment

Describes a Timesheet Attachment belonging to a client.

API	Description
GET api/v1/clients/timesheet/{timesheetUid}/attachments	Gets the attachments by the specified candidate timesheets UID.

Vacancy

Controller for the vacancies posted to the API

API	Description
GET api/v1/vacancy/{vacancyUid}	Gets the vacancy by the given uid

Jobs

Describes a vacancy within the Eclipse Web API.

API	Description
GET api/v1/portals/{portalUid}/jobs/search?count={count}&notSetValue={notSetValue}&anyValue={anyValue}&countries={countries}&regions={regions}&locations={locations}&industries={industries}&disciplines={disciplines}&subDisciplines={subDisciplines}&jobTypes={jobTypes}&datePosted={datePosted}&startDate={startDate}&divisions={divisions}&classifications={classifications}&title={title}&description={description}	Gets the jobs from the specified portal UID using the parameters provided.
GET api/v1/portals/{portalUid}/jobs/count?lastUpdated={lastUpdated}	Gets the number of published jobs in the specified portal UID.
GET api/v1/companies/{companyUid}/jobs/count?lastUpdated={lastUpdated}	Gets the number of published jobs in the specified portal UID.
GET api/v1/portals/{portalUid}/jobs/paged/{page}/{pageSize}?lastUpdated={lastUpdated}	Gets the published jobs by Portal, Page and Page Size.
GET api/v1/companies/{companyUid}/jobs/paged/{page}/{pageSize}?lastUpdated={lastUpdated}	Gets the published jobs by Portal, Page and Page Size.
GET api/v1/portals/{portalUid}/jobs?count={count}&notSetValue={notSetValue}&anyValue={anyValue}&countries={countries}&regions={regions}&locations={locations}&industries={industries}&disciplines={disciplines}&subDisciplines={subDisciplines}&jobTypes={jobTypes}&datePosted={datePosted}&startDate={startDate}&divisions={divisions}&classifications={classifications}&title={title}&description={description}&lastUpdated={lastUpdated}	Gets the jobs from the specified portal UID using the parameters provided.
GET api/v1/portals/{portalUid}/jobs/refs?count={count}&notSetValue={notSetValue}&anyValue={anyValue}&countries={countries}&regions={regions}&locations={locations}&industries={industries}&disciplines={disciplines}&subDisciplines={subDisciplines}&jobTypes={jobTypes}&datePosted={datePosted}&startDate={startDate}&divisions={divisions}&classifications={classifications}&title={title}&description={description}&lastUpdated={lastUpdated}	Gets the vacancy references.
GET api/v1/portals/{portalUid}/jobs/companyrefs?count={count}&notSetValue={notSetValue}&anyValue={anyValue}&countries={countries}&regions={regions}&locations={locations}&industries={industries}&disciplines={disciplines}&subDisciplines={subDisciplines}&jobTypes={jobTypes}&datePosted={datePosted}&startDate={startDate}&divisions={divisions}&classifications={classifications}&title={title}&description={description}&lastUpdated={lastUpdated}	Gets the company name and vacancy references.
GET api/v1/companies/{companyUid}/jobs/companyrefs?count={count}&notSetValue={notSetValue}&anyValue={anyValue}&countries={countries}&regions={regions}&locations={locations}&industries={industries}&disciplines={disciplines}&subDisciplines={subDisciplines}&jobTypes={jobTypes}&datePosted={datePosted}&startDate={startDate}&divisions={divisions}&classifications={classifications}&title={title}&description={description}&lastUpdated={lastUpdated}	Gets the company name and vacancy references.
GET api/v1/companies/{companyUid}/jobs?count={count}	Get all the published jobs by the specified company UID.
GET api/v1/jobs/{jobUid}	Gets the published job by specified job UID.
GET api/v1/portals/{portalUid}/jobs/featured?count={count}&divisions={divisions}&classifications={classifications}&notSetValue={notSetValue}	Gets the featured jobs using the parameters provided.
GET api/v1/portals/{portalUid}/jobs/countries?notSetValue={notSetValue}	Gets a list of the published jobs countries.
GET api/v1/portals/{portalUid}/jobs/disciplines?industry={industry}&notSetValue={notSetValue}	Gets a list of the published jobs disciplines.
GET api/v1/portals/{portalUid}/jobs/subdisciplines?industry={industry}&parentDiscipline={parentDiscipline}&notSetValue={notSetValue}	Gets a list of the published jobs sub disciplines.
GET api/v1/portals/{portalUid}/jobs/industries?notSetValue={notSetValue}	Gets a list of the published jobs industries.
GET api/v1/portals/{portalUid}/jobs/jobtypes?notSetValue={notSetValue}	Gets a list of the published jobs job types.
GET api/v1/portals/{portalUid}/jobs/classifications?notSetValue={notSetValue}	No documentation available.
GET api/v1/portals/{portalUid}/jobs/divisions?notSetValue={notSetValue}	No documentation available.
GET api/v1/portals/{portalUid}/jobs/locations?country={country}&region={region}&notSetValue={notSetValue}	Gets a list of the published jobs locations.
GET api/v1/portals/{portalUid}/jobs/regions?country={country}&notSetValue={notSetValue}	Gets a list of the published jobs regions.
GET api/v1/portals/{portalUid}/jobs/industrydisciplines?notSetValue={notSetValue}	Gets a list of the published jobs industry disciplines.
GET api/v1/portals/{portalUid}/jobs/countryregionlocations?notSetValue={notSetValue}	Gets a list of the published jobs country region locations.
GET api/v1/portals/{portalUid}/jobsalerts/count?fromDate={fromDate}&toDate={toDate}&notSetValue={notSetValue}	Gets the total number of job alerts in period.
GET api/v1/portals/{portalUid}/customer/jobs	Gets the job for the customers portal.
GET api/v1/portals/{portalUid}/customer/jobs/{jobGuid}	Gets and individual job.
PUT api/v1/portals/{portalUid}/customer/jobs/{jobGuid}	Updates the job.
POST api/v1/portals/{portalUid}/customer/jobs	Creates the job.
DELETE api/v1/portals/{portalUid}/customer/jobs/{jobGuid}	Deletes the job.

ReferralSources

Describes the referral source.

API	Description
GET api/v1/referralsources	Gets the Referral Sources.
GET api/v1/referralsources/{referralsourceUid}	Gets the specified referral source.
GET api/v1/portals/{portalUid}/referralsources	Gets the referral sources by portal.
GET api/v1/portals/{portalUid}/customer/referralsources	Gets the referral sources.
GET api/v1/portals/{portalUid}/customer/referralsources/{referralsourceUid}	Gets the specified referral source.
PUT api/v1/portals/{portalUid}/customer/referralsources/{referralSourceGuid}	Updates the referral source.
POST api/v1/portals/{portalUid}/customer/referralsources	Creates the referral source.
DELETE api/v1/portals/{portalUid}/customer/referralsources/{referralSourceGuid}	Deletes the referral source.

SavedSearches

Describes a users saved search for a vacancy.

API	Description
GET api/v1/users/{userUid}/savedsearches	Gets the users saved searches.
GET api/v1/users/savedsearches/{savedSearchUid}	Gets the users saved search.
POST api/v1/portals/{portalUid}/users/{userUid}/savedsearches	Creates the saved search.
DELETE api/v1/users/savedsearches/{savedSearchUid}	Deletes the saved search.
DELETE api/v1/users/{userUid}/savedsearches	Deletes all users saved searches.

ComplianceAlias

The compliance alias controller.

API	Description
GET api/v1/portals/{portalUid}/customer/compliance/{complianceGuid}/alias	Gets all compliance aliases for a given compliance item.
GET api/v1/portals/{portalUid}/customer/compliance/{complianceGuid}/alias/{complianceAliasGuid}	Gets a specific compliance alias by uid.
PUT api/v1/portals/{portalUid}/customer/compliance/{complianceGuid}/alias/{complianceAliasGuid}	Updates the compliance alias.
POST api/v1/portals/{portalUid}/customer/compliance/{complianceGuid}/alias	Create a compliance alias
DELETE api/v1/portals/{portalUid}/customer/compliance/{complianceGuid}/alias/{complianceAliasGuid}	Deletes the compliance alias.

AgentVacancyApplications

Describes a candidates application to an Agent Vacancy.

API	Description
POST api/v1/agents/vacancies/{agentVacancyUid}/applications	Creates the agent vacancy application.
DELETE api/v1/agents/vacancies/applications/{agentVacancyApplicationUid}	Deletes the agent vacancy application.
DELETE api/v1/agents/vacancies/{agentVacancyUid}/applications	Deletes the vacancy applications.
GET api/v1/agents/vacancies/applications/{agentVacancyApplicationUid}	Gets the agent vacancy application by the specified UID.
GET api/v1/agents/vacancies/{agentVacancyUid}/applications	Gets the agent vacancy applications.

StaffCategories

Describes the staff category to which the staff member belongs to.

API	Description
GET api/v1/staffcategories	Gets the staff categories.
GET api/v1/staffcategories/{staffCategoryUid}	Gets the staff category.
GET api/v1/portals/{portalUid}/staffcategories	Gets the staff categories by portal.
GET api/v1/companies/{companyUid}/staffcategories	Gets the staff categories by company.
PUT api/v1/staffcategories/{staffCategoryUid}	Updates the staff category.
POST api/v1/portals/{portalUid}/staffcategories	Creates the staff category.
POST api/v1/companies/{companyUid}/staffcategories	Creates the staff category.
DELETE api/v1/staffcategories/{staffCategoryUid}	Deletes the staff category.
DELETE api/v1/staffcategories	Deletes all staff categories.

Compliance

The compliance controller.

API	Description
GET api/v1/portals/{portalUid}/customer/compliance	Gets all compliance items in a given portal.
GET api/v1/portals/{portalUid}/customer/compliance/{complianceGuid}	Gets a specific compliance item.
PUT api/v1/portals/{portalUid}/customer/compliance/{complianceGuid}	Updates the compliance item.
POST api/v1/portals/{portalUid}/customer/compliance	Create a compliance item
DELETE api/v1/portals/{portalUid}/customer/compliance/{complianceGuid}	Deletes the compliance item.

CandidateQualifications

Describes the candidates qualifications.

API	Description
GET api/v1/candidates/{candidateUid}/qualifications	Gets the candidate qualifications.
GET api/v1/candidates/qualifications/{candidateQualificationUid}	Gets the candidate qualification.
PUT api/v1/candidates/qualifications/{candidateQualificationUid}	Updates the candidate qualification.
POST api/v1/candidates/{candidateUid}/qualifications	Creates the candidate qualification.
DELETE api/v1/candidates/qualifications/{candidateQualificationUid}	Deletes the candidate qualification.
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/qualifications	Get the given candidates qualifications
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/qualifications/{candidateQualificationGuid}	Get a specific candidate qualification
PUT api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/qualifications/{candidateQualificationGuid}	Update a candidate qualification
POST api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/qualifications	Creates a new candidate qualification
DELETE api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/qualifications/{candidateQualificationGuid}	Delete a qualification from a candidate

CandidateAvailability

Describes a candidates availability.

API	Description
GET api/v1/candidates/availability/{itemUid}	Gets the candidate availability item by the specified UID.
GET api/v1/candidates/{candidateUid}/availability	Gets the candidate availability.
GET api/v1/candidates/{candidateUid}/availability?startDate={startDate}&endDate={endDate}	Gets the candidate availability between two dates.
POST api/v1/candidates/{candidateUid}/availability?overlap={overlap}	Creates the candidate availability.
PUT api/v1/candidates/availability/{itemUid}?overlap={overlap}	Updates the candidate availability.
DELETE api/v1/candidates/availability/{itemUid}	Deletes the candidate availability item.
DELETE api/v1/candidates/availability/{candidateUid}?date={date}	Deletes the candidate availability by date.
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/availability/{itemGuid}	Gets the candidate availability item by the specified candidate and availability guid in a customers portal
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/availability	Gets the candidate availability in a customer portal
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/availability?startDate={startDate}&endDate={endDate}	Gets the candidate availability between two dates in a given customer portal
POST api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/availability?overlap={overlap}	Creates candidate availability in a customers portal.
PUT api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/availability/{itemGuid}?overlap={overlap}	Updates the candidate availability in a customer portal.
DELETE api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/availability/{itemGuid}	Deletes the candidate availability item.
DELETE api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/availability?date={date}	Deletes the candidate availability by date.

ClientContactsTimesheets

The controller for methods associated with client contacts and timesheets

API	Description
GET api/v1/clients/contacts/{clientContactUid}/timesheets/pending	Get the timesheets by the specified timesheet status, period start and end date.
GET api/v1/clients/contacts/{clientContactUid}/timesheets/pending/paged/{page}/{pageSize}	Get the pending timesheets by period start and end date.
GET api/v1/clients/contacts/{clientContactUid}/timesheets/processed/paged/{page}/{pageSize}	Get the processed timesheets by period start and end date.
GET api/v1/clients/contacts/{clientContactUid}/timesheets/approved/paged/{page}/{pageSize}	Get the approved timesheets by period start and end date.
GET api/v1/clients/contacts/timesheets/{timesheetUid}	Gets the candidate timesheet item by the specified timesheet UID.
PUT api/v1/clients/contacts/timesheets/{timesheetUid}/approve?poNumber={poNumber}	Approve the timesheet by the specified timesheet UID.
PUT api/v1/clients/contacts/timesheets/{timesheetUid}/authorise?poNumber={poNumber}	Authorise the timesheet by the specified timesheet UID.
PUT api/v1/clients/contacts/timesheets/{timesheetUid}/reject	No documentation available.
GET api/v1/clients/contacts/timesheets/items/{itemUid}	Gets the candidate timesheet item by the timesheet item UID.

CandidateInterviews

Describes the candidate interviews

API	Description
GET api/v1/candidates/interviews/{candidateInterviewUid}	Get the candidate interview by the specified candidate interview UID.
GET api/v1/candidates/{candidateUid}/interviews	Get a list of candidate interviews for the specified candidate.
GET api/v1/vacancies/{vacancyUid}/interviews	Get a list of candidate interviews for the specified vacancy.
POST api/v1/candidates/{candidateUid}/interviews	Create a candidate interview.
PUT api/v1/candidates/interviews/{candidateInterviewUid}	Update a candidate interview.
DELETE api/v1/candidates/interviews/{candidateInterviewUid}	Delete that candidate interview.

AgentVacancies

Describes the relationship between and Agent and a Vacancy.

API	Description
POST api/v1/agents/{agentUid}/vacancies/{vacancyUid}	Creates the agent vacancy.
DELETE api/v1/agents/{agentUid}/vacancies	Deletes all vacancies for specified agent UID.
DELETE api/v1/agents/vacancies/{agentVacancyUid}	Deletes the agent vacancy.
GET api/v1/agents/{agentUid}/vacancies	Gets all vacancies by agent.
GET api/v1/agents/vacancies/{agentVacancyUid}	Gets the agent vacancy by the specified agent vacancy UID.

Candidates

Describes a registered candidate within the Eclipse Web API.

API	Description
GET api/v1/portals/{portalUid}/candidates	Gets the candidates by portal.
GET api/v1/companies/{companyUid}/candidates	Gets the candidates by company.
GET api/v1/portals/{portalUid}/candidates/{logon}/profile	Gets the candidate profile.
GET api/v1/candidates/myprofile	Gets my candidate profile.
GET api/v1/candidates/{candidateUid}/profile	Gets the candidate profile.
GET api/v1/candidates/{candidateUid}	Gets the candidate profile.
GET api/v1/candidates/{candidateUid}/photo	Gets the candidate profile photo.
PUT api/v1/candidates/{candidateUid}/profile	Updates the candidate profile.
POST api/v1/candidates/{candidateUid}/photo	Creates the candidate photo.
PUT api/v1/candidates/{candidateUid}/changeemailaddress/{emailAddress}	Changes the candidate email address.
PUT api/v1/candidates/changeemailaddress/{requestUid}	Confirms the update candidate email address.
GET api/v1/portals/{PortalUid}/candidates/paged?PageSize={PageSize}&PageNumber={PageNumber}&SearchableOnly={SearchableOnly}&CompanyUid={CompanyUid}&RefNo={RefNo}&Name={Name}&Status={Status}&StartDate={StartDate}&Location={Location}&Area={Area}&Region={Region}&Industry={Industry}&Discipline={Discipline}&UpdatedSince={UpdatedSince}&Email={Email}	Returns a list of candidates matching the given search criteria
GET api/v1/portals/{PortalUid}/customer/candidates/paged?PageSize={PageSize}&PageNumber={PageNumber}&SearchableOnly={SearchableOnly}&CompanyUid={CompanyUid}&RefNo={RefNo}&Name={Name}&Status={Status}&StartDate={StartDate}&Location={Location}&Area={Area}&Region={Region}&Industry={Industry}&Discipline={Discipline}&UpdatedSince={UpdatedSince}&Email={Email}&NotUpdatedBy={NotUpdatedBy}	No documentation available.
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}	Get a specific candidate record in the customers portal
PUT api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}	Update an existing customers candidate record
DELETE api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}	Deletes a candidate in the given customers portal
PUT api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/logon	Update the candidate logon details
GET api/v1/portals/{portalUid}/customer/candidates/{candidateGuid}/logon	No documentation available.

Disciplines

Describes a vacancy discipline.

API	Description
GET api/v1/portals/{portalUid}/disciplines/{industryUid}	Gets the disciplines by portal industry.
GET api/v1/disciplines/{disciplineUid}	Gets the discipline.
GET api/v1/portals/{portalUid}/disciplines	Gets the disciplines by portal.
PUT api/v1/disciplines/{disciplineUid}	Updates the discipline by the specified discipline UID.
POST api/v1/portals/{portalUid}/disciplines	Creates the discipline.
DELETE api/v1/disciplines/{disciplineUid}	Deletes the discipline.
GET api/v1/portals/{portalUid}/customer/industries/{industryGuid}/disciplines	Gets the disciplines by portal industry.
GET api/v1/portals/{portalUid}/customer/disciplines/{disciplineGuid}	Gets the discipline.
GET api/v1/portals/{portalUid}/customer/disciplines	Gets the disciplines by portal.
PUT api/v1/portals/{portalUid}/customer/disciplines/{disciplineGuid}	Updates the discipline by the specified discipline GUID.
POST api/v1/portals/{portalUid}/customer/disciplines	Creates the discipline.
DELETE api/v1/portals/{portalUid}/customer/disciplines/{disciplineGuid}	Deletes the discipline.

DiaryTypes

Describes the type of diary entry.

API	Description
GET api/v1/portals/{portalUid}/diarytypes	Gets the diary types.
GET api/v1/portals/{portalUid}/diarytypes/{diaryTypeUid}	Gets the type of the diary.
GET api/v1/portals/{portalUid}/diarytypes/categories	Gets the diary type categories.
GET api/v1/portals/{portalUid}/diarytypes/categories/{diaryTypeCategoryUid}	Gets the diary type category.
GET api/v1/portals/{portalUid}/categories/{diaryTypeCategoryUid}/diarytypes	Gets the diary type by category.
GET api/v1/portals/{portalUid}/customer/diarytypes/{diaryTypeGuid}	Get the diary type in the given customer portal
PUT api/v1/portals/{portalUid}/customer/diarytypes/{diaryTypeGuid}	Update a diary type in the given customer portal
POST api/v1/portals/{portalUid}/customer/diarytypes	Create a new diary type in the given portal
DELETE api/v1/portals/{portalUid}/customer/diarytypes/{diaryTypeGuid}	Delete a diary type in the given portal