TeleportService

<back to all web services

Documents_GetList

Requires Authentication
The following routes are available for this service:
POST/Documents_GetList
DocumentsGetListBase Parameters:
NameParameterData TypeRequiredDescription
start_dateformDateTimeNo
end_dateformDateTimeNo
filtersformList<DocumentsFilter>No
status_change_offformboolNo
get_documentformboolNo
use_updateDateformboolNo
document_typeformstringNo
offsetformintNo
limitformintNo
at_pagesformboolNo
get_countformboolNo
getStrategyformDocumentGetStrategyNo
maxCountformintNo
DocumentsFilter Parameters:
NameParameterData TypeRequiredDescription
nameformstringNo
operationformstringNo
valueformstringNo
rangeformDocumentsFilterRangeNo
inValuesformList<string>No
DocumentsFilterRange Parameters:
NameParameterData TypeRequiredDescription
minformstringNo
maxformstringNo
DocumentGetStrategy Enum:
all
sent
receive

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 /Documents_GetList HTTP/1.1 
Host: wbs.e-teleport.ru 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	start_date: 0001-01-01,
	end_date: 0001-01-01,
	filters: 
	[
		{
			name: String,
			operation: String,
			value: String,
			range: 
			{
				min: String,
				max: String
			},
			inValues: 
			[
				String
			]
		}
	],
	status_change_off: False,
	get_document: False,
	use_updateDate: False,
	document_type: String,
	offset: 0,
	limit: 0,
	at_pages: False,
	get_count: False,
	getStrategy: all,
	maxCount: 0
}