TeleportService

<back to all web services

Documents_GetList_v2

Requires Authentication
The following routes are available for this service:
POST, GET/v2/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
DocumentsFilter Parameters:
NameParameterData TypeRequiredDescription
nameformstringNo
operationformstringNo
valueformstringNo
rangeformDocumentsFilterRangeNo
inValuesformList<string>No
DocumentsFilterRange Parameters:
NameParameterData TypeRequiredDescription
minformstringNo
maxformstringNo
DocumentGetStrategy Enum:
all
sent
receive
DocumentsGetListResponse_v2 Parameters:
NameParameterData TypeRequiredDescription
errCodeformintNo
totalCountformlongNo
documentsformList<DocumentsList>No
DocumentsList Parameters:
NameParameterData TypeRequiredDescription
message_idformstringNo
senderformstringNo
receiverformstringNo
typeformstringNo
statusformDocumentStatusNo
dateformDateTimeNo
numformstringNo
sumformdecimalNo
currencyIdformstringNo
hashformstringNo
addPropsformstringNo
file_attachedformboolNo
is_newformboolNo
companyformstringNo
branchformstringNo
messageformstringNo
update_dateformDateTimeNo
commentformstringNo
file_idformstringNo
marketplaceformstringNo
delivery_dateformDateTimeNo
marketplace_statusformstringNo
huckster_statusformstringNo
cancel_dateformDateTimeNo
canceled_after_deliveryformboolNo
marketplace_idformstringNo
marketplace_posting_numberformstringNo
marketplace_substatusformstringNo
payment_typeformstringNo
payment_methodformstringNo
trademarkformstringNo
marketplace_accountformstringNo
marketplace_shop_idformstringNo
marketplace_expressformboolNo
marketplace_warehouse_idformstringNo
marketplace_delivery_methodformstringNo
marketplace_pre_posting_numberformstringNo
DocumentStatus Enum:
new
transmitted
processed
canceled
agreement
confirmed
shipped
closed
draft

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /v2/Documents_GetList HTTP/1.1 
Host: wbs.e-teleport.ru 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","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"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"errCode":0,"totalCount":0,"documents":[{"message_id":"String","sender":"String","receiver":"String","type":"String","status":"new","date":"0001-01-01T00:00:00.0000000","num":"String","sum":0,"currencyId":"String","hash":"String","addProps":"String","file_attached":false,"is_new":false,"company":"String","branch":"String","message":"String","update_date":"0001-01-01T00:00:00.0000000","comment":"String","file_id":"String","marketplace":"String","delivery_date":"0001-01-01T00:00:00.0000000","marketplace_status":"String","huckster_status":"String","cancel_date":"0001-01-01T00:00:00.0000000","canceled_after_delivery":false,"marketplace_id":"String","marketplace_posting_number":"String","marketplace_substatus":"String","payment_type":"String","payment_method":"String","trademark":"String","marketplace_account":"String","marketplace_shop_id":"String","marketplace_express":false,"marketplace_warehouse_id":"String","marketplace_delivery_method":"String","marketplace_pre_posting_number":"String"}]}