Availability dates¶
The availability dates API allows you to retrieve availability of a specified product offering. For course product offerings a list of available start dates will be returned. You need to authenticate using an API Key in order to call this service; see the Authentication section for further details
- URL
/v1/product/availability-dates/{SchoolCode}/{ProductCode}
- HTTP Method
GET
- Client Library Message Name
Product.GetAvailabilityDatesRequest
Request parameters | |||
---|---|---|---|
Name | Type | Required? | Description |
SchoolCode | string | Yes | The school code, see Schools |
ProductCode | string | Yes | The product code, see Products |
Sample request¶
Error
Failed to run contract transformer command: bin\Api.ContractTransformer.exe
{ "SchoolCode": "LON", "ProductCode": "C1" }
Sample response¶
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Content-Length: 513
{
"StartDates": [
{
"Date": "2016-01-25",
"NumberOfWeeks": [
{
"Minimum": 1,
"Maximum": 23
}
]
},
{
"Date": "2016-02-01",
"NumberOfWeeks": [
{
"Minimum": 1,
"Maximum": 23
}
]
},
{
"Date": "2016-02-08",
"NumberOfWeeks": [
{
"Minimum": 1,
"Maximum": 23
}
]
}
],
"AvailabilityDateRanges": []
}
HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8
Cache-Control: no-cache
Content-Length: 287
<GetAvailabilityDatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EcEnglish.Api.ServiceContract.Product">
<AvailabilityDateRanges />
<Results
i:nil="true" />
</GetAvailabilityDatesResponse>