Service Web Service

Service

Click here for a complete list of operations.

DMSGetDocumentsByUID

سرویس مشاهده ی اسناد و فایل های آپلود شده در سامانه مدیریت اسناد

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Service.asmx HTTP/1.1
Host: api-uat.bki.ir
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/DMSGetDocumentsByUID"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DMSGetDocumentsByUID xmlns="http://tempuri.org/">
      <dMSGetDocuments>
        <RefCode>string</RefCode>
      </dMSGetDocuments>
    </DMSGetDocumentsByUID>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DMSGetDocumentsByUIDResponse xmlns="http://tempuri.org/">
      <DMSGetDocumentsByUIDResult>
        <CategoryID>int</CategoryID>
        <CategoryTitle>string</CategoryTitle>
        <NID>string</NID>
        <FullName>string</FullName>
        <Message>
          <ID>int</ID>
          <Status>string</Status>
          <Title>string</Title>
          <Message>string</Message>
          <Value>string</Value>
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
          <Dictionary>
            <Dictionary xsi:nil="true" />
            <Dictionary xsi:nil="true" />
          </Dictionary>
        </Message>
        <Documents>
          <DocumentViewModel>
            <ID>int</ID>
            <OwnerID>int</OwnerID>
            <DocumentTypeID>int</DocumentTypeID>
            <DocumentTypeTilte>string</DocumentTypeTilte>
            <ObserverID>int</ObserverID>
            <Value>string</Value>
            <IsActive>boolean</IsActive>
            <MetaData xsi:nil="true" />
            <DocumentFiles xsi:nil="true" />
          </DocumentViewModel>
          <DocumentViewModel>
            <ID>int</ID>
            <OwnerID>int</OwnerID>
            <DocumentTypeID>int</DocumentTypeID>
            <DocumentTypeTilte>string</DocumentTypeTilte>
            <ObserverID>int</ObserverID>
            <Value>string</Value>
            <IsActive>boolean</IsActive>
            <MetaData xsi:nil="true" />
            <DocumentFiles xsi:nil="true" />
          </DocumentViewModel>
        </Documents>
      </DMSGetDocumentsByUIDResult>
    </DMSGetDocumentsByUIDResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Service.asmx HTTP/1.1
Host: api-uat.bki.ir
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <DMSGetDocumentsByUID xmlns="http://tempuri.org/">
      <dMSGetDocuments>
        <RefCode>string</RefCode>
      </dMSGetDocuments>
    </DMSGetDocumentsByUID>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <DMSGetDocumentsByUIDResponse xmlns="http://tempuri.org/">
      <DMSGetDocumentsByUIDResult>
        <CategoryID>int</CategoryID>
        <CategoryTitle>string</CategoryTitle>
        <NID>string</NID>
        <FullName>string</FullName>
        <Message>
          <ID>int</ID>
          <Status>string</Status>
          <Title>string</Title>
          <Message>string</Message>
          <Value>string</Value>
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
          <Dictionary>
            <Dictionary xsi:nil="true" />
            <Dictionary xsi:nil="true" />
          </Dictionary>
        </Message>
        <Documents>
          <DocumentViewModel>
            <ID>int</ID>
            <OwnerID>int</OwnerID>
            <DocumentTypeID>int</DocumentTypeID>
            <DocumentTypeTilte>string</DocumentTypeTilte>
            <ObserverID>int</ObserverID>
            <Value>string</Value>
            <IsActive>boolean</IsActive>
            <MetaData xsi:nil="true" />
            <DocumentFiles xsi:nil="true" />
          </DocumentViewModel>
          <DocumentViewModel>
            <ID>int</ID>
            <OwnerID>int</OwnerID>
            <DocumentTypeID>int</DocumentTypeID>
            <DocumentTypeTilte>string</DocumentTypeTilte>
            <ObserverID>int</ObserverID>
            <Value>string</Value>
            <IsActive>boolean</IsActive>
            <MetaData xsi:nil="true" />
            <DocumentFiles xsi:nil="true" />
          </DocumentViewModel>
        </Documents>
      </DMSGetDocumentsByUIDResult>
    </DMSGetDocumentsByUIDResponse>
  </soap12:Body>
</soap12:Envelope>