DigiOffice Gateway Web Services

<back to all web services

GetAttachmentsFromTempLink

The following routes are available for this service:
GET/api/attachmentsfromtemplink/{GeneratedZipKey}
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

abstract class IContentTypeWriter
{
}

abstract class IResponse
{
    dynamic? OriginalResponse;
    IRequest? Request;
    int? StatusCode;
    String? StatusDescription;
    String? ContentType;
    Uint8List? OutputStream;
    dynamic? Dto;
    bool? UseBufferedStream;
    bool? IsClosed;
    bool? KeepAlive;
    bool? HasStarted;
    Map<String,dynamic?>? Items;
}

// @Flags()
class RequestAttributes
{
    static const RequestAttributes None = const RequestAttributes._(0);
    static const RequestAttributes Localhost = const RequestAttributes._(1);
    static const RequestAttributes LocalSubnet = const RequestAttributes._(2);
    static const RequestAttributes External = const RequestAttributes._(4);
    static const RequestAttributes Secure = const RequestAttributes._(8);
    static const RequestAttributes InSecure = const RequestAttributes._(16);
    static const RequestAttributes AnySecurityMode = const RequestAttributes._(24);
    static const RequestAttributes HttpHead = const RequestAttributes._(32);
    static const RequestAttributes HttpGet = const RequestAttributes._(64);
    static const RequestAttributes HttpPost = const RequestAttributes._(128);
    static const RequestAttributes HttpPut = const RequestAttributes._(256);
    static const RequestAttributes HttpDelete = const RequestAttributes._(512);
    static const RequestAttributes HttpPatch = const RequestAttributes._(1024);
    static const RequestAttributes HttpOptions = const RequestAttributes._(2048);
    static const RequestAttributes HttpOther = const RequestAttributes._(4096);
    static const RequestAttributes AnyHttpMethod = const RequestAttributes._(8160);
    static const RequestAttributes OneWay = const RequestAttributes._(8192);
    static const RequestAttributes Reply = const RequestAttributes._(16384);
    static const RequestAttributes AnyCallStyle = const RequestAttributes._(24576);
    static const RequestAttributes Soap11 = const RequestAttributes._(32768);
    static const RequestAttributes Soap12 = const RequestAttributes._(65536);
    static const RequestAttributes Xml = const RequestAttributes._(131072);
    static const RequestAttributes Json = const RequestAttributes._(262144);
    static const RequestAttributes Jsv = const RequestAttributes._(524288);
    static const RequestAttributes ProtoBuf = const RequestAttributes._(1048576);
    static const RequestAttributes Csv = const RequestAttributes._(2097152);
    static const RequestAttributes Html = const RequestAttributes._(4194304);
    static const RequestAttributes Wire = const RequestAttributes._(8388608);
    static const RequestAttributes MsgPack = const RequestAttributes._(16777216);
    static const RequestAttributes FormatOther = const RequestAttributes._(33554432);
    static const RequestAttributes AnyFormat = const RequestAttributes._(67076096);
    static const RequestAttributes Http = const RequestAttributes._(67108864);
    static const RequestAttributes MessageQueue = const RequestAttributes._(134217728);
    static const RequestAttributes Tcp = const RequestAttributes._(268435456);
    static const RequestAttributes Grpc = const RequestAttributes._(536870912);
    static const RequestAttributes EndpointOther = const RequestAttributes._(1073741824);
    static const RequestAttributes AnyEndpoint = const RequestAttributes._(2080374784);
    static const RequestAttributes InProcess = const RequestAttributes._(-2147483648);
    static const RequestAttributes InternalNetworkAccess = const RequestAttributes._(-2147483645);
    static const RequestAttributes AnyNetworkAccessType = const RequestAttributes._(-2147483641);
    static const RequestAttributes Any = const RequestAttributes._(-1);

    final int _value;
    const RequestAttributes._(this._value);
    int get value => _value;
    static List<RequestAttributes> get values => const [None,Localhost,LocalSubnet,External,Secure,InSecure,AnySecurityMode,HttpHead,HttpGet,HttpPost,HttpPut,HttpDelete,HttpPatch,HttpOptions,HttpOther,AnyHttpMethod,OneWay,Reply,AnyCallStyle,Soap11,Soap12,Xml,Json,Jsv,ProtoBuf,Csv,Html,Wire,MsgPack,FormatOther,AnyFormat,Http,MessageQueue,Tcp,Grpc,EndpointOther,AnyEndpoint,InProcess,InternalNetworkAccess,AnyNetworkAccessType,Any];
}

abstract class IRequestPreferences
{
    bool? AcceptsBrotli;
    bool? AcceptsDeflate;
    bool? AcceptsGzip;
}

abstract class IRequest
{
    dynamic? OriginalRequest;
    IResponse? Response;
    String? OperationName;
    String? Verb;
    RequestAttributes? RequestAttributes;
    IRequestPreferences? RequestPreferences;
    dynamic? Dto;
    String? ContentType;
    bool? IsLocal;
    String? UserAgent;
    Map<String,Cookie?>? Cookies;
    String? ResponseContentType;
    bool? HasExplicitResponseContentType;
    Map<String,dynamic?>? Items;
    NameValueCollection? Headers;
    NameValueCollection? QueryString;
    NameValueCollection? FormData;
    bool? UseBufferedStream;
    String? RawUrl;
    String? AbsoluteUri;
    String? UserHostAddress;
    String? RemoteIp;
    String? Authorization;
    bool? IsSecureConnection;
    List<String>? AcceptTypes;
    String? PathInfo;
    String? OriginalPathInfo;
    Uint8List? InputStream;
    int? ContentLength;
    List<IHttpFile>? Files;
    Uri? UrlReferrer;
}

abstract class IHttpResult
{
    int? Status;
    HttpStatusCode? StatusCode;
    String? StatusDescription;
    String? ContentType;
    Map<String,String?>? Headers;
    List<Cookie>? Cookies;
    dynamic? Response;
    IContentTypeWriter? ResponseFilter;
    IRequest? RequestContext;
    int? PaddingLength;
    Func<IDisposable>? ResultScope;
}

class GetAttachmentsFromTempLink implements IConvertible
{
    String? GeneratedZipKey;

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

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

    Map<String, dynamic> toJson() => {
        'GeneratedZipKey': GeneratedZipKey
    };

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

abstract class IHttpFile
{
    String? Name;
    String? FileName;
    int? ContentLength;
    String? ContentType;
    Uint8List? InputStream;
}

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'IContentTypeWriter': TypeInfo(TypeOf.Interface),
    'IResponse': TypeInfo(TypeOf.Interface),
    'RequestAttributes': TypeInfo(TypeOf.Enum, enumValues:RequestAttributes.values),
    'IRequestPreferences': TypeInfo(TypeOf.Interface),
    'IRequest': TypeInfo(TypeOf.Interface),
    'IHttpResult': TypeInfo(TypeOf.Interface),
    'GetAttachmentsFromTempLink': TypeInfo(TypeOf.Class, create:() => GetAttachmentsFromTempLink()),
    'IHttpFile': TypeInfo(TypeOf.Interface),
});

Dart GetAttachmentsFromTempLink DTOs

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

HTTP + CSV

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

GET /api/attachmentsfromtemplink/{GeneratedZipKey} HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'IHttpResult' using the custom 'csv' filter}Cannot create an instance of an interface.