Issues

(implementation of Issue entity)

Provides following method for API calls:

• Create
• Delete
• DeleteByIds
• FindByCriteria
• Get
• GetAll
• SaveAll
• SaveAllAndReturnIds
• Search
• SearchFirst
• Update

Create

URL:

/api/v1/{format}/issues

Method:

POST

Parameters request:

Object< Issue >

Parameters response:

Object

Description:

1. title(STRING)
2. description(STRING)
3. status(OBJECT< Status >)
4. responsible_person(OBJECT< Person >)
5. authorized_persons(ARRAY< Person >)
6. incidents(ARRAY< Incident >)
7. reported_date(NUMBER(Date representation wrapped))
8. reported_by(OBJECT< Person >)
9. modified_by(OBJECT< Person >)
10. modified_date(NUMBER(Date representation wrapped))
11. activities(ARRAY< Activity >)
12. categories(ARRAY< Category >)
13. priority(OBJECT< Priority >)
14. pupils(ARRAY< Pupil >)
15. id(NUMBER)

Delete

URL:

/api/v1/{format}/issues/{id}

Method:

DELETE

Parameters request:

null

Parameters response:

Object

Description:

1. title(STRING)
2. description(STRING)
3. status(OBJECT< Status >)
4. responsible_person(OBJECT< Person >)
5. authorized_persons(ARRAY< Person >)
6. incidents(ARRAY< Incident >)
7. reported_date(NUMBER(Date representation wrapped))
8. reported_by(OBJECT< Person >)
9. modified_by(OBJECT< Person >)
10. modified_date(NUMBER(Date representation wrapped))
11. activities(ARRAY< Activity >)
12. categories(ARRAY< Category >)
13. priority(OBJECT< Priority >)
14. pupils(ARRAY< Pupil >)
15. id(NUMBER)

DeleteByIds

URL:

/api/v1/{format}/issues

Method:

DELETE

Parameters request:

Url parameters: ids

Parameters response:

Array

Description:

1. title(STRING)
2. description(STRING)
3. status(OBJECT< Status >)
4. responsible_person(OBJECT< Person >)
5. authorized_persons(ARRAY< Person >)
6. incidents(ARRAY< Incident >)
7. reported_date(NUMBER(Date representation wrapped))
8. reported_by(OBJECT< Person >)
9. modified_by(OBJECT< Person >)
10. modified_date(NUMBER(Date representation wrapped))
11. activities(ARRAY< Activity >)
12. categories(ARRAY< Category >)
13. priority(OBJECT< Priority >)
14. pupils(ARRAY< Pupil >)
15. id(NUMBER)

FindByCriteria

URL:

/api/v1/{format}/issues

Method:

GET

Parameters request:

Url parameters: search_text, order_by

Parameters response:

Array

Description:

1. title(STRING)
2. description(STRING)
3. status(OBJECT< Status >)
4. responsible_person(OBJECT< Person >)
5. authorized_persons(ARRAY< Person >)
6. incidents(ARRAY< Incident >)
7. reported_date(NUMBER(Date representation wrapped))
8. reported_by(OBJECT< Person >)
9. modified_by(OBJECT< Person >)
10. modified_date(NUMBER(Date representation wrapped))
11. activities(ARRAY< Activity >)
12. categories(ARRAY< Category >)
13. priority(OBJECT< Priority >)
14. pupils(ARRAY< Pupil >)
15. id(NUMBER)

Get

URL:

/api/v1/{format}/issues/{id}

Method:

GET

Parameters request:

null

Parameters response:

Object

Description:

1. title(STRING)
2. description(STRING)
3. status(OBJECT< Status >)
4. responsible_person(OBJECT< Person >)
5. authorized_persons(ARRAY< Person >)
6. incidents(ARRAY< Incident >)
7. reported_date(NUMBER(Date representation wrapped))
8. reported_by(OBJECT< Person >)
9. modified_by(OBJECT< Person >)
10. modified_date(NUMBER(Date representation wrapped))
11. activities(ARRAY< Activity >)
12. categories(ARRAY< Category >)
13. priority(OBJECT< Priority >)
14. pupils(ARRAY< Pupil >)
15. id(NUMBER)

GetAll

URL:

/api/v1/{format}/issues

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

1. title(STRING)
2. description(STRING)
3. status(OBJECT< Status >)
4. responsible_person(OBJECT< Person >)
5. authorized_persons(ARRAY< Person >)
6. incidents(ARRAY< Incident >)
7. reported_date(NUMBER(Date representation wrapped))
8. reported_by(OBJECT< Person >)
9. modified_by(OBJECT< Person >)
10. modified_date(NUMBER(Date representation wrapped))
11. activities(ARRAY< Activity >)
12. categories(ARRAY< Category >)
13. priority(OBJECT< Priority >)
14. pupils(ARRAY< Pupil >)
15. id(NUMBER)

SaveAll

URL:

/api/v1/{format}/issues/saveall

Method:

POST

Parameters request:

Array< Issue >

Parameters response:

Array

Description:

1. title(STRING)
2. description(STRING)
3. status(OBJECT< Status >)
4. responsible_person(OBJECT< Person >)
5. authorized_persons(ARRAY< Person >)
6. incidents(ARRAY< Incident >)
7. reported_date(NUMBER(Date representation wrapped))
8. reported_by(OBJECT< Person >)
9. modified_by(OBJECT< Person >)
10. modified_date(NUMBER(Date representation wrapped))
11. activities(ARRAY< Activity >)
12. categories(ARRAY< Category >)
13. priority(OBJECT< Priority >)
14. pupils(ARRAY< Pupil >)
15. id(NUMBER)

SaveAllAndReturnIds

URL:

/api/v1/{format}/issues/saveall

Method:

POST

Parameters request:

Url parameters: full

Array< Issue >

Parameters response:

Array

Description:

ARRAY<NUMBER>

Search

URL:

/api/v1/{format}/issues/search

Method:

POST

Parameters request:

Array< SearchCriteries$SearchCriteriaResult >

Parameters response:

Array

Description:

1. title(STRING)
2. description(STRING)
3. status(OBJECT< Status >)
4. responsible_person(OBJECT< Person >)
5. authorized_persons(ARRAY< Person >)
6. incidents(ARRAY< Incident >)
7. reported_date(NUMBER(Date representation wrapped))
8. reported_by(OBJECT< Person >)
9. modified_by(OBJECT< Person >)
10. modified_date(NUMBER(Date representation wrapped))
11. activities(ARRAY< Activity >)
12. categories(ARRAY< Category >)
13. priority(OBJECT< Priority >)
14. pupils(ARRAY< Pupil >)
15. id(NUMBER)

SearchFirst

URL:

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

Method:

POST

Parameters request:

Array< SearchCriteries$SearchCriteriaResult >

Parameters response:

Object

Description:

1. title(STRING)
2. description(STRING)
3. status(OBJECT< Status >)
4. responsible_person(OBJECT< Person >)
5. authorized_persons(ARRAY< Person >)
6. incidents(ARRAY< Incident >)
7. reported_date(NUMBER(Date representation wrapped))
8. reported_by(OBJECT< Person >)
9. modified_by(OBJECT< Person >)
10. modified_date(NUMBER(Date representation wrapped))
11. activities(ARRAY< Activity >)
12. categories(ARRAY< Category >)
13. priority(OBJECT< Priority >)
14. pupils(ARRAY< Pupil >)
15. id(NUMBER)

Update

URL:

/api/v1/{format}/issues/{id}

Method:

PUT

Parameters request:

Object< Issue >

Parameters response:

Object

Description:

1. title(STRING)
2. description(STRING)
3. status(OBJECT< Status >)
4. responsible_person(OBJECT< Person >)
5. authorized_persons(ARRAY< Person >)
6. incidents(ARRAY< Incident >)
7. reported_date(NUMBER(Date representation wrapped))
8. reported_by(OBJECT< Person >)
9. modified_by(OBJECT< Person >)
10. modified_date(NUMBER(Date representation wrapped))
11. activities(ARRAY< Activity >)
12. categories(ARRAY< Category >)
13. priority(OBJECT< Priority >)
14. pupils(ARRAY< Pupil >)
15. id(NUMBER)