Skip to content

Endpoints

Pedro Maximino edited this page Jul 31, 2019 · 2 revisions

Billing

Endpoint Method Description
/billings GET Gets all Billings
/billings POST Create Billing
/billings/{id} GET Get Billing by id
/billings/{id} PUT Modify Billing
/billings/{id} DELETE Delete Billing

Company

Endpoint Method Description
/public/companies GET Get all companies (no auth)
/public/companies/{id} GET Get company by id (no auth)
/companies GET Get all companies
/companies/{id} GET Get company by id
/companies POST Create company
/companies/{id} PUT Modify company (not its participations)
/companies/{id}/image/internal POST Modify company's private image
/companies/{id}/image/public POST Modify company's public image
/companies/{id} DELETE Delete company
/companies/{id}/participation POST Add participation to company
/companies/{id}/participation PUT Modify participation of company
/companies/{id}/participation/status/{type} POST Advance status' state machine
/companies/{id}/participation/status/{status} PUT Modify status' state machine's state

CompanyRep

Endpoint Method Description
/route_example GET Gets something
/route_example/{value} GET Gets something

Contact

Endpoint Method Description
/contacts GET Gets all Contacts
/contacts POST Create Contact
/contacts/{id} GET Get Contact by id
/contacts/{id} PUT Modify Contact
/contacts/{id} DELETE Delete Contact
/contacts/{id}/phones POST Add phone to a specific Contact
/contacts/{id}/phones/{phone-id} PUT Modify specific phone from a specific Contact
/contacts/{id}/phones/{phone-id} DELETE Delete specific phone from a specific Contact
/contacts/{id}/mails POST Add mail to a specific Contact
/contacts/{id}/mails/{mail-id} PUT Modify specific mail from a specific Contact
/contacts/{id}/mails/{mail-id} DELETE Delete specific mail from a specific Contact

Event

Endpoint Method Description
/route_example GET Gets something
/route_example/{value} GET Gets something

FlightInfo

Endpoint Method Description
/flightinfos GET Get all flightinfo
/flightinfos{id} GET Get a specific flightinfo
/flightinfos{id} PUT Put a specific flightinfo
/flightinfos{id} DELETE Delete a specific flightinfo
/flightinfos{id} PUT Put a specific flightinfo
/speakers/{id}/flightinfo POST Create a flightinfo

Item

Endpoint Method Description
/items GET Gets all items
/packages/{id}/items POST Creates item
/packages/{id}/items/{name} PUT Changes item
/items/{id} GET Gets item
/packages/{id}/items/{name} DELETE Deletes item

Meeting

Endpoint Method Description
/meetings GET Gets meetings
/events/meeting POST Creates meeting in event
/teams/{id}/meeting POST Creates meeting in team
/threads/{id}/meeting POST Creates meeting in thread
/meeting/{id} PUT Changes meeting
/events/meeting/{id} DELETE Deletes meeting from event
/teams/{team_id}/meeting/{id} DELETE Deletes meeting from team

Member

Endpoint Method Description
/members GET Gets all members (queryable)
/members POST Create a new member
/members/{id} GET Get a specific member
/members/{id} PUT Replace a member
/members/{id} DELETE Delete a member

Notification

Endpoint Method Description
/notifications GET Gets notifications
/notifications/{id} PUT Sets a notification as seen

Package

Endpoint Method Description
/packages GET Gets all packages
/companies/{id}/participation/package POST Creates package
/packages/{id} PUT Changes package
/packages/{id} GET Gets package
/packages/{id} DELETE Deletes package

Post

Endpoint Method Description
/posts GET Get all posts
/posts/{id} GET Get specific post
/posts/{id} DELETE Delete specific post
/posts/{id} PUT Edit specific post
/posts POST Create post

Session

Endpoint Method Description
/sessions GET Gets sessions
/sessions/{id} GET Gets session
/sessions POST Create session
/sessions/{id} PUT Modify session
/sessions/{id} DELETE Delete session

Speaker

Endpoint Method Description
/public/speakers GET Get all speakers (no auth)
/public/speakers/{id} GET Get speaker by id (no auth)
/speakers GET Get all speakers
/speakers/{id} GET Get speaker by id
/speakers POST Create speaker
/speakers/{id} PUT Modify speaker (not its participations)
/speakers/{id}/image/internal POST Modify speaker's private image
/speakers/{id}/image/public/speaker POST Modify speaker's public image
/speakers/{id}/image/public/company POST Modify speaker's public company image
/speakers/{id} DELETE Delete speaker
/speakers/{id}/participation POST Add participation to speaker
/speakers/{id}/participation PUT Modify participation of speaker
/speakers/{id}/participation/status/{type} POST Advance status' state machine
/speakers/{id}/participation/status/{status} PUT Modify status' state machine's state

Team

Endpoint Method Description
/route_example GET Gets something
/route_example/{value} GET Gets something

Thread

Endpoint Method Description
/threads GET Gets all Threads
/threads/{id} GET Gets Thread by ID
/companies/{id}/thread POST Create a new Thread for a company
/speakers/{id}/thread POST Create a new Thread for a speaker
/threads/{id} POST Add a comment to a Thread
/threads/{id}/subscirbers GET Get all subscribers for a Thread
/threads/{id}/subscirbers POST Add a subscriber to a Thread
/threads/{threadID}/subscirbers/{userID} DELETE Remove a subscriber from a Thread

Database Structure

Endpoints Tables

Endpoints Usage

Clone this wiki locally