TeleportService

Documents_GetById_v2

The following routes are available for this service:
POST, GET	/v2/Documents_GetById

**Documents_GetById_v2** Parameters:
Name	Parameter	Data Type	Required	Description
message_id	body	string	No

**DocumentsGetByIdResponse_v2** Parameters:
Name	Parameter	Data Type	Required	Description
errCode	form	int	No
document	form	DocumentModel	No

**DocumentModel** Parameters:
Name	Parameter	Data Type	Required
message_id	form	string	No
owner	form	string	No
recipient	form	string	No
sender	form	string	No
receiver	form	string	No
message	form	TeleportDocument	No
type	form	string	No
status	form	DocumentStatus	No
date	form	DateTime	No
num	form	string	No
sum	form	decimal	No
currencyId	form	string	No
hash	form	string	No
addProps	form	string	No
add_date	form	DateTime	No
file_attached	form	bool	No
receiver_team	form	string	No
sender_team	form	string	No
file_id	form	string	No
company	form	string	No
branch	form	string	No
update_date	form	DateTime	No
comment	form	string	No

**TeleportDocument** Parameters:
Name	Parameter	Data Type	Required
docHeader	form	TeleportDocumentHeader	No
tabHeader	form	TeleportDocumentTabHeader	No
docTable	form	List<TeleportDocumentTable>	No

**TeleportDocumentHeader** Parameters:
Name	Parameter	Data Type	Required
id	form	string	No
owner	form	string	No
type	form	string	No
status	form	DocumentStatus	No
date	form	DateTime	No
num	form	string	No
hash	form	string	No
sum	form	decimal	No
currencyId	form	string	No
comment	form	string	No
fileAttached	form	bool	No
file_id	form	string	No
props	form	List<TeleportDocumentProps>	No
marketplace	form	string	No
delivery_date	form	DateTime	No
marketplace_status	form	string	No
huckster_status	form	string	No
cancel_date	form	DateTime	No
canceled_after_delivery	form	bool	No
marketplace_id	form	string	No
marketplace_posting_number	form	string	No
marketplace_substatus	form	string	No
payment_type	form	string	No
payment_method	form	string	No
marketplace_account	form	string	No
marketplace_shop_id	form	string	No
marketplace_express	form	bool	No
marketplace_delivery_method	form	string	No
marketplace_warehouse_id	form	string	No
marketplace_warehouse_name	form	string	No
marketplace_pre_posting_number	form	string	No
MarketplaceAccount	form	MarketplaceAccountHeader	No
MarketplaceWarehouse	form	MarketplaceWarehouseHeader	No
client_order_number	form	string	No

**DocumentStatus** Enum:
new
transmitted
processed
canceled
agreement
confirmed
shipped
closed
draft

**TeleportDocumentProps** Parameters:
Name	Parameter	Data Type	Required
name	form	string	No
header	form	string	No
type	form	string	No
enumvalues	form	List<string>	No
required	form	bool	No
value	form	string	No

**MarketplaceAccountHeader** Parameters:
Name	Parameter	Data Type	Required
marketplace	form	string	No
shop_id	form	string	No
account	form	string	No

**MarketplaceWarehouseHeader** Parameters:
Name	Parameter	Data Type	Required
shop_id	form	string	No
warehouse_id	form	string	No
warehouse_name	form	string	No

**TeleportDocumentTabHeader** Parameters:
Name	Parameter	Data Type	Required
article	form	string	No
name	form	string	No
unit	form	string	No
quantity	form	string	No
confirmed	form	string	No
price	form	string	No
sum	form	string	No
trademark	form	string	No
props	form	List<TeleportDocumentProps>	No

**TeleportDocumentTable** Parameters:
Name	Parameter	Data Type	Required
owner	form	string	No
id	form	string	No
uid	form	string	No
code	form	string	No
article	form	string	No
name	form	string	No
unit	form	string	No
quantity	form	decimal	No
confirmed	form	decimal	No
price	form	decimal	No
sum	form	decimal	No
trademark	form	string	No
props	form	List<TeleportDocumentPropsValue>	No

**TeleportDocumentPropsValue** Parameters:
Name	Parameter	Data Type	Required	Description
name	form	string	No
value	form	string	No

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

{
	message_id: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errCode: 0,
	document: 
	{
		message_id: String,
		owner: String,
		recipient: String,
		sender: String,
		receiver: String,
		message: 
		{
			docHeader: 
			{
				id: String,
				owner: String,
				type: String,
				status: new,
				date: 0001-01-01,
				num: String,
				hash: String,
				sum: 0,
				currencyId: String,
				comment: String,
				fileAttached: False,
				file_id: String,
				props: 
				[
					{
						name: String,
						header: String,
						type: String,
						enumvalues: 
						[
							String
						],
						required: False,
						value: String
					}
				],
				marketplace: String,
				delivery_date: 0001-01-01,
				marketplace_status: String,
				huckster_status: String,
				cancel_date: 0001-01-01,
				canceled_after_delivery: False,
				marketplace_id: String,
				marketplace_posting_number: String,
				marketplace_substatus: String,
				payment_type: String,
				payment_method: String,
				marketplace_account: String,
				marketplace_shop_id: String,
				marketplace_express: False,
				marketplace_delivery_method: String,
				marketplace_warehouse_id: String,
				marketplace_warehouse_name: String,
				marketplace_pre_posting_number: String,
				MarketplaceAccount: 
				{
					marketplace: String,
					shop_id: String,
					account: String
				},
				MarketplaceWarehouse: 
				{
					shop_id: String,
					warehouse_id: String,
					warehouse_name: String
				},
				client_order_number: String
			},
			tabHeader: 
			{
				article: String,
				name: String,
				unit: String,
				quantity: String,
				confirmed: String,
				price: String,
				sum: String,
				trademark: String,
				props: 
				[
					{
						name: String,
						header: String,
						type: String,
						enumvalues: 
						[
							String
						],
						required: False,
						value: String
					}
				]
			},
			docTable: 
			[
				{
					owner: String,
					id: String,
					uid: String,
					code: String,
					article: String,
					name: String,
					unit: String,
					quantity: 0,
					confirmed: 0,
					price: 0,
					sum: 0,
					trademark: String,
					props: 
					[
						{
							name: String,
							value: String
						}
					]
				}
			]
		},
		type: String,
		status: new,
		date: 0001-01-01,
		num: String,
		sum: 0,
		currencyId: String,
		hash: String,
		addProps: String,
		add_date: 0001-01-01,
		file_attached: False,
		receiver_team: String,
		sender_team: String,
		file_id: String,
		company: String,
		branch: String,
		update_date: 0001-01-01,
		comment: String
	}
}