API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

person_applicants

Retrieves the collection of person_applicants resources.

Retrieves the collection of person_applicants resources.

Authorizations:
JWT
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

exists[deletedAt]
boolean
exists[customProperties]
boolean
exists[disabledAt]
boolean
properties[]
Array of strings

Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

enabled
boolean

Filter entities by enabled (1), disabled (0), or all (nothing).

search
string
tag
string

Filter using tag.

order[dateEntry]
string
Default: "asc"
Enum: "asc" "desc"
order[deletedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[createdAt]
string
Default: "asc"
Enum: "asc" "desc"
order[updatedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[disabledAt]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[expertise]
string
Default: "asc"
Enum: "asc" "desc"
order[personality]
string
Default: "asc"
Enum: "asc" "desc"
order[potential]
string
Default: "asc"
Enum: "asc" "desc"
order[desiredSalary]
string
Default: "asc"
Enum: "asc" "desc"
order[desiredTime]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
dateEntry[before]
string
dateEntry[strictly_before]
string
dateEntry[after]
string
dateEntry[strictly_after]
string
deletedAt[before]
string
deletedAt[strictly_before]
string
deletedAt[after]
string
deletedAt[strictly_after]
string
desiredSalary_range[between]
string
desiredSalary_range[gt]
string
desiredSalary_range[gte]
string
desiredSalary_range[lt]
string
desiredSalary_range[lte]
string
desiredSalary
string
desiredSalary[]
Array of strings
desiredTime_range[between]
string
desiredTime_range[gt]
string
desiredTime_range[gte]
string
desiredTime_range[lt]
string
desiredTime_range[lte]
string
desiredTime
string
desiredTime[]
Array of strings
disabledAt[before]
string
disabledAt[strictly_before]
string
disabledAt[after]
string
disabledAt[strictly_after]
string
expertise_end_with
string
expertise_partial
string
expertise_start_with
string
expertise
string
expertise[]
Array of strings
id_range[between]
string
id_range[gt]
string
id_range[gte]
string
id_range[lt]
string
id_range[lte]
string
id
integer
id[]
Array of integers
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
person
string
person[]
Array of strings
personality_end_with
string
personality_partial
string
personality_start_with
string
personality
string
personality[]
Array of strings
potential_range[between]
string
potential_range[gt]
string
potential_range[gte]
string
potential_range[lt]
string
potential_range[lte]
string
potential
string
potential[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
status
string
status[]
Array of strings
type
string
type[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
workingType
string
workingType[]
Array of strings

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a person_applicants resource.

Creates a person_applicants resource.

Authorizations:
JWT
Request Body schema:
required

The new person_applicants resource

required
object (hr_statuses.jsonld-add_post)

Status.

required
object (people.jsonld-add_post)

Person.

dateEntry
string <date-time>
notes
string
expertise
string
personality
string
potential
required
string
desiredSalary
required
string
desiredTime
required
string
Default: 40
object (person_employee_types.jsonld-add_post)

EmployesTypes.

object (person_workingtypes.jsonld-add_post)

EmployesWorkingTypes.

deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>

Responses

Request samples

Content type
{
  • "status": {
    },
  • "person": {
    },
  • "dateEntry": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "expertise": "string",
  • "personality": "string",
  • "potential": "string",
  • "desiredSalary": "string",
  • "desiredTime": 40,
  • "type": {
    },
  • "workingType": {
    },
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "status": {
    },
  • "person": {
    },
  • "dateEntry": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "expertise": "string",
  • "personality": "string",
  • "potential": "string",
  • "desiredSalary": "string",
  • "desiredTime": 40,
  • "type": {
    },
  • "workingType": {
    },
  • "owningCorporation": {
    },
  • "shortcode": "CA",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}