BokaMera.API.Host

<back to all web services

DeleteArticleMapping

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/articles/mappings/{Id}Delete an external article mappingDelete a mapping between a BokaMera article and an article in an external system
import 'package:servicestack/servicestack.dart';

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

    /**
    * The id
    */
    // @ApiMember(Description="The id")
    String Id = "";

    /**
    * The BokaMera article id
    */
    // @ApiMember(Description="The BokaMera article id")
    int ArticleId = 0;

    /**
    * The external reference
    */
    // @ApiMember(Description="The external reference")
    String ExternalReference = "";

    /**
    * The Reference Type
    */
    // @ApiMember(Description="The Reference Type")
    String ReferenceType = "";

    ArticleMappingResponse({this.CompanyId,this.Id,this.ArticleId,this.ExternalReference,this.ReferenceType});
    ArticleMappingResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

// @ValidateRequest(Validator="IsAuthenticated")
class DeleteArticleMapping implements ICompany, IConvertible
{
    /**
    * Company to delete the article mapping for
    */
    // @ApiMember(Description="Company to delete the article mapping for")
    String? CompanyId;

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

    DeleteArticleMapping({this.CompanyId,this.Id});
    DeleteArticleMapping.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() => "DeleteArticleMapping";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'ArticleMappingResponse': TypeInfo(TypeOf.Class, create:() => ArticleMappingResponse()),
    'DeleteArticleMapping': TypeInfo(TypeOf.Class, create:() => DeleteArticleMapping()),
});

Dart DeleteArticleMapping DTOs

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

HTTP + CSV

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

DELETE /articles/mappings/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ArticleId":0,"ExternalReference":"String","ReferenceType":"String"}