GET Api/Applicant/Documents/{applicantId}?includeContent={includeContent}

Returns all documents of a certain applicant.

Request Information

URI Parameters

Name	Description	Type	Additional information
applicantId	The ID of the applicant.	integer	Required
includeContent	A value indicating whether or not to include the file contents of the documents in the response.	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

A list of documents.

Collection of ApplicantDocumentResponse

Name	Type	Additional information
Id	integer	None.
Name	string	None.
FileExtension	string	None.
Type	string	None.
Content	Collection of byte	None.
IsPublic	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "FileExtension": "sample string 3",
    "Type": "sample string 4",
    "Content": "QEA=",
    "IsPublic": true
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "FileExtension": "sample string 3",
    "Type": "sample string 4",
    "Content": "QEA=",
    "IsPublic": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfApplicantDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
  <ApplicantDocumentResponse>
    <Content xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">QEA=</Content>
    <FileExtension xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 3</FileExtension>
    <IsPublic xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">true</IsPublic>
    <Name xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 2</Name>
    <Type xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 4</Type>
    <Id>1</Id>
  </ApplicantDocumentResponse>
  <ApplicantDocumentResponse>
    <Content xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">QEA=</Content>
    <FileExtension xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 3</FileExtension>
    <IsPublic xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">true</IsPublic>
    <Name xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 2</Name>
    <Type xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 4</Type>
    <Id>1</Id>
  </ApplicantDocumentResponse>
</ArrayOfApplicantDocumentResponse>