Client Course
List client courses
Get a list of client courses for the specified business id. List can be filtered by branch id, client id and a possibility to include archived client courses or courses with no remaining units.
get/api/business/{businessId}/clientcourse
Path parameters
businessIdstring required
Query parameters
branch_idstring
branch id to filter by
client_idstring
client id to filter by
includeArchivedboolean
include archived client courses in the list
includeUsedCourseItemsboolean
include course items with no remaining units
number of client course records to return, max is 100
page number, default is 0 and is optional
Response
Client courses listed
Example response
{
"_embedded": {
"clientCourses": [
{
"clientCourseId": "ab123",
"purchaseDate": "2018-01-01",
"expiryDate": "2018-01-01",
"clientId": "ab123",
"purchasingBranchId": "ab123",
"courseId": "ab123",
"courseName": "10 x Massage",
"grossPrice": 100,
"netPrice": 80,
"clientCourseItems": [
{
"clientCourseItemId": "ab123",
"courseItemId": "ab123",
"serviceId": "ab123",
"initialUnits": 10,
"remainingUnits": 5,
"grossPrice": 100,
"netPrice": 80
}
]
}
]
}
}