BokaMera.API.Host

<back to all web services

DeleteReference

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, SuperAdminVisma
The following routes are available for this service:
DELETE/references/{CompanyId}/{Id}Delete a referenceDelete 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 DeleteReference {
    /** @param {{CompanyId?:string,Id?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {string}
     * @description Id of the reference */
    Id;
}

JavaScript DeleteReference DTOs

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

HTTP + OTHER

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

DELETE /references/{CompanyId}/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}