BokaMera.API.Host

<back to all web services

CreateDateSchedule

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/schedules/dateAdd new date scheduleAdd new date schedule to the company for the currently logged in user, only administrators are allowed to add schedules.
import java.math.*
import java.util.*
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class CreateDateSchedule : ICompany
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    var CompanyId:UUID? = null

    /**
    * The schedule name
    */
    @ApiMember(Description="The schedule name")
    var Name:String? = null

    /**
    * The schedule description
    */
    @ApiMember(Description="The schedule description")
    var Description:String? = null

    /**
    * If schedule is active or not
    */
    @ApiMember(Description="If schedule is active or not")
    var Active:Boolean? = null

    /**
    * The number of days the schedule is valid from todays date
    */
    @ApiMember(Description="The number of days the schedule is valid from todays date", IsRequired=true)
    var NumberOfScheduleDays:Int? = null

    /**
    * The dates for the schedule. This is the actual timeslots.
    */
    @ApiMember(Description="The dates for the schedule. This is the actual timeslots.")
    var ScheduleDates:ArrayList<AddDateScheduleDate> = ArrayList<AddDateScheduleDate>()

    /**
    * If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources.
    */
    @ApiMember(Description="If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources.")
    var Resources:ArrayList<AddScheduleResource> = ArrayList<AddScheduleResource>()

    /**
    * Set what services the schedule should be connected to.
    */
    @ApiMember(Description="Set what services the schedule should be connected to.")
    var Services:ArrayList<AddScheduleService> = ArrayList<AddScheduleService>()
}

open class AddDateScheduleDate
{
    /**
    * The from date for the timeslot
    */
    @ApiMember(Description="The from date for the timeslot", IsRequired=true)
    var From:Date? = null

    /**
    * The to date for the timeslot
    */
    @ApiMember(Description="The to date for the timeslot", IsRequired=true)
    var To:Date? = null
}

open class AddScheduleResource
{
    /**
    * The resource id
    */
    @ApiMember(Description="The resource id", IsRequired=true)
    var Id:Int? = null
}

open class AddScheduleService
{
    /**
    * The service id
    */
    @ApiMember(Description="The service id", IsRequired=true)
    var Id:Int? = null
}

open class DateScheduleQueryResponse
{
    /**
    * The schedule id
    */
    @ApiMember(Description="The schedule id")
    var Id:Int? = null

    /**
    * Name of the schedule
    */
    @ApiMember(Description="Name of the schedule")
    var Name:String? = null

    /**
    * Description of the schedule
    */
    @ApiMember(Description="Description of the schedule")
    var Description:String? = null

    /**
    * If the schedule is active or not
    */
    @ApiMember(Description="If the schedule is active or not")
    var Active:Boolean? = null

    /**
    * If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.
    */
    @ApiMember(Description="If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.", IsRequired=true)
    var IsResourceSpecific:Boolean? = null

    /**
    * Schedule dates
    */
    @ApiMember(Description="Schedule dates")
    var ScheduleDates:ArrayList<DateScheduleDateResponse> = ArrayList<DateScheduleDateResponse>()

    /**
    * The resources that is connected to the schedule
    */
    @ApiMember(Description="The resources that is connected to the schedule")
    var Resources:ArrayList<ScheduleResources> = ArrayList<ScheduleResources>()

    /**
    * The services that is connected to the schedule
    */
    @ApiMember(Description="The services that is connected to the schedule")
    var Services:ArrayList<ScheduleServices> = ArrayList<ScheduleServices>()

    /**
    * The timestamp when the schedule was updated
    */
    @ApiMember(Description="The timestamp when the schedule was updated", IsRequired=true)
    var UpdatedDate:Date? = null

    /**
    * The timestamp when the schedule was created
    */
    @ApiMember(Description="The timestamp when the schedule was created", IsRequired=true)
    var CreatedDate:Date? = null

    var ResponseStatus:ResponseStatus? = null
}

open class DateScheduleDateResponse
{
    var Id:Int? = null
    var From:Date? = null
    var To:Date? = null
    var ResponseStatus:ResponseStatus? = null
}

open class ScheduleResources
{
    var Id:Int? = null
    /**
    * Name of the resource
    */
    @ApiMember(Description="Name of the resource")
    var Name:String? = null

    /**
    * The image url of the resource
    */
    @ApiMember(Description="The image url of the resource")
    var ImageUrl:Uri? = null
}

open class ScheduleServices
{
    var Id:Int? = null
    /**
    * Name of the service
    */
    @ApiMember(Description="Name of the service")
    var Name:String? = null

    /**
    * The image url of the service
    */
    @ApiMember(Description="The image url of the service")
    var ImageUrl:Uri? = null
}

Kotlin CreateDateSchedule DTOs

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.

POST /schedules/date HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","Active":false,"NumberOfScheduleDays":0,"ScheduleDates":[{}],"Resources":[{"Id":0}],"Services":[{"Id":0}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Id":0,"Name":"String","Description":"String","Active":false,"IsResourceSpecific":false,"ScheduleDates":[{"Id":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}],"Resources":[{"Id":0,"Name":"String"}],"Services":[{"Id":0,"Name":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}