API - DistinctFields - Data Type of the Fields

Tagged:

Currently contains 4 posts

Avatar

May 22, 2019 11:10

Vonage_gUDev

Hi

The DistinctFields API returns the standard non-custom fields for the specified record.
https://www.pcrecruiter.net/rest/api/candidates/DistinctFields

Is it possible to get details about each field in the record like
-
- Field Label
- Whether the field is a required field
- the data type of the field
- whether the field is part of the Layout if there is Layout Customization

These details will help the us to populate the fields accordingly and send the appropriate fields while calling the API.

Avatar

May 22, 2019 14:44

Jarrid-PCRecruiter

Unfortunately that’s not possible using the DistinctFields end-point. For field labels and data types you can see them under Resource Definitions for GET /candidates (or companies/positions) and GET /system/customfields. You cannot tell if a field is set as required nor can you tell which fields are customized on the user’s layouts via the API. I apologize for any inconvenience please let us know if you have additional questions.

Avatar

May 22, 2019 17:35

Vonage_gUDev

Hi

Thanks for the quick response.

Are you referring to the Model under Resource Definition to get the Field Names?
Also, these refer to Field Ids – Can we get the corresponding Field Label that will be shown in PCRecruiter UI for these fields.
These seem to also include System Fields like lastModifiedDate
- Is it possible to distinguish between System Fields and UI Fields?

lass Candidate(CandidateId: long, CompanyId: long, CompanyName: string, CompanyUserName: string, FirstName: string, LastName: string, MiddleInitial: string, Salutation: string, Title: string, Address: string, Address2: string, City: string, State: string, PostalCode: string, PostalCodeExtension: string, County: string, Country: string, HomePhone: string, FaxPhone: string, Pager: string, MobilePhone: string, WorkPhone: string, Relocate: string, CurrentSalary: Currency, DesiredSalary: Currency, School: string, DegreeType: string, GradYear: string, DateEntered: date, EmailAddress: string, Industry: string, Specialty: string, Status: string = [‘OnAssignment’ or ‘Candidate’ or ‘Employee’ or ‘Internal’ or ‘HiringAuthority’ or ‘Manager’ or ‘OfferAccepted’ or ‘Placed’ or ‘ContractorTemp’ or ‘DevelopedQualified’ or ‘Submitted’ or ‘Unverified’ or ‘Reference’ or ‘Vendor’ or ‘Not Available’] {Candidate Status}, ShowOnWebRollup: string, Subjective: double, HasResume: boolean, NoteFlag: boolean, OptOut: boolean, ProfileLine1: string, ProfileLine2: string, ProfileLine3: string, ProfileLine4: string, ProfileLine5: string, ProfileLine6: string, ProfileLine7: string, ProfileLine8: string, ProfileLine9: string, Keywords: string, Notes: string, Identification: string, LastActivity: date, LastModified: date, Available: date, BillRate: Currency, PayRate: Currency, DefaultCurrency: string, UserName: string, Photograph: string, PhotographThumb: string, Group: string = [‘Group1’ or ‘Group2’ or ‘VisibleOnInternet’ or ‘Coop’ or ‘Unsolicited’] {Candidate Group}, Summary: string, ResumeText: string, RollupListMembership: Array[RollupListMember], CustomFields: Array[CustomField], EEOC: Array[EeocField])

Avatar

May 22, 2019 18:12

Jarrid-PCRecruiter

Yes, the only fields that aren’t available via the UI are CompanyId, CandidateId and PositionId (unless someone created custom fields using those names) they don’t have field labels since they’re for backend use only (primary/foreign keys).

Reply to thread