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.*;

public class dtos
{

    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    @ValidateRequest(Validator="IsAuthenticated")
    public static class CreateDateSchedule implements 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.")
        public UUID CompanyId = null;

        /**
        * The schedule name
        */
        @ApiMember(Description="The schedule name")
        public String Name = null;

        /**
        * The schedule description
        */
        @ApiMember(Description="The schedule description")
        public String Description = null;

        /**
        * If schedule is active or not
        */
        @ApiMember(Description="If schedule is active or not")
        public Boolean Active = 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)
        public Integer NumberOfScheduleDays = null;

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

        /**
        * 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 ArrayList<AddScheduleResource> Resources = null;

        /**
        * Set what services the schedule should be connected to.
        */
        @ApiMember(Description="Set what services the schedule should be connected to.")
        public ArrayList<AddScheduleService> Services = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public CreateDateSchedule setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getName() { return Name; }
        public CreateDateSchedule setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public CreateDateSchedule setDescription(String value) { this.Description = value; return this; }
        public Boolean isActive() { return Active; }
        public CreateDateSchedule setActive(Boolean value) { this.Active = value; return this; }
        public Integer getNumberOfScheduleDays() { return NumberOfScheduleDays; }
        public CreateDateSchedule setNumberOfScheduleDays(Integer value) { this.NumberOfScheduleDays = value; return this; }
        public ArrayList<AddDateScheduleDate> getScheduleDates() { return ScheduleDates; }
        public CreateDateSchedule setScheduleDates(ArrayList<AddDateScheduleDate> value) { this.ScheduleDates = value; return this; }
        public ArrayList<AddScheduleResource> getResources() { return Resources; }
        public CreateDateSchedule setResources(ArrayList<AddScheduleResource> value) { this.Resources = value; return this; }
        public ArrayList<AddScheduleService> getServices() { return Services; }
        public CreateDateSchedule setServices(ArrayList<AddScheduleService> value) { this.Services = value; return this; }
    }

    public static class AddDateScheduleDate
    {
        /**
        * The from date for the timeslot
        */
        @ApiMember(Description="The from date for the timeslot", IsRequired=true)
        public Date From = null;

        /**
        * The to date for the timeslot
        */
        @ApiMember(Description="The to date for the timeslot", IsRequired=true)
        public Date To = null;
        
        public Date getFrom() { return From; }
        public AddDateScheduleDate setFrom(Date value) { this.From = value; return this; }
        public Date getTo() { return To; }
        public AddDateScheduleDate setTo(Date value) { this.To = value; return this; }
    }

    public static class AddScheduleResource
    {
        /**
        * The resource id
        */
        @ApiMember(Description="The resource id", IsRequired=true)
        public Integer Id = null;
        
        public Integer getId() { return Id; }
        public AddScheduleResource setId(Integer value) { this.Id = value; return this; }
    }

    public static class AddScheduleService
    {
        /**
        * The service id
        */
        @ApiMember(Description="The service id", IsRequired=true)
        public Integer Id = null;
        
        public Integer getId() { return Id; }
        public AddScheduleService setId(Integer value) { this.Id = value; return this; }
    }

    public static class DateScheduleQueryResponse
    {
        /**
        * The schedule id
        */
        @ApiMember(Description="The schedule id")
        public Integer Id = null;

        /**
        * Name of the schedule
        */
        @ApiMember(Description="Name of the schedule")
        public String Name = null;

        /**
        * Description of the schedule
        */
        @ApiMember(Description="Description of the schedule")
        public String Description = null;

        /**
        * If the schedule is active or not
        */
        @ApiMember(Description="If the schedule is active or not")
        public Boolean Active = 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)
        public Boolean IsResourceSpecific = null;

        /**
        * Schedule dates
        */
        @ApiMember(Description="Schedule dates")
        public ArrayList<DateScheduleDateResponse> ScheduleDates = null;

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

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

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

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

        public ResponseStatus ResponseStatus = null;
        
        public Integer getId() { return Id; }
        public DateScheduleQueryResponse setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public DateScheduleQueryResponse setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public DateScheduleQueryResponse setDescription(String value) { this.Description = value; return this; }
        public Boolean isActive() { return Active; }
        public DateScheduleQueryResponse setActive(Boolean value) { this.Active = value; return this; }
        public Boolean getIsResourceSpecific() { return IsResourceSpecific; }
        public DateScheduleQueryResponse setIsResourceSpecific(Boolean value) { this.IsResourceSpecific = value; return this; }
        public ArrayList<DateScheduleDateResponse> getScheduleDates() { return ScheduleDates; }
        public DateScheduleQueryResponse setScheduleDates(ArrayList<DateScheduleDateResponse> value) { this.ScheduleDates = value; return this; }
        public ArrayList<ScheduleResources> getResources() { return Resources; }
        public DateScheduleQueryResponse setResources(ArrayList<ScheduleResources> value) { this.Resources = value; return this; }
        public ArrayList<ScheduleServices> getServices() { return Services; }
        public DateScheduleQueryResponse setServices(ArrayList<ScheduleServices> value) { this.Services = value; return this; }
        public Date getUpdatedDate() { return UpdatedDate; }
        public DateScheduleQueryResponse setUpdatedDate(Date value) { this.UpdatedDate = value; return this; }
        public Date getCreatedDate() { return CreatedDate; }
        public DateScheduleQueryResponse setCreatedDate(Date value) { this.CreatedDate = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public DateScheduleQueryResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class DateScheduleDateResponse
    {
        public Integer Id = null;
        public Date From = null;
        public Date To = null;
        public ResponseStatus ResponseStatus = null;
        
        public Integer getId() { return Id; }
        public DateScheduleDateResponse setId(Integer value) { this.Id = value; return this; }
        public Date getFrom() { return From; }
        public DateScheduleDateResponse setFrom(Date value) { this.From = value; return this; }
        public Date getTo() { return To; }
        public DateScheduleDateResponse setTo(Date value) { this.To = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public DateScheduleDateResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class ScheduleResources
    {
        public Integer Id = null;
        /**
        * Name of the resource
        */
        @ApiMember(Description="Name of the resource")
        public String Name = null;

        /**
        * The image url of the resource
        */
        @ApiMember(Description="The image url of the resource")
        public Uri ImageUrl = null;
        
        public Integer getId() { return Id; }
        public ScheduleResources setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public ScheduleResources setName(String value) { this.Name = value; return this; }
        public Uri getImageUrl() { return ImageUrl; }
        public ScheduleResources setImageUrl(Uri value) { this.ImageUrl = value; return this; }
    }

    public static class ScheduleServices
    {
        public Integer Id = null;
        /**
        * Name of the service
        */
        @ApiMember(Description="Name of the service")
        public String Name = null;

        /**
        * The image url of the service
        */
        @ApiMember(Description="The image url of the service")
        public Uri ImageUrl = null;
        
        public Integer getId() { return Id; }
        public ScheduleServices setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public ScheduleServices setName(String value) { this.Name = value; return this; }
        public Uri getImageUrl() { return ImageUrl; }
        public ScheduleServices setImageUrl(Uri value) { this.ImageUrl = value; return this; }
    }

}

Java CreateDateSchedule DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<CreateDateSchedule 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>
  <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>
</CreateDateSchedule>
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>