BokaMera.API.Host

<back to all web services

TestDateSchedule

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/schedules/date/testTest date scheduleTest date schedule, only administrators are allowed to test schedules.
TestDateSchedule Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
ScheduleDatesbodyList<AddDateScheduleDate>YesThe dates for the schedule. This is the actual timeslots.
FromquerydateTimeYesFrom what datetime to show available times
ToquerydateTimeYesTo what datetime to show available times
ServiceIdbodyint?NoThe Service Duration
AddDateScheduleDate Parameters:
NameParameterData TypeRequiredDescription
FromformDateTimeYesThe from date for the timeslot
ToformDateTimeYesThe to date for the timeslot
AvailableTimesResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
ServiceIdformintNo
TimesFreeTextSingleformstringNo
TimesFreeTextMultipleformstringNo
TimesformList<AvailableTimesSum>No
AvailableTimesSum Parameters:
NameParameterData TypeRequiredDescription
FromformDateTimeNo
ToformDateTimeNo
FreeformintNo
FreeSpotsformintNo
ExceptionTextsformIEnumerable<ExceptionText>No
ExceptionText Parameters:
NameParameterData TypeRequiredDescription
ReasonformstringNo
ReasonPublicformstringNo

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

HTTP + JSV

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

POST /schedules/date/test HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	ScheduleDates: 
	[
		{
			
		}
	],
	ServiceId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ServiceId: 0,
	TimesFreeTextSingle: String,
	TimesFreeTextMultiple: String,
	Times: 
	[
		{
			Free: 0,
			FreeSpots: 0
		}
	]
}