MyApp

<back to all web services

QueryFileSystemItems

Files
# frozen_string_literal: true
# encoding: utf-8


require 'json'
require 'servicestack'


module FileAccessType
    PUBLIC = 'Public'
    TEAM = 'Team'
    PRIVATE = 'Private'
end

class FileSystemFile
    include ServiceStack::DTO

    # @return [Integer]
    attr_accessor :id
    # @return [String]
    attr_accessor :file_name
    # @return [String]
    attr_accessor :file_path
    # @return [String]
    attr_accessor :content_type
    # @return [Integer]
    attr_accessor :content_length
    # @References('FileSystemItem')
    # @return [Integer]
    attr_accessor :file_system_item_id

    def self.properties
        {
            id: { name: 'id' },
            file_name: { name: 'fileName' },
            file_path: { name: 'filePath' },
            content_type: { name: 'contentType' },
            content_length: { name: 'contentLength' },
            file_system_item_id: { name: 'fileSystemItemId' },
        }
    end

end

class FileSystemItem
    include ServiceStack::DTO

    # @return [Integer]
    attr_accessor :id
    # @return [FileAccessType]
    attr_accessor :file_access_type
    # @return [FileSystemFile]
    attr_accessor :file
    # @return [String]
    attr_accessor :app_user_id

    def self.properties
        {
            id: { name: 'id' },
            file_access_type: { name: 'fileAccessType' },
            file: { name: 'file', type: FileSystemFile },
            app_user_id: { name: 'appUserId' },
        }
    end

end

class QueryFileSystemItems < ServiceStack::QueryDb
    # @return [Integer]
    attr_accessor :app_user_id
    # @return [FileAccessType]
    attr_accessor :file_access_type

    def self.properties
        {
            app_user_id: { name: 'appUserId' },
            file_access_type: { name: 'fileAccessType' },
        }
    end

end

class Todo
    include ServiceStack::DTO

    # @return [Integer]
    attr_accessor :id
    # @return [String]
    attr_accessor :text
    # @return [TrueClass]
    attr_accessor :is_finished

    def self.properties
        {
            id: { name: 'id' },
            text: { name: 'text' },
            is_finished: { name: 'isFinished' },
        }
    end

end

Ruby QueryFileSystemItems DTOs

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

HTTP + JSV

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

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

{
	appUserId: 0,
	fileAccessType: Public,
	skip: 0,
	take: 0,
	orderBy: String,
	orderByDesc: String,
	include: String,
	fields: String,
	meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: 0,
			fileAccessType: Public,
			file: 
			{
				id: 0,
				fileName: String,
				filePath: String,
				contentType: String,
				contentLength: 0,
				fileSystemItemId: 0
			},
			appUserId: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}