Booklinker.API

<back to all web services

PutLinkUpdateRequest

Requires Authentication
The following routes are available for this service:
PUT/v1/links
namespace Booklinker.API.ServiceModel.V1.Requests

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type PutLinkUpdateResponse() = 
        [<DataMember(Name="success")>]
        member val Success:Boolean = new Boolean() with get,set

        [<DataMember(Name="responseStatus")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type PutLinkUpdateRequest() = 
        [<DataMember(Name="baseCode")>]
        member val BaseCode:String = null with get,set

        [<DataMember(Name="domain")>]
        member val Domain:String = null with get,set

        [<DataMember(Name="code")>]
        member val VanityCode:String = null with get,set

        [<DataMember(Name="url")>]
        member val NewUrl:String = null with get,set

F# PutLinkUpdateRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	baseCode: String,
	domain: String,
	code: String,
	url: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}