ShortlinksAPI

<back to all web services

PutUserLinkRequest

Requires Authentication
The following routes are available for this service:
PUT/v4/links
PUT/v4/links/{Id}
namespace Geniuslink.Shortlinks.Constants

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type V4BaseResponse() = 
        [<DataMember(Name="status")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type PutUserLinkResponse() = 
        inherit V4BaseResponse()

    [<DataContract>]
    [<AllowNullLiteral>]
    type V4BaseRequest() = 
        class end

    type LinkType =
        | None = 0
        | Simple = 1
        | Split = 2
        | Interstitial = 3
        | Advanced = 4
        | Collection = 5

    [<DataContract>]
    [<AllowNullLiteral>]
    type PutUserLinkRequest() = 
        inherit V4BaseRequest()
        [<DataMember(Name="id")>]
        member val Id:String = null with get,set

        [<DataMember(Name="linkType")>]
        member val LinkType:LinkType = new LinkType() with get,set

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

F# PutUserLinkRequest 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 /v4/links HTTP/1.1 
Host: shortlinks-api.qa.platform.georiot.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PutUserLinkRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShortlinksAPI.ServiceModel.V4.Requests">
  <id>String</id>
  <linkType>None</linkType>
  <typeDefinitionPublicId>String</typeDefinitionPublicId>
</PutUserLinkRequest>

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

<PutUserLinkResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShortlinksAPI.ServiceModel.V4.Responses">
  <status 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>
  </status>
</PutUserLinkResponse>