PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

people

Retrieves a people resource.

Retrieves a people resource.

Authorizations:
JWT
path Parameters
id
required
string

people identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "companyType": {
    },
  • "currency": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "notes": "string",
  • "shortcode": "U",
  • "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",
  • "personFullName": "string",
  • "inventoryEntriesListing": "string",
  • "personDefaultCoordinate": null,
  • "corporationsListing": "string",
  • "coordinatesListing": "string",
  • "billsListing": "string",
  • "userListing": "string",
  • "followupsListing": "string",
  • "partnerListing": "string",
  • "clientListing": "string",
  • "competitorListing": "string",
  • "contactListing": "string",
  • "applicantListing": "string",
  • "prospectListing": "string",
  • "shipperListing": "string",
  • "employeeListing": "string",
  • "supplierListing": "string",
  • "personSkillsListing": "string",
  • "authorNotesListing": "string",
  • "participantNotesListing": "string",
  • "approvalsListing": "string",
  • "authorCommentsListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the people resource.

Replaces the people resource.

Authorizations:
JWT
path Parameters
id
required
string

people identifier

Request Body schema:
required

The updated people resource

timestamp
string <date-time>
person_companytypes.jsonld-add_post (object) or null
Array of objects (users.jsonld-add_post)

Get user's login

Array of objects (person_partners.jsonld-add_post)
Array of objects (person_employees.jsonld-add_post)

Get employee.

Array of objects (person_clients.jsonld-add_post)
Array of objects (person_contacts.jsonld-add_post)
Array of objects (person_suppliers.jsonld-add_post)

Get supplier.

Array of objects (shipping_shippers.jsonld-add_post)

Get shipper.

Array of objects (person_competitors.jsonld-add_post)
Array of objects (person_prospects.jsonld-add_post)
Array of objects (person_applicants.jsonld-add_post)
Array of objects (person_corporations.jsonld-add_post)
object (fee_currencies.jsonld-add_post)

Get currency.

firstName
string or null
lastName
required
string or null
notes
string or null
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
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "companyType": {
    },
  • "user": [
    ],
  • "partner": [
    ],
  • "employee": [
    ],
  • "client": [
    ],
  • "contact": [
    ],
  • "supplier": [
    ],
  • "shipper": [
    ],
  • "competitor": [
    ],
  • "prospect": [
    ],
  • "applicant": [
    ],
  • "corporation": [
    ],
  • "currency": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "notes": "string",
  • "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",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "companyType": {
    },
  • "currency": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "notes": "string",
  • "shortcode": "U",
  • "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",
  • "personFullName": "string",
  • "inventoryEntriesListing": "string",
  • "personDefaultCoordinate": null,
  • "corporationsListing": "string",
  • "coordinatesListing": "string",
  • "billsListing": "string",
  • "userListing": "string",
  • "followupsListing": "string",
  • "partnerListing": "string",
  • "clientListing": "string",
  • "competitorListing": "string",
  • "contactListing": "string",
  • "applicantListing": "string",
  • "prospectListing": "string",
  • "shipperListing": "string",
  • "employeeListing": "string",
  • "supplierListing": "string",
  • "personSkillsListing": "string",
  • "authorNotesListing": "string",
  • "participantNotesListing": "string",
  • "approvalsListing": "string",
  • "authorCommentsListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Removes the people resource.

Removes the people resource.

Authorizations:
JWT
path Parameters
id
required
string

people identifier

Responses