Booklinker.API

<back to all web services

PutLinkUpdateRequest

Requires Authentication
The following routes are available for this service:
PUT/v1/links
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    public static class PutLinkUpdateRequest
    {
        @DataMember(Name="baseCode")
        @SerializedName("baseCode")
        public String baseCode = null;

        @DataMember(Name="domain")
        @SerializedName("domain")
        public String domain = null;

        @DataMember(Name="code")
        @SerializedName("code")
        public String vanityCode = null;

        @DataMember(Name="url")
        @SerializedName("url")
        public String newUrl = null;
        
        public String getBaseCode() { return baseCode; }
        public PutLinkUpdateRequest setBaseCode(String value) { this.baseCode = value; return this; }
        public String getDomain() { return domain; }
        public PutLinkUpdateRequest setDomain(String value) { this.domain = value; return this; }
        public String getVanityCode() { return vanityCode; }
        public PutLinkUpdateRequest setVanityCode(String value) { this.vanityCode = value; return this; }
        public String getNewUrl() { return newUrl; }
        public PutLinkUpdateRequest setNewUrl(String value) { this.newUrl = value; return this; }
    }

    @DataContract
    public static class PutLinkUpdateResponse
    {
        @DataMember(Name="success")
        @SerializedName("success")
        public Boolean success = null;

        @DataMember(Name="responseStatus")
        @SerializedName("responseStatus")
        public ResponseStatus responseStatus = null;
        
        public Boolean isSuccess() { return success; }
        public PutLinkUpdateResponse setSuccess(Boolean value) { this.success = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public PutLinkUpdateResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java 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>