Booklinker.API

<back to all web services

PutLinkUpdateRequest

Requires Authentication
The following routes are available for this service:
PUT/v1/links
import 'package:servicestack/servicestack.dart';

// @DataContract
class PutLinkUpdateResponse implements IConvertible
{
    // @DataMember(Name="success")
    bool? success;

    // @DataMember(Name="responseStatus")
    ResponseStatus? responseStatus;

    PutLinkUpdateResponse({this.success,this.responseStatus});
    PutLinkUpdateResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        success = json['success'];
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'success': success,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

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

class PutLinkUpdateRequest implements IConvertible
{
    // @DataMember(Name="baseCode")
    String? baseCode;

    // @DataMember(Name="domain")
    String? domain;

    // @DataMember(Name="code")
    String? code;

    // @DataMember(Name="url")
    String? url;

    PutLinkUpdateRequest({this.baseCode,this.domain,this.code,this.url});
    PutLinkUpdateRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        baseCode = json['baseCode'];
        domain = json['domain'];
        code = json['vanityCode'];
        url = json['newUrl'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'baseCode': baseCode,
        'domain': domain,
        'code': code,
        'url': url
    };

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

TypeContext _ctx = TypeContext(library: 'api.booklinker.com', types: <String, TypeInfo> {
    'PutLinkUpdateResponse': TypeInfo(TypeOf.Class, create:() => PutLinkUpdateResponse()),
    'PutLinkUpdateRequest': TypeInfo(TypeOf.Class, create:() => PutLinkUpdateRequest()),
});

Dart PutLinkUpdateRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

PUT /v1/links HTTP/1.1 
Host: api.booklinker.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"baseCode":"String","domain":"String","code":"String","url":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"success":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}