DigiOffice Gateway Web Services

<back to all web services

GetAttachmentsFromTempLink

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

public class GetAttachmentsFromTempLink : Codable
{
    public var generatedZipKey:String?

    required public init(){}
}

public protocol IHttpResult
{
    var status:Int? { get set }
    var statusCode:HttpStatusCode? { get set }
    var statusDescription:String? { get set }
    var contentType:String? { get set }
    var headers:[String:String]? { get set }
    var cookies:[Cookie]? { get set }
    //response:Object ignored. Type could not be extended in Swift
    //responseFilter:IContentTypeWriter ignored. Swift doesn't support interface properties
    //requestContext:IRequest ignored. Swift doesn't support interface properties
    var paddingLength:Int? { get set }
    var resultScope:Func<IDisposable>? { get set }

}

public protocol IContentTypeWriter
{
}

public protocol IRequest
{
    //originalRequest:Object ignored. Type could not be extended in Swift
    //response:IResponse ignored. Swift doesn't support interface properties
    var operationName:String? { get set }
    var verb:String? { get set }
    var requestAttributes:RequestAttributes? { get set }
    //requestPreferences:IRequestPreferences ignored. Swift doesn't support interface properties
    //dto:Object ignored. Type could not be extended in Swift
    var contentType:String? { get set }
    var isLocal:Bool? { get set }
    var userAgent:String? { get set }
    var cookies:[String:Cookie]? { get set }
    var responseContentType:String? { get set }
    var hasExplicitResponseContentType:Bool? { get set }
    var items:[String:Object]? { get set }
    var headers:NameValueCollection? { get set }
    var queryString:NameValueCollection? { get set }
    var formData:NameValueCollection? { get set }
    var useBufferedStream:Bool? { get set }
    var rawUrl:String? { get set }
    var absoluteUri:String? { get set }
    var userHostAddress:String? { get set }
    var remoteIp:String? { get set }
    var authorization:String? { get set }
    var isSecureConnection:Bool? { get set }
    var acceptTypes:[String] { get set }
    var pathInfo:String? { get set }
    var originalPathInfo:String? { get set }
    var inputStream:Data? { get set }
    var contentLength:Int? { get set }
    var files:[IHttpFile] { get set }
    var urlReferrer:Uri? { get set }

}

public protocol IResponse
{
    //originalResponse:Object ignored. Type could not be extended in Swift
    //request:IRequest ignored. Swift doesn't support interface properties
    var statusCode:Int? { get set }
    var statusDescription:String? { get set }
    var contentType:String? { get set }
    var outputStream:Data? { get set }
    //dto:Object ignored. Type could not be extended in Swift
    var useBufferedStream:Bool? { get set }
    var isClosed:Bool? { get set }
    var keepAlive:Bool? { get set }
    var hasStarted:Bool? { get set }
    var items:[String:Object]? { get set }

}

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

public protocol IRequestPreferences
{
    var acceptsBrotli:Bool? { get set }
    var acceptsDeflate:Bool? { get set }
    var acceptsGzip:Bool? { get set }

}

public protocol IHttpFile
{
    var name:String? { get set }
    var fileName:String? { get set }
    var contentLength:Int? { get set }
    var contentType:String? { get set }
    var inputStream:Data? { get set }

}


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