BokaMera.API.Host

<back to all web services

DeleteResourceTimeException

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/timeexceptions/{Id}Delete a given time exception that the user have access too
DeleteResourceTimeException Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
IdpathintNoTime exception id to be deleted
ResourceTimeExceptionQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoTime exception id
CompanyIdformGuidNoTime company id
LockedformboolNoIf it's locked for editing for the logged in administrator
ResourceIdsformint[]NoResources that owns this exception
ResourcesformList<TimeExceptionReosurceDetails>NoResources that owns this exception
IsRecurringformboolNoIndicates wheter or not the time exception is recurring
FromformDateTimeNoTime exception starting timestamp
ToformDateTimeNoTime exception ending timestamp
FromTimeformTimeSpanNoIf recurring then this value indicates the time of day when the time exception begins
ToTimeformTimeSpanNoIf recurring then this value indicates the time of day when the time exception ends
ReasonTextformstringNoThe reason of the time exception, example: Vacation, doctors appointment, ...
ReasonTextPublicformstringNoThe reason of the time exception that could be public to customers, example: Vacation, Closed, Sick leave, ...
ColorformstringNoWhat hexadecimal color code the exception should have in the scheduler
BlockTimeformboolNoIf the time exception should block the time in the scheduler so it's not avaialable to book
PrivateformboolNoIf the ReasonText should only be visible to conncted resources. If false, all resources will be able to see it
CalendarExportStatusformExceptionCalendarExportStatusNoThe status for export to calendars like Gcal
DaysOfWeekformList<DayOfWeekDto>NoIf recurring, an array indicating which days of the week the exception recures on where 1 = Monday .. 7 = Sunday. When recurring then the time portion of the Fields From and To indicates the time of day the recurrence occurs
CreatedformDateTimeNoThe datetime the exception was created
ResponseStatusformResponseStatusNo
TimeExceptionReosurceDetails Parameters:
NameParameterData TypeRequiredDescription
IdformintNoIds of the resources that owns this exception
NameformstringNoName of the resource
DescriptionformstringNoDescription of the resource
ColorformstringNoColor of the resource
ImageUrlformUriNoImage of the resource
ResponseStatusformResponseStatusNo
ExceptionCalendarExportStatus Parameters:
NameParameterData TypeRequiredDescription
CalendarIdformstringNo
ExceptionIdformintNo
Syncedformbool?No
DayOfWeekDto Parameters:
NameParameterData TypeRequiredDescription
DayOfWeekIdformintNo
DotNetDayOfWeekIdformintNo
DayOfWeekformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /timeexceptions/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Id":0,"Locked":false,"ResourceIds":[0],"Resources":[{"Id":0,"Name":"String","Description":"String","Color":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}],"IsRecurring":false,"FromTime":"00:00:00","ToTime":"00:00:00","ReasonText":"String","ReasonTextPublic":"String","Color":"String","BlockTime":false,"Private":false,"CalendarExportStatus":{"CalendarId":"String","ExceptionId":0,"Synced":false},"DaysOfWeek":[{"DayOfWeekId":0,"DotNetDayOfWeekId":0,"DayOfWeek":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}