digitaluapi

<back to all web services

Files

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
All Verbs/restfiles/files
All Verbs/restfiles/files/{Path*}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class Files
{
    open var Path:String? = null
    open var TextContents:String? = null
    open var ForDownload:Boolean? = null
}

open class FilesResponse
{
    open var Directory:FolderResult? = null
    open var File:FileResult? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class FolderResult
{
    open var Folders:ArrayList<Folder>? = null
    open var Files:ArrayList<File>? = null
}

open class Folder
{
    open var Name:String? = null
    open var ModifiedDate:Date? = null
    open var FileCount:Int? = null
}

open class File
{
    open var Name:String? = null
    open var Extension:String? = null
    open var FileSizeBytes:Long? = null
    open var ModifiedDate:Date? = null
    open var IsTextFile:Boolean? = null
}

open class FileResult
{
    open var Name:String? = null
    open var Extension:String? = null
    open var FileSizeBytes:Long? = null
    open var ModifiedDate:Date? = null
    open var IsTextFile:Boolean? = null
    open var Contents:String? = null
}

Kotlin Files DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /restfiles/files HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Path":"String","TextContents":"String","ForDownload":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Directory":{"Folders":[{"Name":"String","ModifiedDate":"0001-01-01T00:00:00.0000000","FileCount":0}],"Files":[{"Name":"String","Extension":"String","FileSizeBytes":0,"ModifiedDate":"0001-01-01T00:00:00.0000000","IsTextFile":false}]},"File":{"Name":"String","Extension":"String","FileSizeBytes":0,"ModifiedDate":"0001-01-01T00:00:00.0000000","IsTextFile":false,"Contents":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}