Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
695 lines (515 sloc) 19.1 KB

Persons

(implementation of Person entity)

Provides following method for API calls:

Create

URL:

/api/v1/{format}/persons

Method:

POST

Parameters request:

Object< Person >

Parameters response:

Object

Description:

  1. personal_id(STRING)
  2. first_name(STRING)
  3. last_name(STRING)
  4. addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
  5. emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
  6. phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
  7. id(NUMBER)

Delete

URL:

/api/v1/{format}/persons/{id}

Method:

DELETE

Parameters request:

null

Parameters response:

Object

Description:

  1. personal_id(STRING)
  2. first_name(STRING)
  3. last_name(STRING)
  4. addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
  5. emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
  6. phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
  7. id(NUMBER)

DeleteByIds

URL:

/api/v1/{format}/persons

Method:

DELETE

Parameters request:

Url parameters: ids

Parameters response:

Array

Description:

  1. personal_id(STRING)
  2. first_name(STRING)
  3. last_name(STRING)
  4. addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
  5. emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
  6. phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
  7. id(NUMBER)

FindByCriteria

URL:

/api/v1/{format}/persons

Method:

GET

Parameters request:

Url parameters: search_text, order_by

Parameters response:

Array

Description:

  1. personal_id(STRING)
  2. first_name(STRING)
  3. last_name(STRING)
  4. addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
  5. emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
  6. phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
  7. id(NUMBER)

Get

URL:

/api/v1/{format}/person/{id}

Method:

GET

Parameters request:

null

Parameters response:

Object

Description:

  1. personal_id(STRING)
  2. first_name(STRING)
  3. last_name(STRING)
  4. addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
  5. emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
  6. phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
  7. id(NUMBER)

GetAll

URL:

/api/v1/{format}/persons

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

  1. personal_id(STRING)
  2. first_name(STRING)
  3. last_name(STRING)
  4. addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
  5. emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
  6. phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
  7. id(NUMBER)

GetByPersonalId

URL:

/api/v1/{format}/persons

Method:

GET

Parameters request:

Url parameters: personalId

Parameters response:

Array

Description:

  1. personal_id(STRING)
  2. first_name(STRING)
  3. last_name(STRING)
  4. addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
  5. emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
  6. phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
  7. id(NUMBER)

GetCurrentPerson

URL:

/api/v1/{format}/person/current

Method:

GET

Parameters request:

null

Parameters response:

Object

Description:

  1. personal_id(STRING)
  2. first_name(STRING)
  3. last_name(STRING)
  4. addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
  5. emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
  6. phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
  7. id(NUMBER)

GetFirstByPersonalId

URL:

/api/v1/{format}/persons

Method:

GET

Parameters request:

Url parameters: personalId, first

Parameters response:

Object

Description:

  1. personal_id(STRING)
  2. first_name(STRING)
  3. last_name(STRING)
  4. addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
  5. emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
  6. phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
  7. id(NUMBER)

GetPersonRolesByPerson

URL:

/api/v1/{format}/person/{id}/personroles

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

  1. person(OBJECT< Person >)
  2. role(OBJECT< WorkRole >)
  3. school(OBJECT< School >)
  4. school_class(OBJECT< SchoolClass >)
  5. date_from(NUMBER(Date representation wrapped))
  6. date_to(NUMBER(Date representation wrapped))
  7. id(NUMBER)

GetPersonRolesOfCurrentPerson

URL:

/api/v1/{format}/person/current/personroles

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

  1. person(OBJECT< Person >)
  2. role(OBJECT< WorkRole >)
  3. school(OBJECT< School >)
  4. school_class(OBJECT< SchoolClass >)
  5. date_from(NUMBER(Date representation wrapped))
  6. date_to(NUMBER(Date representation wrapped))
  7. id(NUMBER)

GetSchoolClassesByPerson

URL:

/api/v1/{format}/person/{id}/schoolclasses

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

  1. school_day_start(NUMBER(Date representation wrapped))
  2. school_day_end(NUMBER(Date representation wrapped))
  3. school(OBJECT< School >)
  4. pupils(ARRAY< Pupil >)
  5. diaries(ARRAY< Diary >)
  6. name(STRING)
  7. id(NUMBER)

GetSchoolClassesOfCurrentPerson

URL:

/api/v1/{format}/person/current/schoolclasses

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

  1. school_day_start(NUMBER(Date representation wrapped))
  2. school_day_end(NUMBER(Date representation wrapped))
  3. school(OBJECT< School >)
  4. pupils(ARRAY< Pupil >)
  5. diaries(ARRAY< Diary >)
  6. name(STRING)
  7. id(NUMBER)

GetSchoolsByPerson

URL:

/api/v1/{format}/person/{id}/schools

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

  1. school_id(STRING)
  2. services(ARRAY< ServiceTypeEnum >)
  3. school_classes(ARRAY< SchoolClass >)
  4. after_school_center_sections(ARRAY< AfterSchoolCenterSection >)
  5. name(STRING)
  6. id(NUMBER)

GetSchoolsOfCurrentPerson

URL:

/api/v1/{format}/person/current/schools

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

  1. school_id(STRING)
  2. services(ARRAY< ServiceTypeEnum >)
  3. school_classes(ARRAY< SchoolClass >)
  4. after_school_center_sections(ARRAY< AfterSchoolCenterSection >)
  5. name(STRING)
  6. id(NUMBER)

GetWorkRolesByPerson

URL:

/api/v1/{format}/person/{id}/workroles

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

  1. name(STRING)
  2. id(NUMBER)

GetWorkRolesOfCurrentPerson

URL:

/api/v1/{format}/person/current/workroles

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

  1. name(STRING)
  2. id(NUMBER)

SaveAll

URL:

/api/v1/{format}/persons/saveall

Method:

POST

Parameters request:

Array< Person >

Parameters response:

Array

Description:

  1. personal_id(STRING)
  2. first_name(STRING)
  3. last_name(STRING)
  4. addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
  5. emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
  6. phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
  7. id(NUMBER)

SaveAllAndReturnIds

URL:

/api/v1/{format}/persons/saveall

Method:

POST

Parameters request:

Url parameters: full

Array< Person >

Parameters response:

Array

Description:
ARRAY<NUMBER>

Search

URL:

/api/v1/{format}/persons/search

Method:

POST

Parameters request:

Array< SearchCriteries$SearchCriteriaResult >

Parameters response:

Array

Description:

  1. personal_id(STRING)
  2. first_name(STRING)
  3. last_name(STRING)
  4. addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
  5. emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
  6. phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
  7. id(NUMBER)

SearchFirst

URL:

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

Method:

POST

Parameters request:

Array< SearchCriteries$SearchCriteriaResult >

Parameters response:

Object

Description:

  1. personal_id(STRING)
  2. first_name(STRING)
  3. last_name(STRING)
  4. addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
  5. emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
  6. phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
  7. id(NUMBER)

Update

URL:

/api/v1/{format}/persons/{id}

Method:

PUT

Parameters request:

null

Parameters response:

Object

Description:

  1. personal_id(STRING)
  2. first_name(STRING)
  3. last_name(STRING)
  4. addresses(KEY_ENUM_OBJECT_PAIR< AddressTypeEnum , Address >)
  5. emails(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Email >)
  6. phones(KEY_ENUM_OBJECT_PAIR< CommunicationTypeEnum , Phone >)
  7. id(NUMBER)
You can’t perform that action at this time.