TalentSee Internal API

APIs

• POST v2/Auth/SignIn

  Parameters

  • inviteToken: (String)

  Response

  • • WasSuccessful : (Boolean)
    • ErrorMessages : (IEnumerable`1)
    • Candidate : (CandidateView)
    • • FirstName : (String)
      • LastName : (String)
      • EmailAddress : (String)
      • ExternalId : (String)
      • AccountId : (Guid)
      • Id : (Guid)
      • Created : (EntityCreated)
      • CreatedDate : (DateTime)
      • LastUpdated : (DateTime)
      • SubscriptionId : (Guid)
      • SoftDeleted : (Boolean)
    • CandidateInterviewInvite : (CandidateInterviewInviteView)
    • • InterviewId : (Guid)
      • CandidateId : (Guid)
      • AccessCode : (String)
      • Status : (CandidateInterviewInviteStatus)
      • ExpiryDate : (DateTimeOffset)
      • Id : (Guid)
      • Created : (EntityCreated)
      • CreatedDate : (DateTime)
      • LastUpdated : (DateTime)
      • SubscriptionId : (Guid)
      • SoftDeleted : (Boolean)

• POST v2/video/upload

  Response

  • • VideoGuid : (String)

• GET v2/video/download/{videoKey}

  Parameters

  • videoKey: (String)

  Response

• GET v2/video/GetVideo/{videoKey}

  Parameters

  • videoKey: (String)

• POST v2/video/CreateVideo

  Parameters

  • createVideoModel: (CreateVideoModel)
  • • VideoKey : (String)
    • Width : (Int32 (Nullable))
    • Height : (Int32 (Nullable))
    • VideoSource : (VideoSource)

• GET v2/video/GetSettings

• POST v2/video/CreateHtml5VideoBlob

• GET v2/VideoInterview/GetInterviews/{candidateId}/{interviewId}

  Parameters

  • candidateId: (Guid)
  • interviewId: (Guid)

  Response

  • • Id : (Guid)
    • CandidateName : (String)
    • WasSuccessful : (Boolean)
    • ErrorMessages : (IEnumerable`1)
    • Interview : (InterviewSummaryModel)
    • • Id : (Guid)
      • Name : (String)
      • Description : (String)
      • IsLockedToMobileDevice : (Boolean)
      • ClientTermsConditionUrl : (String)
      • ClientName : (String)

• GET v2/VideoInterview/GetCandidateInterview/{candidateId}/{interviewId}/{deviceLockCode}

  Parameters

  • candidateId: (Guid)
  • interviewId: (Guid)
  • deviceLockCode: (Guid (Nullable))

  Response

  • • Id : (Guid)
    • CurrentStep : (Guid)
    • CurrentInterviewStepType : (InterviewStepType)
    • NextStep : (Guid)
    • InterviewId : (Guid)
    • InterviewName : (String)
    • CandidateName : (String)
    • InterviewDescription : (String)
    • Steps : (IEnumerable`1)
    • CandidateCanStartInterview : (Boolean)
    • ErrorMessage : (String)
    • CurrentQuestionId : (Guid (Nullable))
    • ErrorMessages : (IEnumerable`1)
    • BrandBackgroundColor : (String)
    • BrandHeadingColor : (String)
    • BrandButtonBgColor : (String)
    • BrandButtonBgColorHover : (String)
    • BrandLogoUrl : (String)
    • Locked : (Boolean)
    • AllQuestionsAnswered : (Boolean)
    • HasBeenCompletedByCandidate : (Boolean)
    • CanViewInterview : (Boolean)
    • BrandLogo : (String)
    • BrandMenuFontColor : (String)
    • BrandHelpBgColor : (String)

• GET v2/VideoInterview/GetCompleteInterview/{interviewId}

  Parameters

  • interviewId: (Guid)

  Response

  • • Id : (Guid)
    • Name : (String)
    • Description : (String)
    • Steps : (List`1)
    • • Capacity : (Int32)
      • Count : (Int32)
      • Item : (InterviewStepApi)
      • • Id : (Guid)
        • InterviewId : (Guid)
        • StepNumber : (Int32)
        • StepTitle : (String)
        • Resumable : (Boolean)
        • Content : (String)
        • StepType : (InterviewStepType)
        • Include : (Boolean)
        • HasVideo : (Boolean)
        • VideoKey : (String)
        • CandidateInterviewStatus : (CandidateInterviewStatusEnum)
        • EligibilityCriteriaId : (Guid)
        • PracticeQuestion : (QuestionSummaryAPIModel)
        • • Id : (Guid)
          • Complete : (Boolean)
          • Repeatable : (Boolean)
          • ReadDuration : (Int32 (Nullable))
          • AnswerDuration : (Int32 (Nullable))
          • AnswerMinDuration : (Int32 (Nullable))
          • HasVideo : (Boolean)
          • LogicalOrder : (Int32)
          • QuestionText : (String)
        • Questions : (List`1)
        • • Capacity : (Int32)
          • Count : (Int32)
          • Item : (QuestionSummaryAPIModel)
          • • Id : (Guid)
            • Complete : (Boolean)
            • Repeatable : (Boolean)
            • ReadDuration : (Int32 (Nullable))
            • AnswerDuration : (Int32 (Nullable))
            • AnswerMinDuration : (Int32 (Nullable))
            • HasVideo : (Boolean)
            • LogicalOrder : (Int32)
            • QuestionText : (String)
        • NextAvailableQuestionId : (Guid (Nullable))
        • WasSuccessful : (Boolean)
        • ErrorMessages : (IEnumerable`1)
        • Index : (Int32)
        • VideoDownloadUrl : (String)
    • Questions : (List`1)
    • • Capacity : (Int32)
      • Count : (Int32)
      • Item : (QuestionApi)
      • • Id : (Guid)
        • InterviewId : (Guid)
        • QuestionText : (String)
        • QuestionNumber : (String)
        • ReadDuration : (Int32)
        • AnswerDuration : (Int32)
        • AnswerMinDuration : (Int32)
        • Repeatable : (Boolean)
        • LogicalOrder : (Int32)
        • HasVideo : (Boolean)
        • VideoKey : (String)
        • VideoDownloadUrl : (String)
    • EligibilityCriteria : (EligibilityCriteriaAPIModel)
    • • Id : (Guid)
      • InstructionText : (String)
      • PassText : (String)
      • FailText : (String)
      • PassMark : (Double)
      • Criterions : (List`1)
      • • Capacity : (Int32)
        • Count : (Int32)
        • Item : (EligibilityCriterionAPIModel)
        • • Id : (Guid)
          • CriterionText : (String)
          • LogicalOrder : (Int32)
          • CriterionAnswers : (List`1)
          • • Capacity : (Int32)
            • Count : (Int32)
            • Item : (EligibilityCriterionAnswerApiModel)
            • • Id : (Guid)
              • AnswerText : (String)
              • LogicalOrder : (Int32)
              • Deleted : (Boolean)
              • Value : (Int32)
          • Number : (Int32)
    • PracticeQuestion : (QuestionApi)
    • • Id : (Guid)
      • InterviewId : (Guid)
      • QuestionText : (String)
      • QuestionNumber : (String)
      • ReadDuration : (Int32)
      • AnswerDuration : (Int32)
      • AnswerMinDuration : (Int32)
      • Repeatable : (Boolean)
      • LogicalOrder : (Int32)
      • HasVideo : (Boolean)
      • VideoKey : (String)
      • VideoDownloadUrl : (String)

• POST v2/VideoInterview/LockCandidateInterviewToDevice

  Parameters

  • requestData: (LockCandidateInterviewRequest)
  • • CandidateInterviewId : (Guid)

  Response

  • • DeviceLockCode : (Guid)
    • WasSuccessful : (Boolean)
    • ErrorMessages : (ICollection`1)
    • • Count : (Int32)
      • IsReadOnly : (Boolean)

• POST v2/VideoInterview/MoveToStep

  Parameters

  • requestData: (MoveToStepRequest)
  • • CandidateInterviewId : (Guid)
    • StepId : (Guid)

  Response

  • • Id : (Guid)
    • InterviewId : (Guid)
    • StepNumber : (Int32)
    • StepTitle : (String)
    • Resumable : (Boolean)
    • Content : (String)
    • StepType : (InterviewStepType)
    • Include : (Boolean)
    • HasVideo : (Boolean)
    • VideoKey : (String)
    • CandidateInterviewStatus : (CandidateInterviewStatusEnum)
    • EligibilityCriteriaId : (Guid)
    • PracticeQuestion : (QuestionSummaryAPIModel)
    • • Id : (Guid)
      • Complete : (Boolean)
      • Repeatable : (Boolean)
      • ReadDuration : (Int32 (Nullable))
      • AnswerDuration : (Int32 (Nullable))
      • AnswerMinDuration : (Int32 (Nullable))
      • HasVideo : (Boolean)
      • LogicalOrder : (Int32)
      • QuestionText : (String)
    • Questions : (List`1)
    • • Capacity : (Int32)
      • Count : (Int32)
      • Item : (QuestionSummaryAPIModel)
      • • Id : (Guid)
        • Complete : (Boolean)
        • Repeatable : (Boolean)
        • ReadDuration : (Int32 (Nullable))
        • AnswerDuration : (Int32 (Nullable))
        • AnswerMinDuration : (Int32 (Nullable))
        • HasVideo : (Boolean)
        • LogicalOrder : (Int32)
        • QuestionText : (String)
    • NextAvailableQuestionId : (Guid (Nullable))
    • WasSuccessful : (Boolean)
    • ErrorMessages : (IEnumerable`1)
    • Index : (Int32)
    • VideoDownloadUrl : (String)

• GET v2/VideoInterview/GetStep/{stepId}

  Parameters

  • stepId: (Guid)

  Response

  • • Id : (Guid)
    • InterviewId : (Guid)
    • StepNumber : (Int32)
    • StepTitle : (String)
    • Resumable : (Boolean)
    • Content : (String)
    • StepType : (InterviewStepType)
    • Include : (Boolean)
    • HasVideo : (Boolean)
    • VideoKey : (String)
    • CandidateInterviewStatus : (CandidateInterviewStatusEnum)
    • EligibilityCriteriaId : (Guid)
    • PracticeQuestion : (QuestionSummaryAPIModel)
    • • Id : (Guid)
      • Complete : (Boolean)
      • Repeatable : (Boolean)
      • ReadDuration : (Int32 (Nullable))
      • AnswerDuration : (Int32 (Nullable))
      • AnswerMinDuration : (Int32 (Nullable))
      • HasVideo : (Boolean)
      • LogicalOrder : (Int32)
      • QuestionText : (String)
    • Questions : (List`1)
    • • Capacity : (Int32)
      • Count : (Int32)
      • Item : (QuestionSummaryAPIModel)
      • • Id : (Guid)
        • Complete : (Boolean)
        • Repeatable : (Boolean)
        • ReadDuration : (Int32 (Nullable))
        • AnswerDuration : (Int32 (Nullable))
        • AnswerMinDuration : (Int32 (Nullable))
        • HasVideo : (Boolean)
        • LogicalOrder : (Int32)
        • QuestionText : (String)
    • NextAvailableQuestionId : (Guid (Nullable))
    • WasSuccessful : (Boolean)
    • ErrorMessages : (IEnumerable`1)
    • Index : (Int32)
    • VideoDownloadUrl : (String)

• GET v2/VideoInterview/GetQuestion/{questionId}

  Parameters

  • questionId: (Guid)

  Response

  • • Id : (Guid)
    • InterviewId : (Guid)
    • QuestionText : (String)
    • QuestionNumber : (String)
    • ReadDuration : (Int32)
    • AnswerDuration : (Int32)
    • AnswerMinDuration : (Int32)
    • Repeatable : (Boolean)
    • LogicalOrder : (Int32)
    • HasVideo : (Boolean)
    • VideoKey : (String)
    • VideoDownloadUrl : (String)

• GET v2/VideoInterview/GetEligibilityCriteria/{candidateInterviewId}

  Parameters

  • candidateInterviewId: (Guid)

  Response

  • • Id : (Guid)
    • InstructionText : (String)
    • PassText : (String)
    • FailText : (String)
    • PassMark : (Double)
    • Criterions : (List`1)
    • • Capacity : (Int32)
      • Count : (Int32)
      • Item : (EligibilityCriterionAPIModel)
      • • Id : (Guid)
        • CriterionText : (String)
        • LogicalOrder : (Int32)
        • CriterionAnswers : (List`1)
        • • Capacity : (Int32)
          • Count : (Int32)
          • Item : (EligibilityCriterionAnswerApiModel)
          • • Id : (Guid)
            • AnswerText : (String)
            • LogicalOrder : (Int32)
            • Deleted : (Boolean)
            • Value : (Int32)
        • Number : (Int32)

• GET v2/VideoInterview/GetCandidateInterviewCompleteStepContent/{interviewId}/{candidateId}

  Parameters

  • interviewId: (Guid)
  • candidateId: (Guid)

  Response

  • String

• POST v2/VideoInterview/ProcessEligibilityCriteria

  Parameters

  • requestData: (CandidateEligibilityAnswersAPIModel)
  • • CandidateInterviewId : (Guid)
    • Answers : (List`1)
    • • Capacity : (Int32)
      • Count : (Int32)
      • Item : (CandidateEligibilityAnswerAPIModel)
      • • EligibilityCriterionId : (Guid)
        • EligibilityCriterionAnswerId : (Guid)

  Response

  • Boolean

• POST v2/VideoInterview/StartCandidateInterview/{interviewId}/{candidateId}

  Parameters

  • interviewId: (Guid)
  • candidateId: (Guid)

  Response

  • Boolean

• POST v2/VideoInterview/ProcessAnswer

  Parameters

  • requestData: (CandidateAnswerAPIModel)
  • • CandidateInterviewId : (Guid)
    • QuestionId : (Guid)
    • ReadDurationTaken : (Int32)
    • AnswerDurationTaken : (Int32)
    • VideoKey : (String)
    • VideoId : (String)

• GET v2/VideoInterview/GetCandidateInterviewAnswers/{candidateInterviewId}

  Parameters

  • candidateInterviewId: (Guid)

  Response

• POST v2/VideoInterview/StoreProfileSnapshotFromNimbb

  Parameters

  • requestData: (StoreProfileSnapshotFromNimbbRequest)
  • • CandidateInterviewId : (Guid)
    • InterviewId : (Guid)
    • VideoThumbnailUrl : (String)

  Response

  • • WasSuccessful : (Boolean)
    • ErrorMessages : (IEnumerable`1)
    • SuccessMessage : (String)

• POST v2/VideoInterview/StoreProfileSnapshot

  Parameters

  • requestData: (StoreProfileSnapshotRequest)
  • • CandidateInterviewId : (Guid)
    • InterviewId : (Guid)
    • Base64Image : (String)

  Response

  • • WasSuccessful : (Boolean)
    • ErrorMessages : (IEnumerable`1)
    • SuccessMessage : (String)

• POST v2/VideoInterview/ReportAProblem

  Parameters

  • requestData: (CandidateProblemModel)
  • • CandidateId : (Guid (Nullable))
    • BrowserName : (String)
    • Version : (String)
    • Html5GetUserMediaSupport : (Boolean)
    • CandidateFirstName : (String)
    • CandidateLastName : (String)
    • Message : (String)
    • InterviewId : (Guid (Nullable))

  Response

  • • WasSuccessful : (Boolean)
    • ErrorMessages : (IEnumerable`1)
    • SuccessMessage : (String)

• GET v2/VideoInterview/GetImage/{imageBlobName}

  Parameters

  • imageBlobName: (String)