Incidents

(implementation of Incident entity)

Provides following method for API calls:

Create

URL:

/api/v1/{format}/incidents

Method:

POST

Parameters request:

Object< Incident >

Parameters response:

Object

Description:

  1. title(STRING)
  2. description(STRING)
  3. reported_date(NUMBER(Date representation wrapped))
  4. categories(ARRAY< Category >)
  5. pupils(ARRAY< Pupil >)
  6. status(OBJECT< Status >)
  7. priority(OBJECT< Priority >)
  8. issue(OBJECT< Issue >)
  9. assigned_date(NUMBER(Date representation wrapped))
  10. assigned_by(OBJECT< Person >)
  11. archived_date(NUMBER(Date representation wrapped))
  12. archived_by(OBJECT< Person >)
  13. reported_by(OBJECT< Person >)
  14. modified_by(OBJECT< Person >)
  15. modified_date(NUMBER(Date representation wrapped))
  16. id(NUMBER)

Delete

URL:

/api/v1/{format}/incidents/{id}

Method:

DELETE

Parameters request:

null

Parameters response:

Object

Description:

  1. title(STRING)
  2. description(STRING)
  3. reported_date(NUMBER(Date representation wrapped))
  4. categories(ARRAY< Category >)
  5. pupils(ARRAY< Pupil >)
  6. status(OBJECT< Status >)
  7. priority(OBJECT< Priority >)
  8. issue(OBJECT< Issue >)
  9. assigned_date(NUMBER(Date representation wrapped))
  10. assigned_by(OBJECT< Person >)
  11. archived_date(NUMBER(Date representation wrapped))
  12. archived_by(OBJECT< Person >)
  13. reported_by(OBJECT< Person >)
  14. modified_by(OBJECT< Person >)
  15. modified_date(NUMBER(Date representation wrapped))
  16. id(NUMBER)

DeleteByIds

URL:

/api/v1/{format}/incidents

Method:

DELETE

Parameters request:

Url parameters: ids

Parameters response:

Array

Description:

  1. title(STRING)
  2. description(STRING)
  3. reported_date(NUMBER(Date representation wrapped))
  4. categories(ARRAY< Category >)
  5. pupils(ARRAY< Pupil >)
  6. status(OBJECT< Status >)
  7. priority(OBJECT< Priority >)
  8. issue(OBJECT< Issue >)
  9. assigned_date(NUMBER(Date representation wrapped))
  10. assigned_by(OBJECT< Person >)
  11. archived_date(NUMBER(Date representation wrapped))
  12. archived_by(OBJECT< Person >)
  13. reported_by(OBJECT< Person >)
  14. modified_by(OBJECT< Person >)
  15. modified_date(NUMBER(Date representation wrapped))
  16. id(NUMBER)

FindByCriteria

URL:

/api/v1/{format}/incidents

Method:

GET

Parameters request:

Url parameters: search_text, order_by

Parameters response:

Array

Description:

  1. title(STRING)
  2. description(STRING)
  3. reported_date(NUMBER(Date representation wrapped))
  4. categories(ARRAY< Category >)
  5. pupils(ARRAY< Pupil >)
  6. status(OBJECT< Status >)
  7. priority(OBJECT< Priority >)
  8. issue(OBJECT< Issue >)
  9. assigned_date(NUMBER(Date representation wrapped))
  10. assigned_by(OBJECT< Person >)
  11. archived_date(NUMBER(Date representation wrapped))
  12. archived_by(OBJECT< Person >)
  13. reported_by(OBJECT< Person >)
  14. modified_by(OBJECT< Person >)
  15. modified_date(NUMBER(Date representation wrapped))
  16. id(NUMBER)

Get

URL:

/api/v1/{format}/incidents/{id}

Method:

GET

Parameters request:

null

Parameters response:

Object

Description:

  1. title(STRING)
  2. description(STRING)
  3. reported_date(NUMBER(Date representation wrapped))
  4. categories(ARRAY< Category >)
  5. pupils(ARRAY< Pupil >)
  6. status(OBJECT< Status >)
  7. priority(OBJECT< Priority >)
  8. issue(OBJECT< Issue >)
  9. assigned_date(NUMBER(Date representation wrapped))
  10. assigned_by(OBJECT< Person >)
  11. archived_date(NUMBER(Date representation wrapped))
  12. archived_by(OBJECT< Person >)
  13. reported_by(OBJECT< Person >)
  14. modified_by(OBJECT< Person >)
  15. modified_date(NUMBER(Date representation wrapped))
  16. id(NUMBER)

GetAll

URL:

/api/v1/{format}/incidents

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

  1. title(STRING)
  2. description(STRING)
  3. reported_date(NUMBER(Date representation wrapped))
  4. categories(ARRAY< Category >)
  5. pupils(ARRAY< Pupil >)
  6. status(OBJECT< Status >)
  7. priority(OBJECT< Priority >)
  8. issue(OBJECT< Issue >)
  9. assigned_date(NUMBER(Date representation wrapped))
  10. assigned_by(OBJECT< Person >)
  11. archived_date(NUMBER(Date representation wrapped))
  12. archived_by(OBJECT< Person >)
  13. reported_by(OBJECT< Person >)
  14. modified_by(OBJECT< Person >)
  15. modified_date(NUMBER(Date representation wrapped))
  16. id(NUMBER)

SaveAll

URL:

/api/v1/{format}/incidents/saveall

Method:

POST

Parameters request:

Array< Incident >

Parameters response:

Array

Description:

  1. title(STRING)
  2. description(STRING)
  3. reported_date(NUMBER(Date representation wrapped))
  4. categories(ARRAY< Category >)
  5. pupils(ARRAY< Pupil >)
  6. status(OBJECT< Status >)
  7. priority(OBJECT< Priority >)
  8. issue(OBJECT< Issue >)
  9. assigned_date(NUMBER(Date representation wrapped))
  10. assigned_by(OBJECT< Person >)
  11. archived_date(NUMBER(Date representation wrapped))
  12. archived_by(OBJECT< Person >)
  13. reported_by(OBJECT< Person >)
  14. modified_by(OBJECT< Person >)
  15. modified_date(NUMBER(Date representation wrapped))
  16. id(NUMBER)

SaveAllAndReturnIds

URL:

/api/v1/{format}/incidents/saveall

Method:

POST

Parameters request:

Url parameters: full

Array< Incident >

Parameters response:

Array

Description:
ARRAY<NUMBER>

SearchFirst

URL:

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

Method:

POST

Parameters request:

Parameters response:

Object

Description:

  1. title(STRING)
  2. description(STRING)
  3. reported_date(NUMBER(Date representation wrapped))
  4. categories(ARRAY< Category >)
  5. pupils(ARRAY< Pupil >)
  6. status(OBJECT< Status >)
  7. priority(OBJECT< Priority >)
  8. issue(OBJECT< Issue >)
  9. assigned_date(NUMBER(Date representation wrapped))
  10. assigned_by(OBJECT< Person >)
  11. archived_date(NUMBER(Date representation wrapped))
  12. archived_by(OBJECT< Person >)
  13. reported_by(OBJECT< Person >)
  14. modified_by(OBJECT< Person >)
  15. modified_date(NUMBER(Date representation wrapped))
  16. id(NUMBER)

Update

URL:

/api/v1/{format}/incidents/{id}

Method:

PUT

Parameters request:

Object< Incident >

Parameters response:

Object

Description:

  1. title(STRING)
  2. description(STRING)
  3. reported_date(NUMBER(Date representation wrapped))
  4. categories(ARRAY< Category >)
  5. pupils(ARRAY< Pupil >)
  6. status(OBJECT< Status >)
  7. priority(OBJECT< Priority >)
  8. issue(OBJECT< Issue >)
  9. assigned_date(NUMBER(Date representation wrapped))
  10. assigned_by(OBJECT< Person >)
  11. archived_date(NUMBER(Date representation wrapped))
  12. archived_by(OBJECT< Person >)
  13. reported_by(OBJECT< Person >)
  14. modified_by(OBJECT< Person >)
  15. modified_date(NUMBER(Date representation wrapped))
  16. id(NUMBER)