| POST | /v4/links |
|---|
"use strict";
export class V4BaseRequest {
constructor(init) { Object.assign(this, init) }
}
export class V4BaseResponse {
/** @param {{status?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
status;
}
export class PostUserLinkResponse extends V4BaseResponse {
/** @param {{status?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
/** @typedef {'None'|'Simple'|'Split'|'Interstitial'|'Advanced'|'Collection'} */
export var LinkType;
(function (LinkType) {
LinkType["None"] = "None"
LinkType["Simple"] = "Simple"
LinkType["Split"] = "Split"
LinkType["Interstitial"] = "Interstitial"
LinkType["Advanced"] = "Advanced"
LinkType["Collection"] = "Collection"
})(LinkType || (LinkType = {}));
export class PostUserLinkRequest extends V4BaseRequest {
/** @param {{baseCode?:string,linkType?:LinkType,typeDefinitionPublicId?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
baseCode;
/** @type {LinkType} */
linkType;
/** @type {string} */
typeDefinitionPublicId;
}
JavaScript PostUserLinkRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>