school_subscriptions_get

Returns information from school - subscriptions

1. Call

Calls can be made as JSON and as XML. Both return the same data, just formatted according to the call you make.

JSON
https://<hosting location>/api/schedule_get.json
XML
https://<hosting location>/api/schedule_get.xml

1.1 Mandatory Variables

user
API user
key
Key for API user

1.2 Example Calls

https://<hosting location>/api/school_subscriptions_get.json?user=test&key=test

2. Return

The global structure for the returned values is as follows. The actual values returned differ slightly depending on whether called as XML or JSON.

data (top level)(list)
Subscriptions 1

1. The following data is provided for a subscription

Classes
[Int] Number of Classes
Description
[String] Subscription Description
LinkShop
[String] URL to subscription page in OpenStudio shop
Name
[String] Subscription Name
Price
[Float] Subscription Price
SortOrder
[int] Subscription sorting order
SubscriptionUnit
[String] ‘week’ or ‘month’ / unit to define number of Classes
Unlimited
[Boolean] True if unlimited classes, else False