ShortlinksAPI

<back to all web services

GetUserLinksRequest

Requires Authentication
The following routes are available for this service:
GET/v4/links/list
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 V4PaginatedBaseRequest extends V4BaseRequest implements IConvertible
{
    // @DataMember(Name="offset")
    int? offset;

    // @DataMember(Name="limit")
    int? limit;

    V4PaginatedBaseRequest({this.offset,this.limit});
    V4PaginatedBaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        offset = json['offset'];
        limit = json['limit'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'offset': offset,
        'limit': limit
    });

    getTypeName() => "V4PaginatedBaseRequest";
    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 V4PageObject implements IConvertible
{
    // @DataMember(Name="offset")
    int? offset;

    // @DataMember(Name="limit")
    int? limit;

    // @DataMember(Name="totalRecords")
    int? totalRecords;

    V4PageObject({this.offset,this.limit,this.totalRecords});
    V4PageObject.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        offset = json['offset'];
        limit = json['limit'];
        totalRecords = json['totalRecords'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'offset': offset,
        'limit': limit,
        'totalRecords': totalRecords
    };

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

// @DataContract
class V4PaginatedBaseResponse extends V4BaseResponse implements IConvertible
{
    // @DataMember(Name="page")
    V4PageObject? page;

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

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'page': JsonConverters.toJson(page,'V4PageObject',context!)
    });

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

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

class RefreshableMetadata implements IRefreshableMetadata, IConvertible
{
    DateTime? createdDate;
    DateTime? updatedDate;

    RefreshableMetadata({this.createdDate,this.updatedDate});
    RefreshableMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'createdDate': JsonConverters.toJson(createdDate,'DateTime',context!),
        'updatedDate': JsonConverters.toJson(updatedDate,'DateTime',context!)
    };

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

class VersionedRefreshableMetadata extends RefreshableMetadata implements IConvertible
{
    DateTime? versionCreatedDate;

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

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'versionCreatedDate': JsonConverters.toJson(versionCreatedDate,'DateTime',context!)
    });

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

abstract class IUserLink
{
    String? url;
    String? baseCode;
    LinkType? linkType;
    String? typeDefinitionPublicId;
    VersionedRefreshableMetadata? metadata;
}

// @DataContract
class GetUserLinksResponse extends V4PaginatedBaseResponse implements IGetUserLinksResponse, IConvertible
{
    // @DataMember(Name="data")
    List<IUserLink>? data;

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

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        data = JsonConverters.fromJson(json['data'],'List<IUserLink>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'data': JsonConverters.toJson(data,'List<IUserLink>',context!)
    });

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

// @DataContract
class GetUserLinksRequest extends V4PaginatedBaseRequest implements IConvertible
{
    // @DataMember(Name="username")
    String? username;

    // @DataMember(Name="groupId")
    int? groupId;

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

    GetUserLinksRequest({this.username,this.groupId,this.linkType});
    GetUserLinksRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'shortlinks_api.qa.platform.georiot.com', types: <String, TypeInfo> {
    'V4BaseRequest': TypeInfo(TypeOf.Class, create:() => V4BaseRequest()),
    'V4PaginatedBaseRequest': TypeInfo(TypeOf.Class, create:() => V4PaginatedBaseRequest()),
    'V4BaseResponse': TypeInfo(TypeOf.Class, create:() => V4BaseResponse()),
    'V4PageObject': TypeInfo(TypeOf.Class, create:() => V4PageObject()),
    'V4PaginatedBaseResponse': TypeInfo(TypeOf.Class, create:() => V4PaginatedBaseResponse()),
    'LinkType': TypeInfo(TypeOf.Enum, enumValues:LinkType.values),
    'RefreshableMetadata': TypeInfo(TypeOf.Class, create:() => RefreshableMetadata()),
    'VersionedRefreshableMetadata': TypeInfo(TypeOf.Class, create:() => VersionedRefreshableMetadata()),
    'IUserLink': TypeInfo(TypeOf.Interface),
    'GetUserLinksResponse': TypeInfo(TypeOf.Class, create:() => GetUserLinksResponse()),
    'List<IUserLink>': TypeInfo(TypeOf.Class, create:() => <IUserLink>[]),
    'GetUserLinksRequest': TypeInfo(TypeOf.Class, create:() => GetUserLinksRequest()),
});

Dart GetUserLinksRequest DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v4/links/list HTTP/1.1 
Host: shortlinks-api.qa.platform.georiot.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	page: 
	{
		offset: 0,
		limit: 0,
		totalRecords: 0
	},
	status: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}