PCRecruiter API
Search... K

Appearance

Profile ​

Description ​

The profile endpoint is used to create, update, retrieve, and delete profiles and profile templates. Profiles are forms in PCRecruiter that can be filled out internally or sent externally to candidates or clients for completion. Profiles can be styled with HTML and CSS. This endpoint also allows access to profile templates, which serve as the blueprint for these forms.

Data Parameters ​

  • HistorySaveOptions
    Specifies how history sections should be handled. Options include:

    • AppendHistory
    • ReplaceHistory
    • AppendHistoryWithoutXML
    • ReplaceHistoryWithoutXML

  • Description
    Title or name of the profile.

  • CreateType
    Determines whether new data overwrites an existing profile or creates a new one. Options include:

    • Single
    • Multiple

  • TokenId
    Identification token.

  • ProfileId
    Unique ID for the profile form.

  • NotifyList
    List of emails to notify when the form is submitted.

    • EmailAddress: Email addresses in the notify list.

  • NotifyUser
    Boolean indicating whether notifications should be sent to the notify list.

  • RecordType
    The record type associated with the profile. Options include:

    • Candidates
    • Companies
    • Positions

  • RecordId
    Unique ID for the record tied to the profile.

  • JobId
    Unique ID for the position if the profile is linked to an apply form.

  • SendoutId
    Unique ID for the interview record in an apply profile form.

  • KnockoutPlan
    Executes if a "knockout" answer is submitted.

  • SuccessPlan
    Executes if a "success" answer is submitted.

  • HTMLCustomTemplate
    Custom HTML template for the profile. This is where custom HTML and CSS formatting for the form is applied.

  • ProfileDate
    The date and time the profile was submitted.

  • Questions
    List of each question:

    • QuestionType: The type of question, such as multiple choice, dropdown, or text box.
    • QuestionText: The text displayed as the question.
    • Required: Boolean indicating whether the question is mandatory.
    • GUID: Unique ID for the question.
    • Answer: User-submitted response to the question.
    • AnswerList: Available answers for multiple-choice questions.
      • AnswerValue: An available answer option.
      • AnswerDescription: Internal-only description of the answer.
      • AnswerRollup: Indicates if the answer triggers a rollup.
    • Encrypt: Boolean specifying if the response should be encrypted.
    • KnockoutAnswer: An answer triggering a knockout plan.
    • LinkedField: Field the answer is linked to; populates the record field with the answer.
    • HTMLCustomTemplate: Custom HTML template for individual questions.

  • WorkHistory
    Answers in the work history section.

  • Military
    Answers in the military history section.

  • Licensing
    Answers in the licensing section.

  • Education
    Data submitted for the education history section.

  • References
    List of references and their details.

  • Work_History_Layout
    Layout of the "Work History" section.

  • Military_Layout
    Layout of the "Military History" section.

  • Licensing_Layout
    Layout of the "Licensing" section.

  • Education_Layout
    Layout of the "Education History" section.

  • References_Layout
    Layout of reference data requested in the references section.

Examples ​

------------------ REQUEST ------------------- ​

json
GET /rest/api/profile/{ProfileId}

{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/Profile/{ProfileId}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}

------------------ RESPONSE ------------------ ​

json
{
  "HistorySaveOptions": "ReplaceHistoryWithoutXML",
  "Description": "Candidate Application form",
  "CreateType": "SINGLE",
  "TokenId": null,
  "ProfileId": "ProfileId",
  "NotifyList": [
    {
      "EmailAddress": "support@mainsequence.net"
    }
  ],
  "NotifyUser": true,
  "RecordType": "RECORD_TYPE_CANDIDATES",
  "RecordId": "RecordId",
  "JobId": null,
  "SendoutId": null,
  "KnockoutPlan": "",
  "SuccessPlan": "",
  "HTMLCustomTemplate": "",
  "ProfileDate": "2019-03-25T06:56:48",
  "Questions": [
    {
      "QuestionType": "R1",
      "QuestionText": "Have you applied for a position at Main Sequence Technology previously?",
      "Required": false,
      "GUID": "[F31AB984-AC83-4B25-8218-AD06448A1E3A]",
      "Answer": "Yes",
      "AnswerList": [
        { "AnswerValue": "Yes", "AnswerDescription": "Yes", "AnswerRollup": null },
        { "AnswerValue": "No", "AnswerDescription": "No", "AnswerRollup": null }
      ],
      "Encrypt": false,
      "KnockoutAnswer": "Yes",
      "LinkedField": "",
      "HTMLCustomTemplate": null
    }
  ],
  "WorkHistory": [],
  "Military": [],
  "Licensing": [],
  "Education": [],
  "References": [],
  "Work_History_Layout": null,
  "Military_Layout": null,
  "Licensing_Layout": null,
  "Education_Layout": null,
  "References_Layout": null
}

TIP

This API call will retrieve a filled-out profile form using the unique profile id provided in the URL of the API call.

Template Request Example ​

------------------ REQUEST ------------------- ​

json
GET /rest/api/profile/template/{ProfileId}
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/Profile/Template/{ProfileId}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}

------------------ RESPONSE ------------------ ​

json
{
  "ProfileTemplateId": "162186032463626",
  "Description": "Internal Candidate Review Form",
  "Introduction": "",
  "Conclusion": "",
  "ProfileFormat": "PROFILE",
  "ProfileScore": "PROFILE",
  "ProfileDate": "2020-02-03T14:26:45.313",
  "Qrollup": "",
  "Frollup": "",
  "Results": "",
  "ProfileActType": "PROFILESUBMIT",
  "DefaultMail": "N",
  "HTMLCustomTemplate": "",
  "AllowUpdate": true,
  "CreateType": "MULTIPLE",
  "NotifyUser": true,
  "xmlurl": "",
  "xmlurlsd": "Y",
  "SendEmailAttachmentOnCreate": true,
  "KnockoutPlan": "",
  "SuccessPlan": "",
  "RollupRemove": "",
  "WrapperOptions": "",
  "Questions": [
    {
      "QuestionText": "Date:",
      "QuestionType": "S1",
      "AnswerList": [],
      "DesiredAnswer": null,
      "Required": false,
      "Points": null,
      "RollupList": null,
      "Timer": null,
      "LinkedField": "",
      "Encrypt": "False",
      "Knockout": "D",
      "GUID": "[678A3A64-5FAF-4D1A-9C10-3A278A58914C]"
    }
  ],
  "NotifyList": [
    {
      "EmailAddress": "support@mainsequence.net"
    }
  ]
}

TIP

This API call will retrieve the empty profile template. This will help provide the layout of questions, answers, required questions and notification settings to submit a filled-out profile using POST on the /profile endpoint for a record id.