ShortlinksAPI

PutUserLinkRequest

The following routes are available for this service:
PUT	/v4/links
PUT	/v4/links/{Id}

import 'package:servicestack/servicestack.dart';

// @DataContract
class V4BaseRequest implements IConvertible
{
    V4BaseRequest();
    V4BaseRequest.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "V4BaseRequest";
    TypeContext? context = _ctx;
}

// @DataContract
class V4BaseResponse implements IConvertible
{
    // @DataMember(Name="status")
    ResponseStatus? status;

    V4BaseResponse({this.status});
    V4BaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        status = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'status': JsonConverters.toJson(status,'ResponseStatus',context!)
    };

    getTypeName() => "V4BaseResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class PutUserLinkResponse extends V4BaseResponse implements IConvertible
{
    PutUserLinkResponse();
    PutUserLinkResponse.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "PutUserLinkResponse";
    TypeContext? context = _ctx;
}

enum LinkType
{
    None,
    Simple,
    Split,
    Interstitial,
    Advanced,
    Collection,
}

// @DataContract
class PutUserLinkRequest extends V4BaseRequest implements IPutUserLinkRequest, IConvertible
{
    // @DataMember(Name="id")
    String? id;

    // @DataMember(Name="linkType")
    LinkType? linkType;

    // @DataMember(Name="typeDefinitionPublicId")
    String? typeDefinitionPublicId;

    PutUserLinkRequest({this.id,this.linkType,this.typeDefinitionPublicId});
    PutUserLinkRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        id = json['id'];
        linkType = JsonConverters.fromJson(json['linkType'],'LinkType',context!);
        typeDefinitionPublicId = json['typeDefinitionPublicId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'id': id,
        'linkType': JsonConverters.toJson(linkType,'LinkType',context!),
        'typeDefinitionPublicId': typeDefinitionPublicId
    });

    getTypeName() => "PutUserLinkRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'shortlinks_api.qa.platform.georiot.com', types: <String, TypeInfo> {
    'V4BaseRequest': TypeInfo(TypeOf.Class, create:() => V4BaseRequest()),
    'V4BaseResponse': TypeInfo(TypeOf.Class, create:() => V4BaseResponse()),
    'PutUserLinkResponse': TypeInfo(TypeOf.Class, create:() => PutUserLinkResponse()),
    'LinkType': TypeInfo(TypeOf.Enum, enumValues:LinkType.values),
    'PutUserLinkRequest': TypeInfo(TypeOf.Class, create:() => PutUserLinkRequest()),
});

Dart 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>