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

import 'package:servicestack/servicestack.dart';

class ReferenceQueryResponse implements IConvertible
{
    /**
    * The company id
    */
    // @ApiMember(Description="The company id")
    String? CompanyId;

    /**
    * Id of the reference
    */
    // @ApiMember(Description="Id of the reference")
    String? Id;

    /**
    * Internal Id of the reference. Example could be the Booking Id
    */
    // @ApiMember(Description="Internal Id of the reference. Example could be the Booking Id")
    String? OwnerId;

    /**
    * 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")
    String? ReferenceType;

    /**
    * 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")
    String? ExternalData;

    /**
    * Will show when the reference was updated.
    */
    // @ApiMember(DataType="datetime", Description="Will show when the reference was updated.")
    DateTime? Updated;

    /**
    * Will show when the reference was created.
    */
    // @ApiMember(DataType="datetime", Description="Will show when the reference was created.")
    DateTime? Created;

    /**
    * Will show who created the reference.
    */
    // @ApiMember(DataType="datetime", Description="Will show who created the reference.")
    String? CreatedBy;

    /**
    * Will show who update the reference.
    */
    // @ApiMember(DataType="datetime", Description="Will show who update the reference.")
    String? UpdatedBy;

    ResponseStatus? ResponseStatus;

    ReferenceQueryResponse({this.CompanyId,this.Id,this.OwnerId,this.ReferenceType,this.ExternalData,this.Updated,this.Created,this.CreatedBy,this.UpdatedBy,this.ResponseStatus});
    ReferenceQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        Id = json['Id'];
        OwnerId = json['OwnerId'];
        ReferenceType = json['ReferenceType'];
        ExternalData = json['ExternalData'];
        Updated = JsonConverters.fromJson(json['Updated'],'DateTime',context!);
        Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
        CreatedBy = json['CreatedBy'];
        UpdatedBy = json['UpdatedBy'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'Id': Id,
        'OwnerId': OwnerId,
        'ReferenceType': ReferenceType,
        'ExternalData': ExternalData,
        'Updated': JsonConverters.toJson(Updated,'DateTime',context!),
        'Created': JsonConverters.toJson(Created,'DateTime',context!),
        'CreatedBy': CreatedBy,
        'UpdatedBy': UpdatedBy,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "ReferenceQueryResponse";
    TypeContext? context = _ctx;
}

// @ValidateRequest(Validator="IsAuthenticated")
class DeleteReference implements ICompany, IConvertible
{
    /**
    * 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.")
    String? CompanyId;

    /**
    * Id of the reference
    */
    // @ApiMember(Description="Id of the reference", IsRequired=true, ParameterType="path")
    String? Id;

    DeleteReference({this.CompanyId,this.Id});
    DeleteReference.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        Id = json['Id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'Id': Id
    };

    getTypeName() => "DeleteReference";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
    'ReferenceQueryResponse': TypeInfo(TypeOf.Class, create:() => ReferenceQueryResponse()),
    'DeleteReference': TypeInfo(TypeOf.Class, create:() => DeleteReference()),
});

Dart 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"}}}