DigiOffice Gateway Web Services

<back to all web services

GetAttachmentsFromTempLink

The following routes are available for this service:
GET/api/attachmentsfromtemplink/{GeneratedZipKey}

export interface IContentTypeWriter
{
}

export interface IResponse
{
    OriginalResponse?: Object;
    Request?: IRequest;
    StatusCode?: number;
    StatusDescription?: string;
    ContentType?: string;
    OutputStream?: string;
    Dto?: Object;
    UseBufferedStream?: boolean;
    IsClosed?: boolean;
    KeepAlive?: boolean;
    HasStarted?: boolean;
    Items?: { [index: string]: Object; };
}

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

export interface IRequestPreferences
{
    AcceptsBrotli?: boolean;
    AcceptsDeflate?: boolean;
    AcceptsGzip?: boolean;
}

export interface IRequest
{
    OriginalRequest?: Object;
    Response?: IResponse;
    OperationName?: string;
    Verb?: string;
    RequestAttributes?: RequestAttributes;
    RequestPreferences?: IRequestPreferences;
    Dto?: Object;
    ContentType?: string;
    IsLocal?: boolean;
    UserAgent?: string;
    Cookies?: { [index: string]: Cookie; };
    ResponseContentType?: string;
    HasExplicitResponseContentType?: boolean;
    Items?: { [index: string]: Object; };
    Headers?: NameValueCollection;
    QueryString?: NameValueCollection;
    FormData?: NameValueCollection;
    UseBufferedStream?: boolean;
    RawUrl?: string;
    AbsoluteUri?: string;
    UserHostAddress?: string;
    RemoteIp?: string;
    Authorization?: string;
    IsSecureConnection?: boolean;
    AcceptTypes?: string[];
    PathInfo?: string;
    OriginalPathInfo?: string;
    InputStream?: string;
    ContentLength?: number;
    Files?: IHttpFile[];
    UrlReferrer?: string;
}

export interface IHttpResult
{
    Status?: number;
    StatusCode?: HttpStatusCode;
    StatusDescription?: string;
    ContentType?: string;
    Headers?: { [index: string]: string; };
    Cookies?: Cookie[];
    Response?: Object;
    ResponseFilter?: IContentTypeWriter;
    RequestContext?: IRequest;
    PaddingLength?: number;
    ResultScope?: Func<IDisposable>;
}

export class GetAttachmentsFromTempLink
{
    public GeneratedZipKey?: string;

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

export interface IHttpFile
{
    Name?: string;
    FileName?: string;
    ContentLength?: number;
    ContentType?: string;
    InputStream?: string;
}

TypeScript 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.