TeleportService

<back to all web services

Documents_GetById_v2

Requires Authentication
The following routes are available for this service:
POST, GET/v2/Documents_GetById
Documents_GetById_v2 Parameters:
NameParameterData TypeRequiredDescription
message_idbodystringNo
DocumentsGetByIdResponse_v2 Parameters:
NameParameterData TypeRequiredDescription
errCodeformintNo
documentformDocumentModelNo
DocumentModel Parameters:
NameParameterData TypeRequiredDescription
message_idformstringNo
ownerformstringNo
recipientformstringNo
senderformstringNo
receiverformstringNo
messageformTeleportDocumentNo
typeformstringNo
statusformDocumentStatusNo
dateformDateTimeNo
numformstringNo
sumformdecimalNo
currencyIdformstringNo
hashformstringNo
addPropsformstringNo
add_dateformDateTimeNo
file_attachedformboolNo
receiver_teamformstringNo
sender_teamformstringNo
file_idformstringNo
companyformstringNo
branchformstringNo
update_dateformDateTimeNo
commentformstringNo
TeleportDocument Parameters:
NameParameterData TypeRequiredDescription
docHeaderformTeleportDocumentHeaderNo
tabHeaderformTeleportDocumentTabHeaderNo
docTableformList<TeleportDocumentTable>No
TeleportDocumentHeader Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
ownerformstringNo
typeformstringNo
statusformDocumentStatusNo
dateformDateTimeNo
numformstringNo
hashformstringNo
sumformdecimalNo
currencyIdformstringNo
commentformstringNo
fileAttachedformboolNo
file_idformstringNo
propsformList<TeleportDocumentProps>No
marketplaceformstringNo
delivery_dateformDateTimeNo
marketplace_statusformstringNo
huckster_statusformstringNo
cancel_dateformDateTimeNo
canceled_after_deliveryformboolNo
marketplace_idformstringNo
marketplace_posting_numberformstringNo
marketplace_substatusformstringNo
payment_typeformstringNo
payment_methodformstringNo
marketplace_accountformstringNo
marketplace_shop_idformstringNo
marketplace_expressformboolNo
marketplace_delivery_methodformstringNo
marketplace_warehouse_idformstringNo
marketplace_pre_posting_numberformstringNo
DocumentStatus Enum:
new
transmitted
processed
canceled
agreement
confirmed
shipped
closed
draft
TeleportDocumentProps Parameters:
NameParameterData TypeRequiredDescription
nameformstringNo
headerformstringNo
typeformstringNo
enumvaluesformList<string>No
requiredformboolNo
valueformstringNo
TeleportDocumentTabHeader Parameters:
NameParameterData TypeRequiredDescription
articleformstringNo
nameformstringNo
unitformstringNo
quantityformstringNo
confirmedformstringNo
priceformstringNo
sumformstringNo
trademarkformstringNo
propsformList<TeleportDocumentProps>No
TeleportDocumentTable Parameters:
NameParameterData TypeRequiredDescription
ownerformstringNo
idformstringNo
uidformstringNo
codeformstringNo
articleformstringNo
nameformstringNo
unitformstringNo
quantityformdecimalNo
confirmedformdecimalNo
priceformdecimalNo
sumformdecimalNo
trademarkformstringNo
propsformList<TeleportDocumentPropsValue>No
TeleportDocumentPropsValue Parameters:
NameParameterData TypeRequiredDescription
nameformstringNo
valueformstringNo

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<Documents_GetById_v2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TeleportService.ServiceModel">
  <message_id>String</message_id>
</Documents_GetById_v2>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentsGetByIdResponse_v2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TeleportService.ServiceModel">
  <document>
    <addProps>String</addProps>
    <add_date>0001-01-01T00:00:00</add_date>
    <branch>String</branch>
    <comment>String</comment>
    <company>String</company>
    <currencyId>String</currencyId>
    <date>0001-01-01T00:00:00</date>
    <file_attached>false</file_attached>
    <file_id>String</file_id>
    <hash>String</hash>
    <message>
      <docHeader>
        <cancel_date>0001-01-01T00:00:00</cancel_date>
        <canceled_after_delivery>false</canceled_after_delivery>
        <comment>String</comment>
        <currencyId>String</currencyId>
        <date>0001-01-01T00:00:00</date>
        <delivery_date>0001-01-01T00:00:00</delivery_date>
        <fileAttached>false</fileAttached>
        <file_id>String</file_id>
        <hash>String</hash>
        <huckster_status>String</huckster_status>
        <id>String</id>
        <marketplace>String</marketplace>
        <marketplace_account>String</marketplace_account>
        <marketplace_delivery_method>String</marketplace_delivery_method>
        <marketplace_express>false</marketplace_express>
        <marketplace_id>String</marketplace_id>
        <marketplace_posting_number>String</marketplace_posting_number>
        <marketplace_pre_posting_number>String</marketplace_pre_posting_number>
        <marketplace_shop_id>String</marketplace_shop_id>
        <marketplace_status>String</marketplace_status>
        <marketplace_substatus>String</marketplace_substatus>
        <marketplace_warehouse_id>String</marketplace_warehouse_id>
        <num>String</num>
        <owner>String</owner>
        <payment_method>String</payment_method>
        <payment_type>String</payment_type>
        <props>
          <TeleportDocumentProps>
            <enumvalues xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </enumvalues>
            <header>String</header>
            <name>String</name>
            <required>false</required>
            <type>String</type>
            <value>String</value>
          </TeleportDocumentProps>
        </props>
        <status>new</status>
        <sum>0</sum>
        <type>String</type>
      </docHeader>
      <docTable>
        <TeleportDocumentTable>
          <article>String</article>
          <code>String</code>
          <confirmed>0</confirmed>
          <id>String</id>
          <name>String</name>
          <owner>String</owner>
          <price>0</price>
          <props>
            <TeleportDocumentPropsValue>
              <name>String</name>
              <value>String</value>
            </TeleportDocumentPropsValue>
          </props>
          <quantity>0</quantity>
          <sum>0</sum>
          <trademark>String</trademark>
          <uid>String</uid>
          <unit>String</unit>
        </TeleportDocumentTable>
      </docTable>
      <tabHeader>
        <article>String</article>
        <confirmed>String</confirmed>
        <name>String</name>
        <price>String</price>
        <props>
          <TeleportDocumentProps>
            <enumvalues xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </enumvalues>
            <header>String</header>
            <name>String</name>
            <required>false</required>
            <type>String</type>
            <value>String</value>
          </TeleportDocumentProps>
        </props>
        <quantity>String</quantity>
        <sum>String</sum>
        <trademark>String</trademark>
        <unit>String</unit>
      </tabHeader>
    </message>
    <message_id>String</message_id>
    <num>String</num>
    <owner>String</owner>
    <receiver>String</receiver>
    <receiver_team>String</receiver_team>
    <recipient>String</recipient>
    <sender>String</sender>
    <sender_team>String</sender_team>
    <status>new</status>
    <sum>0</sum>
    <type>String</type>
    <update_date>0001-01-01T00:00:00</update_date>
  </document>
  <errCode>0</errCode>
</DocumentsGetByIdResponse_v2>