BokaMera.API.Host

<back to all web services

UpdateDateSchedule

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/schedules/date/{Id}Update date scheduleUpdate date schedule to the company for the currently logged in user, only administrators are allowed to add schedules.
import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class UpdateDateSchedule : ICompany, Codable
{
    /**
    * Id of the schedule to update
    */
    // @ApiMember(Description="Id of the schedule to update", IsRequired=true, ParameterType="path")
    public var id:Int

    /**
    * 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.")
    public var companyId:String?

    /**
    * The schedule name
    */
    // @ApiMember(Description="The schedule name")
    public var name:String

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

    /**
    * If schedule is active or not
    */
    // @ApiMember(Description="If schedule is active or not")
    public var active:Bool?

    /**
    * 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)
    public var numberOfScheduleDays:Int

    /**
    * The dates for the schedule. This is the actual timeslots.
    */
    // @ApiMember(Description="The dates for the schedule. This is the actual timeslots.")
    public var scheduleDates:[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.")
    public var resources:[AddScheduleResource] = []

    /**
    * Set what services the schedule should be connected to.
    */
    // @ApiMember(Description="Set what services the schedule should be connected to.")
    public var services:[AddScheduleService] = []

    required public init(){}
}

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

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

    required public init(){}
}

public class AddScheduleResource : Codable
{
    /**
    * The resource id
    */
    // @ApiMember(Description="The resource id", IsRequired=true)
    public var id:Int

    required public init(){}
}

public class AddScheduleService : Codable
{
    /**
    * The service id
    */
    // @ApiMember(Description="The service id", IsRequired=true)
    public var id:Int

    required public init(){}
}

public class DateScheduleQueryResponse : Codable
{
    /**
    * The schedule id
    */
    // @ApiMember(Description="The schedule id")
    public var id:Int

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

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

    /**
    * If the schedule is active or not
    */
    // @ApiMember(Description="If the schedule is active or not")
    public var active:Bool

    /**
    * 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)
    public var isResourceSpecific:Bool?

    /**
    * Schedule dates
    */
    // @ApiMember(Description="Schedule dates")
    public var scheduleDates:[DateScheduleDateResponse] = []

    /**
    * The resources that is connected to the schedule
    */
    // @ApiMember(Description="The resources that is connected to the schedule")
    public var resources:[ScheduleResources] = []

    /**
    * The services that is connected to the schedule
    */
    // @ApiMember(Description="The services that is connected to the schedule")
    public var services:[ScheduleServices] = []

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

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

    public var responseStatus:ResponseStatus

    required public init(){}
}

public class DateScheduleDateResponse : Codable
{
    public var id:Int
    public var from:Date
    public var to:Date
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ScheduleResources : Codable
{
    public var id:Int
    /**
    * Name of the resource
    */
    // @ApiMember(Description="Name of the resource")
    public var name:String

    /**
    * The image url of the resource
    */
    // @ApiMember(Description="The image url of the resource")
    public var imageUrl:Uri

    required public init(){}
}

public class ScheduleServices : Codable
{
    public var id:Int
    /**
    * Name of the service
    */
    // @ApiMember(Description="Name of the service")
    public var name:String

    /**
    * The image url of the service
    */
    // @ApiMember(Description="The image url of the service")
    public var imageUrl:Uri

    required public init(){}
}


Swift UpdateDateSchedule DTOs

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

HTTP + CSV

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

PUT /schedules/date/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Id":0,"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: text/csv
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"}}}