MyApp

<back to all web services

QueryFileSystemItems

Files
QueryFileSystemItems Parameters:
NameParameterData TypeRequiredDescription
AppUserIdqueryint?No
FileAccessTypequeryFileAccessType?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
FileSystemItem Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
FileAccessTypeformFileAccessType?No
FileformFileSystemFileYes
AppUserIdformstringYes
FileAccessType Enum:
Public
Team
Private
FileSystemFile Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
FileNameformstringYes
FilePathformstringYes
ContentTypeformstringYes
ContentLengthformlongNo
FileSystemItemIdformintNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<Todo>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
Todo Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
TextformstringYes
IsFinishedformboolNo

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

HTTP + XML

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

POST /xml/reply/QueryFileSystemItems HTTP/1.1 
Host: blazor-gallery.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QueryFileSystemItems xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <AppUserId>0</AppUserId>
  <FileAccessType>Public</FileAccessType>
</QueryFileSystemItems>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfFileSystemItemtlJ4_P31p xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
    <d2p1:FileSystemItem>
      <d2p1:AppUserId>String</d2p1:AppUserId>
      <d2p1:File>
        <d2p1:ContentLength>0</d2p1:ContentLength>
        <d2p1:ContentType>String</d2p1:ContentType>
        <d2p1:FileName>String</d2p1:FileName>
        <d2p1:FilePath>String</d2p1:FilePath>
        <d2p1:FileSystemItemId>0</d2p1:FileSystemItemId>
        <d2p1:Id>0</d2p1:Id>
      </d2p1:File>
      <d2p1:FileAccessType>Public</d2p1:FileAccessType>
      <d2p1:Id>0</d2p1:Id>
    </d2p1:FileSystemItem>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <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>
        </Meta>
      </ResponseError>
    </Errors>
    <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>
    </Meta>
  </ResponseStatus>
</QueryResponseOfFileSystemItemtlJ4_P31p>