BokaMera.API.Host

<back to all web services

DeleteReferenceWithReferenceType

The following routes are available for this service:
DELETE/references/{CompanyId}/{OwnerId}/{ReferenceType}Delete a reference with the reference typeDelete a reference
"use strict";
export class ReferenceQueryResponse {
    /** @param {{CompanyId?:string,Id?:string,OwnerId?:string,ReferenceType?:string,ReferenceTypeId?:number,ExternalData?:string,Updated?:string,Created?:string,CreatedBy?:string,UpdatedBy?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /** @type {string} */
    Id;
    /** @type {string} */
    OwnerId;
    /** @type {string} */
    ReferenceType;
    /** @type {number} */
    ReferenceTypeId;
    /** @type {string} */
    ExternalData;
    /** @type {string} */
    Updated;
    /** @type {string} */
    Created;
    /** @type {string} */
    CreatedBy;
    /** @type {string} */
    UpdatedBy;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DeleteReferenceWithReferenceType {
    /** @param {{CompanyId?:string,OwnerId?:string,ReferenceType?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The company id */
    CompanyId;
    /**
     * @type {string}
     * @description Internal Id of the reference. Example could be the Booking Id */
    OwnerId;
    /**
     * @type {string}
     * @description Reference type of the reference */
    ReferenceType;
}

JavaScript DeleteReferenceWithReferenceType 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 /references/{CompanyId}/{OwnerId}/{ReferenceType} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ReferenceType: String,
	ReferenceTypeId: 0,
	ExternalData: String,
	CreatedBy: String,
	UpdatedBy: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}