EP Diagram - ActoKids/api GitHub Wiki

EP Diagram

This is the EP Diagram for the API of the ActoKids project.

.../v1/event

POST:

  • Success returns the event object - HTTP 201
  • Missing requirement in the event object - HTTP 400
  • Failure to connect to the database - HTTP 500
  • Failure to save the event in the database - HTTP 500

GET:

  • Success returns a list of event objects - HTTP 200
  • If the event doesn't exist - HTTP 404
  • Failure to connect to the database - HTTP 500

PUT:

  • Operation not supported - HTTP 405

DELETE:

  • Operation not supported - HTTP 405

.../v1/event/{eventID}

POST:

  • Operation not supported - HTTP 405

GET:

  • Success returns an event object - HTTP 200
  • Invalid eventID - HTTP 400
  • Event not found - HTTP 404
  • Failure to connect to the database - HTTP 500

PUT:

  • Success returns an event object - HTTP 200
  • Invalid eventID or parameter(s) - HTTP 400
  • Event not found - HTTP 404
  • Failure to connect to the database - HTTP 500
  • Failure to save the event in the database - HTTP 500

DELETE:

  • Successful deletion; No object returned - HTTP 200
  • Invalid eventID - HTTP 400
  • Event not found - HTTP 404
  • Failure to connect to the database - HTTP 500

.../v1/event/eventFilter

POST:

  • Operation not supported - HTTP 405

GET:

  • Success returns a list of event objects - HTTP 200
  • Invalid parameter(s) - HTTP 400
  • Failure to connect to the database - HTTP 500

PUT:

  • Operation not supported - HTTP 405

DELETE:

  • Operation not supported - HTTP 405

Event Object Definition

The event object is defined by the Data Model