REST Files

<back to all web services

Files

GET the File or Directory info at {Path}
POST multipart/formdata to upload a new file to any {Path} in the /ReadWrite folder
PUT {TextContents} to replace the contents of a text file in the /ReadWrite folder

Files Parameters:
NameParameterData TypeRequiredDescription
PathpathstringNo
TextContentsquerystringNo
ForDownloadqueryboolNo
FilesResponse Parameters:
NameParameterData TypeRequiredDescription
DirectoryformFolderResultNo
FileformFileResultNo
ResponseStatusformResponseStatusNo
FolderResult Parameters:
NameParameterData TypeRequiredDescription
FoldersformList<Folder>No
FilesformList<File>No
Folder Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ModifiedDateformDateTimeNo
FileCountformintNo
File Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ExtensionformstringNo
FileSizeBytesformlongNo
ModifiedDateformDateTimeNo
IsTextFileformboolNo
FileResult Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ExtensionformstringNo
FileSizeBytesformlongNo
ModifiedDateformDateTimeNo
IsTextFileformboolNo
ContentsformstringNo

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

HTTP + SOAP12

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

POST /soap12 HTTP/1.1 
Host: restfiles.servicestack.net 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<Files xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RestFiles.ServiceModel">
  <ForDownload>false</ForDownload>
  <Path>String</Path>
  <TextContents>String</TextContents>
</Files>

    </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<FilesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RestFiles.ServiceModel">
  <Directory xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:Files>
      <d2p1:File>
        <d2p1:Extension>String</d2p1:Extension>
        <d2p1:FileSizeBytes>0</d2p1:FileSizeBytes>
        <d2p1:IsTextFile>false</d2p1:IsTextFile>
        <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
        <d2p1:Name>String</d2p1:Name>
      </d2p1:File>
    </d2p1:Files>
    <d2p1:Folders>
      <d2p1:Folder>
        <d2p1:FileCount>0</d2p1:FileCount>
        <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
        <d2p1:Name>String</d2p1:Name>
      </d2p1:Folder>
    </d2p1:Folders>
  </Directory>
  <File xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:Contents>String</d2p1:Contents>
    <d2p1:Extension>String</d2p1:Extension>
    <d2p1:FileSizeBytes>0</d2p1:FileSizeBytes>
    <d2p1:IsTextFile>false</d2p1:IsTextFile>
    <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
    <d2p1:Name>String</d2p1:Name>
  </File>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</FilesResponse>

    </soap12:Body>
</soap12:Envelope>