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. |
---|
export class DateScheduleDateResponse
{
public Id: number;
public From: string;
public To: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<DateScheduleDateResponse>) { (Object as any).assign(this, init); }
}
export class ScheduleResources
{
public Id: number;
/** @description Name of the resource */
// @ApiMember(Description="Name of the resource")
public Name: string;
/** @description The image url of the resource */
// @ApiMember(Description="The image url of the resource")
public ImageUrl: string;
public constructor(init?: Partial<ScheduleResources>) { (Object as any).assign(this, init); }
}
export class ScheduleServices
{
public Id: number;
/** @description Name of the service */
// @ApiMember(Description="Name of the service")
public Name: string;
/** @description The image url of the service */
// @ApiMember(Description="The image url of the service")
public ImageUrl: string;
public constructor(init?: Partial<ScheduleServices>) { (Object as any).assign(this, init); }
}
export class DateScheduleQueryResponse
{
/** @description The schedule id */
// @ApiMember(Description="The schedule id")
public Id: number;
/** @description Name of the schedule */
// @ApiMember(Description="Name of the schedule")
public Name: string;
/** @description Description of the schedule */
// @ApiMember(Description="Description of the schedule")
public Description: string;
/** @description If the schedule is active or not */
// @ApiMember(Description="If the schedule is active or not")
public Active: boolean;
/** @description 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 IsResourceSpecific: boolean;
/** @description Schedule dates */
// @ApiMember(Description="Schedule dates")
public ScheduleDates: DateScheduleDateResponse[];
/** @description The resources that is connected to the schedule */
// @ApiMember(Description="The resources that is connected to the schedule")
public Resources: ScheduleResources[];
/** @description The services that is connected to the schedule */
// @ApiMember(Description="The services that is connected to the schedule")
public Services: ScheduleServices[];
/** @description The timestamp when the schedule was updated */
// @ApiMember(Description="The timestamp when the schedule was updated", IsRequired=true)
public UpdatedDate: string;
/** @description The timestamp when the schedule was created */
// @ApiMember(Description="The timestamp when the schedule was created", IsRequired=true)
public CreatedDate: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<DateScheduleQueryResponse>) { (Object as any).assign(this, init); }
}
export class AddDateScheduleDate
{
/** @description The from date for the timeslot */
// @ApiMember(Description="The from date for the timeslot", IsRequired=true)
public From: string;
/** @description The to date for the timeslot */
// @ApiMember(Description="The to date for the timeslot", IsRequired=true)
public To: string;
public constructor(init?: Partial<AddDateScheduleDate>) { (Object as any).assign(this, init); }
}
export class AddScheduleResource
{
/** @description The resource id */
// @ApiMember(Description="The resource id", IsRequired=true)
public Id: number;
public constructor(init?: Partial<AddScheduleResource>) { (Object as any).assign(this, init); }
}
export class AddScheduleService
{
/** @description The service id */
// @ApiMember(Description="The service id", IsRequired=true)
public Id: number;
public constructor(init?: Partial<AddScheduleService>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class UpdateDateSchedule implements ICompany
{
/** @description Id of the schedule to update */
// @ApiMember(Description="Id of the schedule to update", IsRequired=true, ParameterType="path")
public Id: number;
/** @description 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 CompanyId?: string;
/** @description The schedule name */
// @ApiMember(Description="The schedule name")
public Name: string;
/** @description The schedule description */
// @ApiMember(Description="The schedule description")
public Description: string;
/** @description If schedule is active or not */
// @ApiMember(Description="If schedule is active or not")
public Active?: boolean;
/** @description 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 NumberOfScheduleDays: number;
/** @description The dates for the schedule. This is the actual timeslots. */
// @ApiMember(Description="The dates for the schedule. This is the actual timeslots.")
public ScheduleDates: AddDateScheduleDate[];
/** @description 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 Resources: AddScheduleResource[];
/** @description Set what services the schedule should be connected to. */
// @ApiMember(Description="Set what services the schedule should be connected to.")
public Services: AddScheduleService[];
public constructor(init?: Partial<UpdateDateSchedule>) { (Object as any).assign(this, init); }
}
TypeScript 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>