Persons¶
(implementation of Person entity)
Provides following method for API calls:
- Create
- Delete
- DeleteByIds
- FindByCriteria
- Get
- GetAll
- GetByPersonalId
- GetCurrentPerson
- GetFirstByPersonalId
- GetPersonRolesByPerson
- GetPersonRolesOfCurrentPerson
- GetSchoolClassesByPerson
- GetSchoolClassesOfCurrentPerson
- GetSchoolsByPerson
- GetSchoolsOfCurrentPerson
- GetWorkRolesByPerson
- GetWorkRolesOfCurrentPerson
- SaveAll
- SaveAllAndReturnIds
- Search
- SearchFirst
- Update
Create¶
URL:¶
/api/v1/{format}/persons
Method:¶
POST
Parameters response:¶
Object
Description:
- personal_id(STRING)
- first_name(STRING)
- last_name(STRING)
- addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
- emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
- phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
- id(NUMBER)
Delete¶
URL:¶
/api/v1/{format}/persons/{id}
Method:¶
DELETE
Parameters request:¶
null
Parameters response:¶
Object
Description:
- personal_id(STRING)
- first_name(STRING)
- last_name(STRING)
- addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
- emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
- phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
- id(NUMBER)
DeleteByIds¶
URL:¶
/api/v1/{format}/persons
Method:¶
DELETE
Parameters request:¶
Url parameters: ids
Parameters response:¶
Array
Description:
- personal_id(STRING)
- first_name(STRING)
- last_name(STRING)
- addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
- emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
- phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
- id(NUMBER)
FindByCriteria¶
URL:¶
/api/v1/{format}/persons
Method:¶
GET
Parameters request:¶
Url parameters: search_text, order_by
Parameters response:¶
Array
Description:
- personal_id(STRING)
- first_name(STRING)
- last_name(STRING)
- addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
- emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
- phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
- id(NUMBER)
Get¶
URL:¶
/api/v1/{format}/person/{id}
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Object
Description:
- personal_id(STRING)
- first_name(STRING)
- last_name(STRING)
- addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
- emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
- phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
- id(NUMBER)
GetAll¶
URL:¶
/api/v1/{format}/persons
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Array
Description:
- personal_id(STRING)
- first_name(STRING)
- last_name(STRING)
- addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
- emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
- phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
- id(NUMBER)
GetByPersonalId¶
URL:¶
/api/v1/{format}/persons
Method:¶
GET
Parameters request:¶
Url parameters: personalId
Parameters response:¶
Array
Description:
- personal_id(STRING)
- first_name(STRING)
- last_name(STRING)
- addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
- emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
- phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
- id(NUMBER)
GetCurrentPerson¶
URL:¶
/api/v1/{format}/person/current
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Object
Description:
- personal_id(STRING)
- first_name(STRING)
- last_name(STRING)
- addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
- emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
- phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
- id(NUMBER)
GetFirstByPersonalId¶
URL:¶
/api/v1/{format}/persons
Method:¶
GET
Parameters request:¶
Url parameters: personalId, first
Parameters response:¶
Object
Description:
- personal_id(STRING)
- first_name(STRING)
- last_name(STRING)
- addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
- emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
- phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
- id(NUMBER)
GetPersonRolesByPerson¶
URL:¶
/api/v1/{format}/person/{id}/personroles
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Array
Description:
- person(OBJECT< Person >)
- role(OBJECT< WorkRole >)
- school(OBJECT< School >)
- school_class(OBJECT< SchoolClass >)
- date_from(NUMBER(Date representation wrapped))
- date_to(NUMBER(Date representation wrapped))
- id(NUMBER)
GetPersonRolesOfCurrentPerson¶
URL:¶
/api/v1/{format}/person/current/personroles
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Array
Description:
- person(OBJECT< Person >)
- role(OBJECT< WorkRole >)
- school(OBJECT< School >)
- school_class(OBJECT< SchoolClass >)
- date_from(NUMBER(Date representation wrapped))
- date_to(NUMBER(Date representation wrapped))
- id(NUMBER)
GetSchoolClassesByPerson¶
URL:¶
/api/v1/{format}/person/{id}/schoolclasses
Method:¶
GET
Parameters request:¶
null
GetSchoolClassesOfCurrentPerson¶
URL:¶
/api/v1/{format}/person/current/schoolclasses
Method:¶
GET
Parameters request:¶
null
GetSchoolsByPerson¶
URL:¶
/api/v1/{format}/person/{id}/schools
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Array
Description:
- school_id(STRING)
- services(ARRAY< ServiceTypeEnum >)
- school_classes(ARRAY< SchoolClass >)
- after_school_center_sections(ARRAY< AfterSchoolCenterSection >)
- name(STRING)
- id(NUMBER)
GetSchoolsOfCurrentPerson¶
URL:¶
/api/v1/{format}/person/current/schools
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Array
Description:
- school_id(STRING)
- services(ARRAY< ServiceTypeEnum >)
- school_classes(ARRAY< SchoolClass >)
- after_school_center_sections(ARRAY< AfterSchoolCenterSection >)
- name(STRING)
- id(NUMBER)
GetWorkRolesByPerson¶
URL:¶
/api/v1/{format}/person/{id}/workroles
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Array
Description:
- name(STRING)
- id(NUMBER)
GetWorkRolesOfCurrentPerson¶
URL:¶
/api/v1/{format}/person/current/workroles
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Array
Description:
- name(STRING)
- id(NUMBER)
SaveAll¶
URL:¶
/api/v1/{format}/persons/saveall
Method:¶
POST
Parameters response:¶
Array
Description:
- personal_id(STRING)
- first_name(STRING)
- last_name(STRING)
- addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
- emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
- phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
- id(NUMBER)
SaveAllAndReturnIds¶
URL:¶
/api/v1/{format}/persons/saveall
Method:¶
POST
Parameters response:¶
Array
- Description:
- ARRAY<NUMBER>
Search¶
URL:¶
/api/v1/{format}/persons/search
Method:¶
POST
Parameters request:¶
Array< SearchCriteries$SearchCriteriaResult >
Parameters response:¶
Array
Description:
- personal_id(STRING)
- first_name(STRING)
- last_name(STRING)
- addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
- emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
- phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
- id(NUMBER)
SearchFirst¶
URL:¶
/api/v1/{format}/persons/search/first
Method:¶
POST
Parameters request:¶
Array< SearchCriteries$SearchCriteriaResult >
Parameters response:¶
Object
Description:
- personal_id(STRING)
- first_name(STRING)
- last_name(STRING)
- addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
- emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
- phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
- id(NUMBER)
Update¶
URL:¶
/api/v1/{format}/persons/{id}
Method:¶
PUT
Parameters request:¶
null
Parameters response:¶
Object
Description:
- personal_id(STRING)
- first_name(STRING)
- last_name(STRING)
- addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
- emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
- phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
- id(NUMBER)