ShortlinksAPI

<back to all web services

PostUserLinkRequest

Requires Authentication
The following routes are available for this service:
POST/v4/links

// @DataContract
export class V4BaseRequest
{

    public constructor(init?: Partial<V4BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class V4BaseResponse
{
    // @DataMember(Name="status")
    public status: ResponseStatus;

    public constructor(init?: Partial<V4BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PostUserLinkResponse extends V4BaseResponse
{

    public constructor(init?: Partial<PostUserLinkResponse>) { super(init); (Object as any).assign(this, init); }
}

export enum LinkType
{
    None = 'None',
    Simple = 'Simple',
    Split = 'Split',
    Interstitial = 'Interstitial',
    Advanced = 'Advanced',
    Collection = 'Collection',
}

// @DataContract
export class PostUserLinkRequest extends V4BaseRequest implements IPostUserLinkRequest
{
    // @DataMember(Name="baseCode")
    public baseCode: string;

    // @DataMember(Name="linkType")
    public linkType: LinkType;

    // @DataMember(Name="typeDefinitionPublicId")
    public typeDefinitionPublicId: string;

    public constructor(init?: Partial<PostUserLinkRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript PostUserLinkRequest DTOs

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

HTTP + OTHER

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

{"baseCode":"String","linkType":"None","typeDefinitionPublicId":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"status":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}