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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<PutLinkUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.Requests">
  <BaseCode>String</BaseCode>
  <Domain>String</Domain>
  <NewUrl>String</NewUrl>
  <VanityCode>String</VanityCode>
</PutLinkUpdateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PutLinkUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Booklinker.API.ServiceModel.V1.Responses">
  <responseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </responseStatus>
  <success>false</success>
</PutLinkUpdateResponse>