mediaService

Click here for a complete list of operations.

readList

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 /umbraco/webservices/api/MediaService.asmx HTTP/1.1
Host: agreements.blackboard.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://umbraco.org/webservices/readList"

<?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>
    <readList xmlns="http://umbraco.org/webservices/">
      <parentId>int</parentId>
      <username>string</username>
      <password>string</password>
    </readList>
  </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>
    <readListResponse xmlns="http://umbraco.org/webservices/">
      <readListResult>
        <mediaCarrier>
          <Id>int</Id>
          <Text>string</Text>
          <TypeAlias>string</TypeAlias>
          <TypeId>int</TypeId>
          <CreateDateTime>dateTime</CreateDateTime>
          <HasChildren>boolean</HasChildren>
          <Level>int</Level>
          <ParentId>int</ParentId>
          <Path>string</Path>
          <SortOrder>int</SortOrder>
          <MediaProperties>
            <mediaProperty xsi:nil="true" />
            <mediaProperty xsi:nil="true" />
          </MediaProperties>
        </mediaCarrier>
        <mediaCarrier>
          <Id>int</Id>
          <Text>string</Text>
          <TypeAlias>string</TypeAlias>
          <TypeId>int</TypeId>
          <CreateDateTime>dateTime</CreateDateTime>
          <HasChildren>boolean</HasChildren>
          <Level>int</Level>
          <ParentId>int</ParentId>
          <Path>string</Path>
          <SortOrder>int</SortOrder>
          <MediaProperties>
            <mediaProperty xsi:nil="true" />
            <mediaProperty xsi:nil="true" />
          </MediaProperties>
        </mediaCarrier>
      </readListResult>
    </readListResponse>
  </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 /umbraco/webservices/api/MediaService.asmx HTTP/1.1
Host: agreements.blackboard.com
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>
    <readList xmlns="http://umbraco.org/webservices/">
      <parentId>int</parentId>
      <username>string</username>
      <password>string</password>
    </readList>
  </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>
    <readListResponse xmlns="http://umbraco.org/webservices/">
      <readListResult>
        <mediaCarrier>
          <Id>int</Id>
          <Text>string</Text>
          <TypeAlias>string</TypeAlias>
          <TypeId>int</TypeId>
          <CreateDateTime>dateTime</CreateDateTime>
          <HasChildren>boolean</HasChildren>
          <Level>int</Level>
          <ParentId>int</ParentId>
          <Path>string</Path>
          <SortOrder>int</SortOrder>
          <MediaProperties>
            <mediaProperty xsi:nil="true" />
            <mediaProperty xsi:nil="true" />
          </MediaProperties>
        </mediaCarrier>
        <mediaCarrier>
          <Id>int</Id>
          <Text>string</Text>
          <TypeAlias>string</TypeAlias>
          <TypeId>int</TypeId>
          <CreateDateTime>dateTime</CreateDateTime>
          <HasChildren>boolean</HasChildren>
          <Level>int</Level>
          <ParentId>int</ParentId>
          <Path>string</Path>
          <SortOrder>int</SortOrder>
          <MediaProperties>
            <mediaProperty xsi:nil="true" />
            <mediaProperty xsi:nil="true" />
          </MediaProperties>
        </mediaCarrier>
      </readListResult>
    </readListResponse>
  </soap12:Body>
</soap12:Envelope>