ShortlinksAPI

<back to all web services

PostUserLinkRequest

Requires Authentication
The following routes are available for this service:
POST/v4/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
{

    @DataContract
    public static class PostUserLinkRequest extends V4BaseRequest implements IPostUserLinkRequest
    {
        @DataMember(Name="baseCode")
        @SerializedName("baseCode")
        public String baseCode = null;

        @DataMember(Name="linkType")
        @SerializedName("linkType")
        public LinkType linkType = null;

        @DataMember(Name="typeDefinitionPublicId")
        @SerializedName("typeDefinitionPublicId")
        public String typeDefinitionPublicId = null;
        
        public String getBaseCode() { return baseCode; }
        public PostUserLinkRequest setBaseCode(String value) { this.baseCode = value; return this; }
        public LinkType getLinkType() { return linkType; }
        public PostUserLinkRequest setLinkType(LinkType value) { this.linkType = value; return this; }
        public String getTypeDefinitionPublicId() { return typeDefinitionPublicId; }
        public PostUserLinkRequest setTypeDefinitionPublicId(String value) { this.typeDefinitionPublicId = value; return this; }
    }

    @DataContract
    public static class V4BaseRequest
    {
        
    }

    public static enum LinkType
    {
        None,
        Simple,
        Split,
        Interstitial,
        Advanced,
        Collection;
    }

    @DataContract
    public static class PostUserLinkResponse extends V4BaseResponse
    {
        
    }

    @DataContract
    public static class V4BaseResponse
    {
        @DataMember(Name="status")
        @SerializedName("status")
        public ResponseStatus responseStatus = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public V4BaseResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

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

POST /v4/links HTTP/1.1 
Host: shortlinks-api.qa.platform.georiot.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostUserLinkRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShortlinksAPI.ServiceModel.V4.Requests">
  <baseCode>String</baseCode>
  <linkType>None</linkType>
  <typeDefinitionPublicId>String</typeDefinitionPublicId>
</PostUserLinkRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostUserLinkResponse 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>
</PostUserLinkResponse>