Candidate Documents

Retrieves a list of Documents for specific candidate

get/candidate/{candidate_id}/documents

Request

  • Base URL
    http://localhost:3010/v1
  • URL
    http://localhost:3010/v1/candidate/{candidate_id}/documents
  • Auth
    HTTP basic

Query parameters

pageinteger

The page of documents to be displayed

items_per_pageinteger

The number of documents per page

_idstring[]

Filter on the document id of the record

namestring

Filter on the given file name

statusstring

Filter on document status

uploaded_by_idstring

Filter on the id of the entity that uploaded the document

uploaded_by_typestring

Filter on the type of the entity that uploaded the document

uploaded_by_namestring

Filter on the name of the entity that uploaded the document

system_document_type_idstring

Filter on the type of the id of the system document is linked to

sortBystring[]

A comma separated list of fields indicating sort order name, a negative sign reverses direction -name

Response

All Documents will be returned for specific candidate

_idstring required
updated_atstring date-time required
created_atstring date-time required
__vinteger required
namestring required
statusstring required
system_document_type_idstring

Changes

No recorded changes to this operation across all 3 revisions of this API.