Users

(implementation of User entity)

Provides following method for API calls:

• Create
• Delete
• DeleteByIds
• Get
• GetAll
• GetByPersonalId
• GetCurrentUser
• GetFirstByPersonalId
• GetLoggedInUser
• SaveAll
• SaveAllAndReturnIds
• Search
• SearchFirst
• Update

Create

URL:

/api/v1/{format}/users

Method:

POST

Parameters request:

Object< User >

Parameters response:

Object

Description:

1. person(OBJECT< Person >)
2. roles(ARRAY< Role >)
3. saml2_id(STRING)
4. name(STRING)
5. id(NUMBER)

Delete

URL:

/api/v1/{format}/users/{id}

Method:

DELETE

Parameters request:

null

Parameters response:

Object

Description:

1. person(OBJECT< Person >)
2. roles(ARRAY< Role >)
3. saml2_id(STRING)
4. name(STRING)
5. id(NUMBER)

DeleteByIds

URL:

/api/v1/{format}/users

Method:

DELETE

Parameters request:

Url parameters: ids

Parameters response:

Array

Description:

1. person(OBJECT< Person >)
2. roles(ARRAY< Role >)
3. saml2_id(STRING)
4. name(STRING)
5. id(NUMBER)

Get

URL:

/api/v1/{format}/users/{id}

Method:

GET

Parameters request:

null

Parameters response:

Object

Description:

1. person(OBJECT< Person >)
2. roles(ARRAY< Role >)
3. saml2_id(STRING)
4. name(STRING)
5. id(NUMBER)

GetAll

URL:

/api/v1/{format}/users

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

1. person(OBJECT< Person >)
2. roles(ARRAY< Role >)
3. saml2_id(STRING)
4. name(STRING)
5. id(NUMBER)

GetByPersonalId

URL:

/api/v1/{format}/users

Method:

GET

Parameters request:

Url parameters: personalId

Parameters response:

Array

Description:

1. person(OBJECT< Person >)
2. roles(ARRAY< Role >)
3. saml2_id(STRING)
4. name(STRING)
5. id(NUMBER)

GetCurrentUser

URL:

/api/v1/{format}/users/current

Method:

GET

Parameters request:

null

Parameters response:

Object

Description:

1. person(OBJECT< Person >)
2. roles(ARRAY< Role >)
3. saml2_id(STRING)
4. name(STRING)
5. id(NUMBER)

GetFirstByPersonalId

URL:

/api/v1/{format}/users

Method:

GET

Parameters request:

Url parameters: personalId, first

Parameters response:

Object

Description:

1. person(OBJECT< Person >)
2. roles(ARRAY< Role >)
3. saml2_id(STRING)
4. name(STRING)
5. id(NUMBER)

GetLoggedInUser

URL:

/api/v1/{format}/users/loggedin

Method:

GET

Parameters request:

null

Parameters response:

Object

Description:

Note

This method return only 3 properties: id, person, roles.

SaveAll

URL:

/api/v1/{format}/users/saveall

Method:

POST

Parameters request:

Array< User >

Parameters response:

Array

Description:

1. person(OBJECT< Person >)
2. roles(ARRAY< Role >)
3. saml2_id(STRING)
4. name(STRING)
5. id(NUMBER)

SaveAllAndReturnIds

URL:

/api/v1/{format}/users/saveall

Method:

POST

Parameters request:

Url parameters: full

Array< User >

Parameters response:

Array

Description:

ARRAY<NUMBER>

Search

URL:

/api/v1/{format}/users/search

Method:

POST

Parameters request:

Array< SearchCriteries$SearchCriteriaResult >

Parameters response:

Array

Description:

1. person(OBJECT< Person >)
2. roles(ARRAY< Role >)
3. saml2_id(STRING)
4. name(STRING)
5. id(NUMBER)

SearchFirst

URL:

/api/v1/{format}/users/search/first

Method:

POST

Parameters request:

Array< SearchCriteries$SearchCriteriaResult >

Parameters response:

Object

Description:

1. person(OBJECT< Person >)
2. roles(ARRAY< Role >)
3. saml2_id(STRING)
4. name(STRING)
5. id(NUMBER)

Update

URL:

/api/v1/{format}/users/{id}

Method:

PUT

Parameters request:

Object< User >

Parameters response:

Object

Description:

1. person(OBJECT< Person >)
2. roles(ARRAY< Role >)
3. saml2_id(STRING)
4. name(STRING)
5. id(NUMBER)