BokaMera.API.Host

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 reference	Delete a reference


export class ReferenceQueryResponse
{
    /** @description The company id */
    // @ApiMember(Description="The company id")
    public CompanyId: string;

    /** @description Id of the reference */
    // @ApiMember(Description="Id of the reference")
    public Id: string;

    /** @description Internal Id of the reference. Example could be the Booking Id */
    // @ApiMember(Description="Internal Id of the reference. Example could be the Booking Id")
    public OwnerId: string;

    /** @description The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system */
    // @ApiMember(Description="The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system")
    public ReferenceType: string;

    /** @description The external data. Could be a Id or a JSON object or anything */
    // @ApiMember(Description="The external data. Could be a Id or a JSON object or anything")
    public ExternalData: string;

    /** @description Will show when the reference was updated. */
    // @ApiMember(DataType="datetime", Description="Will show when the reference was updated.")
    public Updated: string;

    /** @description Will show when the reference was created. */
    // @ApiMember(DataType="datetime", Description="Will show when the reference was created.")
    public Created: string;

    /** @description Will show who created the reference. */
    // @ApiMember(DataType="datetime", Description="Will show who created the reference.")
    public CreatedBy: string;

    /** @description Will show who update the reference. */
    // @ApiMember(DataType="datetime", Description="Will show who update the reference.")
    public UpdatedBy: string;

    public ResponseStatus: ResponseStatus;

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

// @ValidateRequest(Validator="IsAuthenticated")
export class DeleteReference 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 Id of the reference */
    // @ApiMember(Description="Id of the reference", IsRequired=true, ParameterType="path")
    public Id: string;

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

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