Persons

The Persons API is a background functionality of a web client at Profit365 > Persons. With this resource you can:

  • List persons
  • Create persons
  • Update persons

Resource information

Url https://api.profit365.eu/1.6/catalogs/persons
Authentication required
Access level company
Response JSON / XML

List persons

A view is currently only way how to list persons. A pagination is used.

URL https://api.profit365.eu/1.6/catalogs/persons/{page}
Method GET
{page}

A page number of result set. Default page number is 1 and default page size is 50.
Example

https://api.profit365.eu/1.6/catalogs/persons/1

 

Search persons

It is possible to search through all the parameters of a person with this search.

URL https://api.profit365.eu/1.6/catalogs/persons/?search={query}
Method GET
{query}

String which should be searched for through all the parameters of persons.
Example

https://api.profit365.eu/1.6/catalogs/persons/?search=peter

 

Create new person

URL https://api.profit365.eu/1.6/catalogs/persons
Method POST
Example POST https://api.profit365.eu/1.6/catalogs/persons

Authorization: Basic *** hidden credentials ***
ClientID: C7A36D...
ClientSecret: j7896WnI0U1...
CompanyID: CCA256B...
Content-Type: application/json

{
"firstName": "František",
"lastName": "Veselý"
"type": "C",
"costCenterId": "3f4c57f4-3b76-400e-9e48-378ad30e097d",
}

Parameters for insert are listed here.

Update person

URL https://api.profit365.eu/1.6/catalogs/persons/{id}
Method PUT
{id}

An ID of a person.
Example

https://api.profit365.eu/1.6/catalogs/persons/830ee09f-d3c7-4170-b766-4abc26601b42

Person parameters

firstName

required

First name of a person .

Type: String

 request, response

lastName

required

Last name of a person .

Type: String

 request, response

type

required

Type of a person . Allowed values are (uppercase!) 'C' for contractor and 'E' for employee.

Type: String (1)

 request, response

costCenterId

optional

ID of a Cost center to which should the person belong.

Type: GUID

 request, response

companyCellPhone

optional

Business cell phone number of a person.

Type: String

 request, response

companyEmail

optional

Business email address of a person.

Type: String

 request, response

privateCellPhone

optional

Private cell phone number of a person.

Type: String

 request, response

privateEmail

optional

Private email address of a person.

Type: String

 request, response
  • Pubished at 11/21/2018 9:29:02 AM
  • Last edited 11/26/2018 9:01:45 AM

Back to top ↑