PersonRoles¶
(implementation of PersonRole entity)
Provides following method for API calls:
Create¶
URL:¶
/api/v1/{format}/personroles
Method:¶
POST
Parameters request:¶
Object< PersonRole >
Parameters response:¶
Object
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)
Delete¶
URL:¶
/api/v1/{format}/personroles/{id}
Method:¶
DELETE
Parameters request:¶
null
Parameters response:¶
Object
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)
DeleteByIds¶
URL:¶
/api/v1/{format}/personroles
Method:¶
DELETE
Parameters request:¶
Url parameters: ids
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)
Get¶
URL:¶
/api/v1/{format}/personroles/{id}
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Object
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)
GetAll¶
URL:¶
/api/v1/{format}/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)
SaveAll¶
URL:¶
/api/v1/{format}/personroles/saveall
Method:¶
POST
Parameters request:¶
Array< PersonRole >
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)
SaveAllAndReturnIds¶
URL:¶
/api/v1/{format}/personroles/saveall
Method:¶
POST
Parameters request:¶
Url parameters: full
Array< PersonRole >
Parameters response:¶
Array
- Description:
- ARRAY<NUMBER>
Search¶
URL:¶
/api/v1/{format}/personroles/search
Method:¶
POST
Parameters request:¶
Array< SearchCriteries$SearchCriteriaResult >
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)
SearchFirst¶
URL:¶
/api/v1/{format}/personroles/search/first
Method:¶
POST
Parameters request:¶
Array< SearchCriteries$SearchCriteriaResult >
Parameters response:¶
Object
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)
Update¶
URL:¶
/api/v1/{format}/personroles/{id}
Method:¶
PUT
Parameters request:¶
Object< PersonRole >
Parameters response:¶
Object
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)