@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api agentOS API V3, Diary Call Group
@base https://live-api.letmc.com
@version v3-diary
@auth basic | ApiKey ApiKey in header
@endpoints 13
@toc diary(13)

@endpoint GET /v3/diary/{shortname}/{branchID}/guest/search
@required {shortname: any, branchID: any, forename: any, emailaddress: any, surname: any, offset: any, count: any}
@returns(200)

@endpoint GET /v3/diary/{shortName}/allocations
@required {shortName: any, preferredDate: any, appointmentType: any}
@optional {lettings: any, propertyIdentifier: any, branchID: any}
@returns(200)

@endpoint GET /v3/diary/{shortName}/appointment
@required {shortName: any, appointmentID: any}
@returns(200)

@endpoint PUT /v3/diary/{shortName}/appointment
@required {shortName: any, appointmentID: any, appointmentDetails: map}
@optional {lettings: any, AllowMarketingCorrespondence: any}
@returns(200)

@endpoint POST /v3/diary/{shortName}/appointment
@required {shortName: any, propertyIdentifier: any, appointmentDetails: map}
@optional {lettings: any}
@returns(200)

@endpoint DELETE /v3/diary/{shortName}/appointment
@required {shortName: any, appointmentID: any}
@returns(200)

@endpoint PATCH /v3/diary/{shortName}/appointment/{appointmentID}/cancel
@required {shortName: any, appointmentID: any}
@returns(200)

@endpoint POST /v3/diary/{shortName}/appointment/feedback
@required {shortName: any, submissionModel: map}
@returns(200)

@endpoint GET /v3/diary/{shortName}/appointmentsbetweendates
@required {shortName: any, branchID: any, startDate: any, endDate: any, appointmentTypesToSearch: any, offset: any, count: any}
@returns(200)

@endpoint GET /v3/diary/{shortName}/appointmenttypes
@required {shortName: any, offset: any, count: any}
@returns(200)

@endpoint GET /v3/diary/{shortName}/company/branches
@required {shortName: any, offset: any, count: any}
@returns(200)

@endpoint GET /v3/diary/{shortName}/company/branches/{branchID}
@required {shortName: any, branchID: any}
@returns(200)

@endpoint GET /v3/diary/{shortName}/recurringappointment
@required {shortName: any, branchID: any, appointmentTypesToSearch: any, offset: any, count: any}
@returns(200)

@end
