SLnet.WebExtApi

<back to all web services

GetResourceByFetchPath

Generic API

The following routes are available for this service:
POST/api/{DomainName}/entities/{EntityName}/fetchRetrieves a multiple resource instances, for the specified fetch path

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/GetResourceByFetchPath HTTP/1.1 
Host: 5.172.198.40 
Content-Type: application/xml
Content-Length: length

<GetResourceByFetchPath xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SLnet.WebExtApi.WebAPI.Api">
  <DomainName>String</DomainName>
  <EntityName>String</EntityName>
  <Path xmlns:d2p1="http://schemas.datacontract.org/2004/07/SLnet.WebExtApi.Common">
    <d2p1:FillRelativeFields>false</d2p1:FillRelativeFields>
    <d2p1:Filters>
      <d2p1:Filter>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Operator>String</d2p1:Operator>
        <d2p1:Type>Default</d2p1:Type>
        <d2p1:Value />
      </d2p1:Filter>
    </d2p1:Filters>
    <d2p1:IncludePaths>
      <d2p1:FetchPath>
        <d2p1:FillRelativeFields>false</d2p1:FillRelativeFields>
        <d2p1:Filters>
          <d2p1:Filter>
            <d2p1:Name>String</d2p1:Name>
            <d2p1:Operator>String</d2p1:Operator>
            <d2p1:Type>Default</d2p1:Type>
            <d2p1:Value />
          </d2p1:Filter>
        </d2p1:Filters>
        <d2p1:IncludePaths>
          <d2p1:FetchPath>
            <d2p1:FillRelativeFields>false</d2p1:FillRelativeFields>
            <d2p1:Filters>
              <d2p1:Filter>
                <d2p1:Name>String</d2p1:Name>
                <d2p1:Operator>String</d2p1:Operator>
                <d2p1:Type>Default</d2p1:Type>
                <d2p1:Value />
              </d2p1:Filter>
            </d2p1:Filters>
            <d2p1:IncludePaths>
              <d2p1:FetchPath i:nil="true" />
            </d2p1:IncludePaths>
            <d2p1:MaxRecords>0</d2p1:MaxRecords>
            <d2p1:Path>String</d2p1:Path>
            <d2p1:SelectProperties xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:string>String</d7p1:string>
            </d2p1:SelectProperties>
            <d2p1:Skip>0</d2p1:Skip>
            <d2p1:SortBy>
              <d2p1:SortExpression>
                <d2p1:Direction>String</d2p1:Direction>
                <d2p1:FieldName>String</d2p1:FieldName>
              </d2p1:SortExpression>
            </d2p1:SortBy>
            <d2p1:Take>0</d2p1:Take>
          </d2p1:FetchPath>
        </d2p1:IncludePaths>
        <d2p1:MaxRecords>0</d2p1:MaxRecords>
        <d2p1:Path>String</d2p1:Path>
        <d2p1:SelectProperties xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d2p1:SelectProperties>
        <d2p1:Skip>0</d2p1:Skip>
        <d2p1:SortBy>
          <d2p1:SortExpression>
            <d2p1:Direction>String</d2p1:Direction>
            <d2p1:FieldName>String</d2p1:FieldName>
          </d2p1:SortExpression>
        </d2p1:SortBy>
        <d2p1:Take>0</d2p1:Take>
      </d2p1:FetchPath>
    </d2p1:IncludePaths>
    <d2p1:MaxRecords>0</d2p1:MaxRecords>
    <d2p1:Path>String</d2p1:Path>
    <d2p1:SelectProperties xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:SelectProperties>
    <d2p1:Skip>0</d2p1:Skip>
    <d2p1:SortBy>
      <d2p1:SortExpression>
        <d2p1:Direction>String</d2p1:Direction>
        <d2p1:FieldName>String</d2p1:FieldName>
      </d2p1:SortExpression>
    </d2p1:SortBy>
    <d2p1:Take>0</d2p1:Take>
  </Path>
</GetResourceByFetchPath>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DataSet>
  <xs:schema id="String" targetNamespace="String" xmlns:mstns="String" xmlns="String" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" attributeFormDefault="qualified" elementFormDefault="qualified">
    <xs:element name="String" msdata:IsDataSet="true" msdata:UseCurrentLocale="true" msdata:EnforceConstraints="False" msdata:Prefix="String">
      <xs:complexType>
        <xs:choice minOccurs="0" maxOccurs="unbounded" />
      </xs:complexType>
    </xs:element>
  </xs:schema>
  <diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1" />
</DataSet>