POST api/WLR3/Appointment
This method gives the user an appointment key which can then be used when logging a fault using the POST-api-WLR3-Fault method
Request Information
URI Parameters
None.
Body Parameters
ReserveAppointmentPOST| Name | Description | Type | Additional information |
|---|---|---|---|
| Lines | Line or channel number | integer |
None. |
| Date | The date of the appointment | string |
None. |
| Slot | This is the appointment slot ID | Wlr3AppointmentTimeSlot |
None. |
| CLI | The CLI the appointment is for | string |
None. |
| ServiceMaintenanceLevel | The Service Mainteance level for this company | string |
None. |
| NewProvide | Indicates whether this appointment is for a newly provisioned line | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Lines": 1,
"Date": "sample string 2",
"Slot": 0,
"CLI": "sample string 3",
"ServiceMaintenanceLevel": "sample string 4",
"NewProvide": true
}
application/xml, text/xml
Sample:
<ReserveAppointmentPOST xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models"> <CLI>sample string 3</CLI> <Date>sample string 2</Date> <Lines>1</Lines> <NewProvide>true</NewProvide> <ServiceMaintenanceLevel>sample string 4</ServiceMaintenanceLevel> <Slot>Wlr3AppointmentTimeslotAM</Slot> </ReserveAppointmentPOST>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ReserveAppointmentResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Date | Date of appointment | string |
None. |
| Time | Textual description of appopintment Slot | string |
None. |
| Slot | Slot ID | Wlr3AppointmentTimeSlot |
None. |
| AppointmentKey | Openreach appointment referrence. This is used when POSTING a fault | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Date": "sample string 1",
"Time": "sample string 2",
"Slot": 0,
"AppointmentKey": "sample string 3"
}
application/xml, text/xml
Sample:
<ReserveAppointmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/aBILLity.API.Models"> <AppointmentKey>sample string 3</AppointmentKey> <Date>sample string 1</Date> <Slot>Wlr3AppointmentTimeslotAM</Slot> <Time>sample string 2</Time> </ReserveAppointmentResponse>