GET Classes/ecomm_planning?branchid={branchid}&startdate={startdate}&enddate={enddate}&customerid={customerid}
Gets appointments list
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| branchid |
ID of a Branch |
decimal number |
Required |
| startdate | date |
Required |
|
| enddate | date |
Required |
|
| customerid | decimal number |
None. |
Body Parameters
None.
Response Information
Resource Description
Array of appointments
Collection of AppointmentAvailability| Name | Description | Type | Additional information |
|---|---|---|---|
| appointment | Appointment |
None. |
|
| capacity | integer |
None. |
|
| bookings | integer |
None. |
|
| availability | integer |
None. |
|
| waitlist_count | integer |
None. |
|
| bookability | BookabilityType |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"appointment": {
"id": 1.0,
"objectid": 1.0,
"objectname": "sample string 2",
"objecttype": "sample string 3",
"lane": 1,
"timestart": "2025-05-10T10:44:13.4023104+02:00",
"timeend": "2025-05-10T10:44:13.4023104+02:00",
"date": "2025-05-10T10:44:13.4023104+02:00",
"commitmentname": "sample string 4",
"facilityid": 1.0,
"note": "sample string 5",
"booking": true,
"availability": 6,
"class": {
"id": "sample string 1",
"code": "sample string 2",
"name": "sample string 3",
"startdate": "2025-05-10T10:44:13.4023104+02:00",
"enddate": "2025-05-10T10:44:13.4023104+02:00",
"capacity": 1,
"timestart": "00:00:00.1234567",
"timeend": "00:00:00.1234567",
"activity": {
"id": "sample string 1",
"name": "sample string 2",
"ecomm_name": "sample string 3",
"ecomm_description": "sample string 4",
"waitlistenabled": true,
"color": "sample string 6"
},
"skill": {
"id": "sample string 1",
"name": "sample string 2"
},
"branch": {
"id": "sample string 1",
"name": "sample string 2",
"ecomm_name": "sample string 3"
},
"instructor": {
"id": "sample string 1",
"lastname": "sample string 2",
"firstname": "sample string 3",
"dob": "2025-05-10T10:44:13.4023104+02:00",
"birthplace": "sample string 4",
"email": "sample string 5",
"gender": "sample string 6",
"address": "sample string 7",
"zipcode": "sample string 8",
"medicalexpirydate": "2025-05-10T10:44:13.4023104+02:00",
"city": "sample string 9",
"state": "sample string 10",
"phone": "sample string 11",
"notes": "sample string 12",
"taxcode": "sample string 13",
"badgeid": "sample string 14",
"memexpirydate": "2025-05-10T10:44:13.4023104+02:00",
"typerow": "sample string 15",
"ecommerce": true,
"mobilephone": "sample string 16",
"medicalexpirydate2": "2025-05-10T10:44:13.4023104+02:00",
"vatcode": "sample string 17",
"insertdate": "2025-05-10T10:44:13.4023104+02:00",
"employee": true,
"customerstate": "sample string 20",
"statscurrentseason": 21.0,
"statspastseason": 22.0,
"statslast3months": 23.0,
"statslast6months": 24.0,
"debt": 25.0,
"lastaccess": "2025-05-10T10:44:13.4023104+02:00",
"lastedit": "2025-05-10T10:44:13.4023104+02:00",
"activityexpiredate": "2025-05-10T10:44:13.4023104+02:00",
"marketingagreement": true,
"notifyagreement": true,
"lastlogin": "2025-05-10T10:44:13.4023104+02:00",
"myzoneid": "sample string 26",
"massivedeleteid": 1.0,
"progressive": 1,
"userowner": "sample string 27",
"userassignee": "sample string 28",
"branch": [
{
"id": "sample string 1",
"name": "sample string 2",
"ecomm_name": "sample string 3"
},
{
"id": "sample string 1",
"name": "sample string 2",
"ecomm_name": "sample string 3"
}
]
}
}
},
"capacity": 1,
"bookings": 2,
"availability": 3,
"waitlist_count": 4,
"bookability": "bookable"
},
{
"appointment": {
"id": 1.0,
"objectid": 1.0,
"objectname": "sample string 2",
"objecttype": "sample string 3",
"lane": 1,
"timestart": "2025-05-10T10:44:13.4023104+02:00",
"timeend": "2025-05-10T10:44:13.4023104+02:00",
"date": "2025-05-10T10:44:13.4023104+02:00",
"commitmentname": "sample string 4",
"facilityid": 1.0,
"note": "sample string 5",
"booking": true,
"availability": 6,
"class": {
"id": "sample string 1",
"code": "sample string 2",
"name": "sample string 3",
"startdate": "2025-05-10T10:44:13.4023104+02:00",
"enddate": "2025-05-10T10:44:13.4023104+02:00",
"capacity": 1,
"timestart": "00:00:00.1234567",
"timeend": "00:00:00.1234567",
"activity": {
"id": "sample string 1",
"name": "sample string 2",
"ecomm_name": "sample string 3",
"ecomm_description": "sample string 4",
"waitlistenabled": true,
"color": "sample string 6"
},
"skill": {
"id": "sample string 1",
"name": "sample string 2"
},
"branch": {
"id": "sample string 1",
"name": "sample string 2",
"ecomm_name": "sample string 3"
},
"instructor": {
"id": "sample string 1",
"lastname": "sample string 2",
"firstname": "sample string 3",
"dob": "2025-05-10T10:44:13.4023104+02:00",
"birthplace": "sample string 4",
"email": "sample string 5",
"gender": "sample string 6",
"address": "sample string 7",
"zipcode": "sample string 8",
"medicalexpirydate": "2025-05-10T10:44:13.4023104+02:00",
"city": "sample string 9",
"state": "sample string 10",
"phone": "sample string 11",
"notes": "sample string 12",
"taxcode": "sample string 13",
"badgeid": "sample string 14",
"memexpirydate": "2025-05-10T10:44:13.4023104+02:00",
"typerow": "sample string 15",
"ecommerce": true,
"mobilephone": "sample string 16",
"medicalexpirydate2": "2025-05-10T10:44:13.4023104+02:00",
"vatcode": "sample string 17",
"insertdate": "2025-05-10T10:44:13.4023104+02:00",
"employee": true,
"customerstate": "sample string 20",
"statscurrentseason": 21.0,
"statspastseason": 22.0,
"statslast3months": 23.0,
"statslast6months": 24.0,
"debt": 25.0,
"lastaccess": "2025-05-10T10:44:13.4023104+02:00",
"lastedit": "2025-05-10T10:44:13.4023104+02:00",
"activityexpiredate": "2025-05-10T10:44:13.4023104+02:00",
"marketingagreement": true,
"notifyagreement": true,
"lastlogin": "2025-05-10T10:44:13.4023104+02:00",
"myzoneid": "sample string 26",
"massivedeleteid": 1.0,
"progressive": 1,
"userowner": "sample string 27",
"userassignee": "sample string 28",
"branch": [
{
"id": "sample string 1",
"name": "sample string 2",
"ecomm_name": "sample string 3"
},
{
"id": "sample string 1",
"name": "sample string 2",
"ecomm_name": "sample string 3"
}
]
}
}
},
"capacity": 1,
"bookings": 2,
"availability": 3,
"waitlist_count": 4,
"bookability": "bookable"
}
]
application/xml, text/xml
Sample:
<ArrayOfAppointmentAvailability xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sportrick.ApiModel">
<AppointmentAvailability>
<appointment>
<availability>6</availability>
<booking>true</booking>
<class>
<activity>
<color>sample string 6</color>
<ecomm_description>sample string 4</ecomm_description>
<ecomm_name>sample string 3</ecomm_name>
<id>sample string 1</id>
<name>sample string 2</name>
<waitlistenabled>true</waitlistenabled>
</activity>
<branch>
<ecomm_name>sample string 3</ecomm_name>
<id>sample string 1</id>
<name>sample string 2</name>
</branch>
<capacity>1</capacity>
<code>sample string 2</code>
<enddate>2025-05-10T10:44:13.4023104+02:00</enddate>
<id>sample string 1</id>
<instructor>
<activityexpiredate>2025-05-10T10:44:13.4023104+02:00</activityexpiredate>
<address>sample string 7</address>
<badgeid>sample string 14</badgeid>
<birthplace>sample string 4</birthplace>
<branch>
<Branch>
<ecomm_name>sample string 3</ecomm_name>
<id>sample string 1</id>
<name>sample string 2</name>
</Branch>
<Branch>
<ecomm_name>sample string 3</ecomm_name>
<id>sample string 1</id>
<name>sample string 2</name>
</Branch>
</branch>
<city>sample string 9</city>
<customerstate>sample string 20</customerstate>
<debt>25</debt>
<dob>2025-05-10T10:44:13.4023104+02:00</dob>
<ecommerce>true</ecommerce>
<email>sample string 5</email>
<employee>true</employee>
<firstname>sample string 3</firstname>
<gender>sample string 6</gender>
<id>sample string 1</id>
<insertdate>2025-05-10T10:44:13.4023104+02:00</insertdate>
<lastaccess>2025-05-10T10:44:13.4023104+02:00</lastaccess>
<lastedit>2025-05-10T10:44:13.4023104+02:00</lastedit>
<lastlogin>2025-05-10T10:44:13.4023104+02:00</lastlogin>
<lastname>sample string 2</lastname>
<marketingagreement>true</marketingagreement>
<massivedeleteid>1</massivedeleteid>
<medicalexpirydate>2025-05-10T10:44:13.4023104+02:00</medicalexpirydate>
<medicalexpirydate2>2025-05-10T10:44:13.4023104+02:00</medicalexpirydate2>
<memexpirydate>2025-05-10T10:44:13.4023104+02:00</memexpirydate>
<mobilephone>sample string 16</mobilephone>
<myzoneid>sample string 26</myzoneid>
<notes>sample string 12</notes>
<notifyagreement>true</notifyagreement>
<phone>sample string 11</phone>
<progressive>1</progressive>
<state>sample string 10</state>
<statscurrentseason>21</statscurrentseason>
<statslast3months>23</statslast3months>
<statslast6months>24</statslast6months>
<statspastseason>22</statspastseason>
<taxcode>sample string 13</taxcode>
<typerow>sample string 15</typerow>
<userassignee>sample string 28</userassignee>
<userowner>sample string 27</userowner>
<vatcode>sample string 17</vatcode>
<zipcode>sample string 8</zipcode>
</instructor>
<name>sample string 3</name>
<skill>
<id>sample string 1</id>
<name>sample string 2</name>
</skill>
<startdate>2025-05-10T10:44:13.4023104+02:00</startdate>
<timeend>PT0.1234567S</timeend>
<timestart>PT0.1234567S</timestart>
</class>
<commitmentname>sample string 4</commitmentname>
<date>2025-05-10T10:44:13.4023104+02:00</date>
<facilityid>1</facilityid>
<id>1</id>
<lane>1</lane>
<note>sample string 5</note>
<objectid>1</objectid>
<objectname>sample string 2</objectname>
<objecttype>sample string 3</objecttype>
<timeend>2025-05-10T10:44:13.4023104+02:00</timeend>
<timestart>2025-05-10T10:44:13.4023104+02:00</timestart>
</appointment>
<availability>3</availability>
<bookability>bookable</bookability>
<bookings>2</bookings>
<capacity>1</capacity>
<waitlist_count>4</waitlist_count>
</AppointmentAvailability>
<AppointmentAvailability>
<appointment>
<availability>6</availability>
<booking>true</booking>
<class>
<activity>
<color>sample string 6</color>
<ecomm_description>sample string 4</ecomm_description>
<ecomm_name>sample string 3</ecomm_name>
<id>sample string 1</id>
<name>sample string 2</name>
<waitlistenabled>true</waitlistenabled>
</activity>
<branch>
<ecomm_name>sample string 3</ecomm_name>
<id>sample string 1</id>
<name>sample string 2</name>
</branch>
<capacity>1</capacity>
<code>sample string 2</code>
<enddate>2025-05-10T10:44:13.4023104+02:00</enddate>
<id>sample string 1</id>
<instructor>
<activityexpiredate>2025-05-10T10:44:13.4023104+02:00</activityexpiredate>
<address>sample string 7</address>
<badgeid>sample string 14</badgeid>
<birthplace>sample string 4</birthplace>
<branch>
<Branch>
<ecomm_name>sample string 3</ecomm_name>
<id>sample string 1</id>
<name>sample string 2</name>
</Branch>
<Branch>
<ecomm_name>sample string 3</ecomm_name>
<id>sample string 1</id>
<name>sample string 2</name>
</Branch>
</branch>
<city>sample string 9</city>
<customerstate>sample string 20</customerstate>
<debt>25</debt>
<dob>2025-05-10T10:44:13.4023104+02:00</dob>
<ecommerce>true</ecommerce>
<email>sample string 5</email>
<employee>true</employee>
<firstname>sample string 3</firstname>
<gender>sample string 6</gender>
<id>sample string 1</id>
<insertdate>2025-05-10T10:44:13.4023104+02:00</insertdate>
<lastaccess>2025-05-10T10:44:13.4023104+02:00</lastaccess>
<lastedit>2025-05-10T10:44:13.4023104+02:00</lastedit>
<lastlogin>2025-05-10T10:44:13.4023104+02:00</lastlogin>
<lastname>sample string 2</lastname>
<marketingagreement>true</marketingagreement>
<massivedeleteid>1</massivedeleteid>
<medicalexpirydate>2025-05-10T10:44:13.4023104+02:00</medicalexpirydate>
<medicalexpirydate2>2025-05-10T10:44:13.4023104+02:00</medicalexpirydate2>
<memexpirydate>2025-05-10T10:44:13.4023104+02:00</memexpirydate>
<mobilephone>sample string 16</mobilephone>
<myzoneid>sample string 26</myzoneid>
<notes>sample string 12</notes>
<notifyagreement>true</notifyagreement>
<phone>sample string 11</phone>
<progressive>1</progressive>
<state>sample string 10</state>
<statscurrentseason>21</statscurrentseason>
<statslast3months>23</statslast3months>
<statslast6months>24</statslast6months>
<statspastseason>22</statspastseason>
<taxcode>sample string 13</taxcode>
<typerow>sample string 15</typerow>
<userassignee>sample string 28</userassignee>
<userowner>sample string 27</userowner>
<vatcode>sample string 17</vatcode>
<zipcode>sample string 8</zipcode>
</instructor>
<name>sample string 3</name>
<skill>
<id>sample string 1</id>
<name>sample string 2</name>
</skill>
<startdate>2025-05-10T10:44:13.4023104+02:00</startdate>
<timeend>PT0.1234567S</timeend>
<timestart>PT0.1234567S</timestart>
</class>
<commitmentname>sample string 4</commitmentname>
<date>2025-05-10T10:44:13.4023104+02:00</date>
<facilityid>1</facilityid>
<id>1</id>
<lane>1</lane>
<note>sample string 5</note>
<objectid>1</objectid>
<objectname>sample string 2</objectname>
<objecttype>sample string 3</objecttype>
<timeend>2025-05-10T10:44:13.4023104+02:00</timeend>
<timestart>2025-05-10T10:44:13.4023104+02:00</timestart>
</appointment>
<availability>3</availability>
<bookability>bookable</bookability>
<bookings>2</bookings>
<capacity>1</capacity>
<waitlist_count>4</waitlist_count>
</AppointmentAvailability>
</ArrayOfAppointmentAvailability>