Back | Webservices | Home

CategoriesByParentID

Description

Returns a list of categories limited by the parent categories ID which is provided.

Request Parameters

Name Description

soap:header

Username and password

Type: UserCredentials

Children: Userid, Password

parentID Parent Catregory ID
Type: int

Response Elements

Name Description

CategoriesByParentIDResult

Category elements.

Type: List Category

Example using SOAP

Example Request

The following is a sample SOAP 1.2 request and response.

<?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:Header>
    <UserCredentials xmlns="http://vidzapper.net/Webservice/">
      <Userid>string</Userid>
      <Password>string</Password>
    </UserCredentials>
  </soap12:Header>
  <soap12:Body>
    <CategoriesByParentID xmlns="http://vidzapper.net/Webservice/">
      <parentID>int</parentID>
    </CategoriesByParentID>
  </soap12:Body>
</soap12:Envelope>            

Example Response

<?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>
    <CategoriesByParentIDResponse xmlns="http://vidzapper.net/Webservice/">
      <CategoriesByParentIDResult>
        <Category>
          <ID>int</ID>
          <ParentID>int</ParentID>
          <Title>string</Title>
          <Description>string</Description>
          <ChannelID>int</ChannelID>
          <Error>
            <Status>string</Status>
            <Message>string</Message>
          </Error>
        </Category>
        <Category>
          <ID>int</ID>
          <ParentID>int</ParentID>
          <Title>string</Title>
          <Description>string</Description>
          <ChannelID>int</ChannelID>
          <Error>
            <Status>string</Status>
            <Message>string</Message>
          </Error>
        </Category>
      </CategoriesByParentIDResult>
    </CategoriesByParentIDResponse>
  </soap12:Body>
</soap12:Envelope>