Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /schedules/date/{Id} | Update date schedule | Update 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 UpdateDateSchedule : ICompany
{
/**
* Id of the schedule to update
*/
@ApiMember(Description="Id of the schedule to update", IsRequired=true, ParameterType="path")
var Id:Int? = null
/**
* 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 UpdateDateSchedule DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateDateSchedule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Active>false</Active>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
<NumberOfScheduleDays>0</NumberOfScheduleDays>
<Resources>
<AddScheduleResource>
<Id>0</Id>
</AddScheduleResource>
</Resources>
<ScheduleDates>
<AddDateScheduleDate>
<From>0001-01-01T00:00:00</From>
<To>0001-01-01T00:00:00</To>
</AddDateScheduleDate>
</ScheduleDates>
<Services>
<AddScheduleService>
<Id>0</Id>
</AddScheduleService>
</Services>
</UpdateDateSchedule>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <DateScheduleQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <Active>false</Active> <CreatedDate>0001-01-01T00:00:00</CreatedDate> <Description>String</Description> <Id>0</Id> <IsResourceSpecific>false</IsResourceSpecific> <Name>String</Name> <Resources> <ScheduleResources> <Id>0</Id> <ImageUrl i:nil="true" /> <Name>String</Name> </ScheduleResources> </Resources> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <ScheduleDates> <DateScheduleDateResponse> <From>0001-01-01T00:00:00</From> <Id>0</Id> <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types"> <d4p1:ErrorCode>String</d4p1:ErrorCode> <d4p1:Message>String</d4p1:Message> <d4p1:StackTrace>String</d4p1:StackTrace> <d4p1:Errors> <d4p1:ResponseError> <d4p1:ErrorCode>String</d4p1:ErrorCode> <d4p1:FieldName>String</d4p1:FieldName> <d4p1:Message>String</d4p1:Message> <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:KeyValueOfstringstring> <d7p1:Key>String</d7p1:Key> <d7p1:Value>String</d7p1:Value> </d7p1:KeyValueOfstringstring> </d4p1:Meta> </d4p1:ResponseError> </d4p1:Errors> <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d4p1:Meta> </ResponseStatus> <To>0001-01-01T00:00:00</To> </DateScheduleDateResponse> </ScheduleDates> <Services> <ScheduleServices> <Id>0</Id> <ImageUrl i:nil="true" /> <Name>String</Name> </ScheduleServices> </Services> <UpdatedDate>0001-01-01T00:00:00</UpdatedDate> </DateScheduleQueryResponse>