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.

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); }
}

// @ValidateRequest(Validator="IsAuthenticated")
export class DeleteDateSchedule implements ICompany
{
    /** @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 id */
    // @ApiMember(Description="The schedule id", IsRequired=true, ParameterType="path")
    public Id: number;

    public constructor(init?: Partial<DeleteDateSchedule>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	}
}