SLnet.WebExtApi

<back to all web services

ListAllDocuments

Generic API

The following routes are available for this service:
GET/api/{DomainName}/documents/{EntityID}Retrieves the directory tree and files of an entity

To override the Content-type in your clients 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 /xml/reply/ListAllDocuments HTTP/1.1 
Host: 5.172.198.40 
Content-Type: application/xml
Content-Length: length

<ListAllDocuments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SLnet.WebExtApi.ServiceInterface.WebAPI.Api">
  <DomainName xmlns="http://schemas.datacontract.org/2004/07/SLnet.WebExtApi.WebAPI.Api">String</DomainName>
  <EntityID xmlns="http://schemas.datacontract.org/2004/07/SLnet.WebExtApi.WebAPI.Api">String</EntityID>
  <provider>String</provider>
  <setup>String</setup>
</ListAllDocuments>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfDocumentTreeResources xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SLnet.WebExtApi.Common">
  <DocumentTreeResources>
    <Name>String</Name>
    <Uri>String</Uri>
    <CreationDate>0001-01-01T00:00:00</CreationDate>
    <Description>String</Description>
    <FileName>String</FileName>
    <ID>String</ID>
    <Kind>0</Kind>
    <LinkID>String</LinkID>
    <Origin>0</Origin>
    <OwnerID>String</OwnerID>
    <ParentID>String</ParentID>
    <RelativeID>String</RelativeID>
    <Revision>0</Revision>
    <RevisionID>String</RevisionID>
    <Size>0</Size>
    <Tags>String</Tags>
    <User>String</User>
    <Domain>0</Domain>
    <Files>
      <DocumentResources>
        <Name>String</Name>
        <Uri>String</Uri>
        <CreationDate>0001-01-01T00:00:00</CreationDate>
        <Description>String</Description>
        <FileName>String</FileName>
        <ID>String</ID>
        <Kind>0</Kind>
        <LinkID>String</LinkID>
        <Origin>0</Origin>
        <OwnerID>String</OwnerID>
        <ParentID>String</ParentID>
        <RelativeID>String</RelativeID>
        <Revision>0</Revision>
        <RevisionID>String</RevisionID>
        <Size>0</Size>
        <Tags>String</Tags>
        <User>String</User>
      </DocumentResources>
    </Files>
    <NodeIsTemplate>false</NodeIsTemplate>
    <NodeType>0</NodeType>
  </DocumentTreeResources>
</ArrayOfDocumentTreeResources>