Studioware API Help Page

Introduction

Welcome to the Studioware API Help Guide. This help guide documents all the API Rest Service calls that are available in Studioware.

In order to use the Studioware API methods, it must first be enabled. To enable the APIs, simply logon as an administrators and click on Administration | API | Enable.

We recommend using a tool to invoke the REST APIs, such as PostMan. To invoke the API, include the API Key in the header with the name API_KEY. You will also need to incude your Studioware credentials in the Header using Basic Authorization.

If you have any additional questions, please contact Studioware support.

Classes

Use these Rest services to get basic information about the classes defined in your Studioware account

API	Description
GET api/Classes/{id}/Tuition	Load the tuition for the specified class
GET api/Classes/{id}/Sessions?OnlyActive={OnlyActive}	Load a list of scheduled dates for a class
GET api/Classes/{id}/Sessions/{SessionId}/Dates	Returns a list of dates for the specified scheduled class
GET api/Classes	Get a list of classes defined in the studioware account
GET api/Classes/{id}	Returns the details abount the specified class

Studio

The Studio API REST methods are used for obtaining information about the Studio/Business.

API	Description
GET api/Studio/Locations	Returns information about the studio/business locations
GET api/Studio	No documentation available.