Web API Routes

Here are the routes you can use to get and add (or edit) data. Remember that you need to change the web method to retrive (GET) or send data to add (POST) or update data (PUT). All the routes are relative to the base route. All the filters are enclosed in { }.

GET

Login
  • /login - Log in the user to use the API. Just send the authentication data or the access token in the authentication header.
Invoices
  • /invoices/{status}/{dateFrom}/{dateTo}/{accountId}/ - Gets a list of invoices filtered.
  • /invoice({id})/ - Gets an invoice by its ID.
  • /invoice({id})/{filterName}/ - Gets an invoice, its items or its transactions. Filters can be summary, invoiceitems or invoicetransactions.
Classes
  • /classes/{dateFrom}/{dateTo}/{courseID}/{location}/ - Gets a list of classes filtered.
  • /class({id})/ - Gets a class by its ID.
  • /class({id})/{filterType}/ - Gets a class, its enrollments or its fees. Filters can be summary, classenrollments or classfees.
Schedule
  • /facility({id})/Schedule/{dateFrom}/{dateTo}/ - Gets the schedule of a facility filtered by date range.
  • /instructor({id})/Schedule/{dateFrom}/{dateTo}/ - Gets the schedule of an instructor filtered by date range.
  • /site({id})/Schedule/{day}/{dateFrom}/{dateTo}/ - Gets the schedule of a site filtered by date range.
Customer
  • /customers/{accountId}/{lastName}/{firstName}/{postalCode}/ - Gets a list of customer filtered .
  • /customer({id})/ - Gets a customer and its contacts.
Private Lesson
  • /privatelesson/?hashTeacher={hashTeacher} - Gets the information about the lesson from a teacher.
POST

Invoices
  • /invoice/ - Post the model to the API to create a new invoice.
Classes
  • /class/ - Post the model to the API to create a new class.
Customer
  • /customer/ - Post the model to the API to create a new customer.
Private Lesson
  • /privatelesson/?hashTeacher={hashTeacher}&isPresent={present|absent} - Create an attendance for the private lesson.
PUT

Invoices
  • /invoice/{id} - Post the model to the API to update an existing invoice.
Classes
  • /class/{id} - Post the model to the API to update an existing class.
Customer
  • /customer/{id} - Post the model to the API to update an existing customer.
Have more questions? Submit a request

Comments

Powered by Zendesk