BokaMera.API.Host

<back to all web services

DeleteDateSchedule

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/schedules/date/{Id}Remove a date scheduleRemove date schedule.
import java.math.*
import java.util.*
import net.servicestack.client.*


@ValidateRequest(Validator="IsAuthenticated")
open class DeleteDateSchedule : 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.")
    var CompanyId:UUID? = null

    /**
    * The schedule id
    */
    @ApiMember(Description="The schedule id", IsRequired=true, ParameterType="path")
    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 DeleteDateSchedule DTOs

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

HTTP + JSV

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

DELETE /schedules/date/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}