| 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. |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
namespace BokaMera.API.ServiceModel.Dtos
{
public partial class AddDateScheduleDate
{
///<summary>
///The from date for the timeslot
///</summary>
[ApiMember(Description="The from date for the timeslot", IsRequired=true)]
public virtual DateTime From { get; set; }
///<summary>
///The to date for the timeslot
///</summary>
[ApiMember(Description="The to date for the timeslot", IsRequired=true)]
public virtual DateTime To { get; set; }
}
public partial class AddScheduleResource
{
///<summary>
///The resource id
///</summary>
[ApiMember(Description="The resource id", IsRequired=true)]
public virtual int Id { get; set; }
}
public partial class AddScheduleService
{
///<summary>
///The service id
///</summary>
[ApiMember(Description="The service id", IsRequired=true)]
public virtual int Id { get; set; }
}
public partial class DateScheduleDateResponse
{
public virtual int Id { get; set; }
public virtual DateTime From { get; set; }
public virtual DateTime To { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
public partial class DateScheduleQueryResponse
{
public DateScheduleQueryResponse()
{
ScheduleDates = new List<DateScheduleDateResponse>{};
Resources = new List<ScheduleResources>{};
Services = new List<ScheduleServices>{};
}
///<summary>
///The schedule id
///</summary>
[ApiMember(Description="The schedule id")]
public virtual int Id { get; set; }
///<summary>
///Name of the schedule
///</summary>
[ApiMember(Description="Name of the schedule")]
public virtual string Name { get; set; }
///<summary>
///Description of the schedule
///</summary>
[ApiMember(Description="Description of the schedule")]
public virtual string Description { get; set; }
///<summary>
///If the schedule is active or not
///</summary>
[ApiMember(Description="If the schedule is active or not")]
public virtual bool Active { get; set; }
///<summary>
///If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.
///</summary>
[ApiMember(Description="If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.", IsRequired=true)]
public virtual bool? IsResourceSpecific { get; set; }
///<summary>
///Schedule dates
///</summary>
[ApiMember(Description="Schedule dates")]
public virtual List<DateScheduleDateResponse> ScheduleDates { get; set; }
///<summary>
///The resources that is connected to the schedule
///</summary>
[ApiMember(Description="The resources that is connected to the schedule")]
public virtual List<ScheduleResources> Resources { get; set; }
///<summary>
///The services that is connected to the schedule
///</summary>
[ApiMember(Description="The services that is connected to the schedule")]
public virtual List<ScheduleServices> Services { get; set; }
///<summary>
///The timestamp when the schedule was updated
///</summary>
[ApiMember(Description="The timestamp when the schedule was updated", IsRequired=true)]
public virtual DateTime UpdatedDate { get; set; }
///<summary>
///The timestamp when the schedule was created
///</summary>
[ApiMember(Description="The timestamp when the schedule was created", IsRequired=true)]
public virtual DateTime CreatedDate { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
public partial class ScheduleResources
{
public virtual int Id { get; set; }
///<summary>
///Name of the resource
///</summary>
[ApiMember(Description="Name of the resource")]
public virtual string Name { get; set; }
///<summary>
///The image url of the resource
///</summary>
[ApiMember(Description="The image url of the resource")]
public virtual Uri ImageUrl { get; set; }
}
public partial class ScheduleServices
{
public virtual int Id { get; set; }
///<summary>
///Name of the service
///</summary>
[ApiMember(Description="Name of the service")]
public virtual string Name { get; set; }
///<summary>
///The image url of the service
///</summary>
[ApiMember(Description="The image url of the service")]
public virtual Uri ImageUrl { get; set; }
}
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
[ValidateRequest("IsAuthenticated")]
public partial class UpdateDateSchedule
: ICompany
{
public UpdateDateSchedule()
{
ScheduleDates = new List<AddDateScheduleDate>{};
Resources = new List<AddScheduleResource>{};
Services = new List<AddScheduleService>{};
}
///<summary>
///Id of the schedule to update
///</summary>
[ApiMember(Description="Id of the schedule to update", IsRequired=true, ParameterType="path")]
public virtual int Id { get; set; }
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
public virtual Guid? CompanyId { get; set; }
///<summary>
///The schedule name
///</summary>
[ApiMember(Description="The schedule name")]
public virtual string Name { get; set; }
///<summary>
///The schedule description
///</summary>
[ApiMember(Description="The schedule description")]
public virtual string Description { get; set; }
///<summary>
///If schedule is active or not
///</summary>
[ApiMember(Description="If schedule is active or not")]
public virtual bool? Active { get; set; }
///<summary>
///The number of days the schedule is valid from todays date
///</summary>
[ApiMember(Description="The number of days the schedule is valid from todays date", IsRequired=true)]
public virtual int NumberOfScheduleDays { get; set; }
///<summary>
///The dates for the schedule. This is the actual timeslots.
///</summary>
[ApiMember(Description="The dates for the schedule. This is the actual timeslots.")]
public virtual List<AddDateScheduleDate> ScheduleDates { get; set; }
///<summary>
///If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources.
///</summary>
[ApiMember(Description="If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources.")]
public virtual List<AddScheduleResource> Resources { get; set; }
///<summary>
///Set what services the schedule should be connected to.
///</summary>
[ApiMember(Description="Set what services the schedule should be connected to.")]
public virtual List<AddScheduleService> Services { get; set; }
}
}
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>