Plugins Sharp App

<back to all web services

SearchDrives

The following routes are available for this service:
All Verbs/drives
SearchDrives Parameters:
NameParameterData TypeRequiredDescription
LargerThanBytesqueryint?No
SmallerThanBytesqueryint?No
DriveFormatInqueryList<string>No
SearchDrivesResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<Drive>No
ResponseStatusformResponseStatusNo
Drive Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DriveTypeformstringNo
VolumeLabelformstringNo
DriveFormatformstringNo
AvailableFreeSpaceBytesformlongNo
TotalFreeSpaceBytesformlongNo
TotalSizeBytesformlongNo

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 /drives HTTP/1.1 
Host: plugins.web-app.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	largerThanBytes: 0,
	smallerThanBytes: 0,
	driveFormatIn: 
	[
		String
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	results: 
	[
		{
			name: String,
			driveType: String,
			volumeLabel: String,
			driveFormat: String,
			availableFreeSpaceBytes: 0,
			totalFreeSpaceBytes: 0,
			totalSizeBytes: 0
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}