ZfApi Web Service

ZfApi

Click here for a complete list of operations.

LoadGroupHierarchy

Loads group hierarchy of the specified user. More...

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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 /api/1.0/zfapi.asmx HTTP/1.1
Host: www.zenfolio.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.zenfolio.com/api/LoadGroupHierarchy"

<?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>
    <LoadGroupHierarchy xmlns="http://www.zenfolio.com/api">
      <loginName>string</loginName>
    </LoadGroupHierarchy>
  </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>
    <LoadGroupHierarchyResponse xmlns="http://www.zenfolio.com/api">
      <LoadGroupHierarchyResult>
        <Caption>string</Caption>
        <CreatedOn>dateTime</CreatedOn>
        <ModifiedOn>dateTime</ModifiedOn>
        <CollectionCount>int</CollectionCount>
        <SubGroupCount>int</SubGroupCount>
        <GalleryCount>int</GalleryCount>
        <PhotoCount>int</PhotoCount>
        <ParentGroups>
          <Id>int</Id>
          <Id>int</Id>
        </ParentGroups>
        <Elements>
          <Group>
            <Caption>string</Caption>
            <CreatedOn>dateTime</CreatedOn>
            <ModifiedOn>dateTime</ModifiedOn>
            <CollectionCount>int</CollectionCount>
            <SubGroupCount>int</SubGroupCount>
            <GalleryCount>int</GalleryCount>
            <PhotoCount>int</PhotoCount>
            <ParentGroups xsi:nil="true" />
            <Elements xsi:nil="true" />
          </Group>
          <PhotoSet>
            <Caption>string</Caption>
            <CreatedOn>dateTime</CreatedOn>
            <ModifiedOn>dateTime</ModifiedOn>
            <PhotoCount>int</PhotoCount>
            <PhotoBytes>long</PhotoBytes>
            <Views>int</Views>
            <Type>Gallery or Collection</Type>
            <FeaturedIndex>int</FeaturedIndex>
            <TitlePhoto xsi:nil="true" />
            <IsRandomTitlePhoto>boolean</IsRandomTitlePhoto>
            <ParentGroups xsi:nil="true" />
            <Photos xsi:nil="true" />
            <Keywords xsi:nil="true" />
            <Categories xsi:nil="true" />
            <UploadUrl>string</UploadUrl>
          </PhotoSet>
        </Elements>
      </LoadGroupHierarchyResult>
    </LoadGroupHierarchyResponse>
  </soap:Body>
</soap:Envelope>

HTTP GET

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

GET /api/1.0/zfapi.asmx/LoadGroupHierarchy?loginName=string HTTP/1.1
Host: www.zenfolio.com

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

<?xml version="1.0" encoding="utf-8"?>
<Group xmlns="http://www.zenfolio.com/api">
  <Caption>string</Caption>
  <CreatedOn>dateTime</CreatedOn>
  <ModifiedOn>dateTime</ModifiedOn>
  <CollectionCount>int</CollectionCount>
  <SubGroupCount>int</SubGroupCount>
  <GalleryCount>int</GalleryCount>
  <PhotoCount>int</PhotoCount>
  <ParentGroups>
    <Id>int</Id>
    <Id>int</Id>
  </ParentGroups>
  <Elements>
    <Group>
      <Caption>string</Caption>
      <CreatedOn>dateTime</CreatedOn>
      <ModifiedOn>dateTime</ModifiedOn>
      <CollectionCount>int</CollectionCount>
      <SubGroupCount>int</SubGroupCount>
      <GalleryCount>int</GalleryCount>
      <PhotoCount>int</PhotoCount>
      <ParentGroups>
        <Id>int</Id>
        <Id>int</Id>
      </ParentGroups>
      <Elements>
        <Group d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <PhotoSet d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Elements>
    </Group>
    <PhotoSet>
      <Caption>string</Caption>
      <CreatedOn>dateTime</CreatedOn>
      <ModifiedOn>dateTime</ModifiedOn>
      <PhotoCount>int</PhotoCount>
      <PhotoBytes>long</PhotoBytes>
      <Views>int</Views>
      <Type>Gallery or Collection</Type>
      <FeaturedIndex>int</FeaturedIndex>
      <TitlePhoto>
        <Id>int</Id>
        <Width>unsignedInt</Width>
        <Height>unsignedInt</Height>
        <Sequence>string</Sequence>
        <AccessDescriptor d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Title>string</Title>
        <Caption>string</Caption>
        <FileName>string</FileName>
        <UploadedOn>dateTime</UploadedOn>
        <TakenOn>dateTime</TakenOn>
        <Owner>string</Owner>
        <Gallery>int</Gallery>
        <Views>int</Views>
        <Size>int</Size>
        <Rotation>None or Rotate90 or Rotate180 or Rotate270 or Flip or Rotate90Flip or Rotate180Flip or Rotate270Flip</Rotation>
        <Keywords d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Categories d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <PricingKey>long</PricingKey>
        <MimeType>string</MimeType>
        <OriginalUrl>string</OriginalUrl>
        <UrlCore>string</UrlCore>
        <Copyright>string</Copyright>
        <FileHash>base64Binary</FileHash>
      </TitlePhoto>
      <IsRandomTitlePhoto>boolean</IsRandomTitlePhoto>
      <ParentGroups>
        <Id>int</Id>
        <Id>int</Id>
      </ParentGroups>
      <Photos>
        <Photo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Photo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Photos>
      <Keywords>
        <Keyword>string</Keyword>
        <Keyword>string</Keyword>
      </Keywords>
      <Categories>
        <Category>int</Category>
        <Category>int</Category>
      </Categories>
      <UploadUrl>string</UploadUrl>
    </PhotoSet>
  </Elements>
</Group>

HTTP POST

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

POST /api/1.0/zfapi.asmx/LoadGroupHierarchy HTTP/1.1
Host: www.zenfolio.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

loginName=string

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

<?xml version="1.0" encoding="utf-8"?>
<Group xmlns="http://www.zenfolio.com/api">
  <Caption>string</Caption>
  <CreatedOn>dateTime</CreatedOn>
  <ModifiedOn>dateTime</ModifiedOn>
  <CollectionCount>int</CollectionCount>
  <SubGroupCount>int</SubGroupCount>
  <GalleryCount>int</GalleryCount>
  <PhotoCount>int</PhotoCount>
  <ParentGroups>
    <Id>int</Id>
    <Id>int</Id>
  </ParentGroups>
  <Elements>
    <Group>
      <Caption>string</Caption>
      <CreatedOn>dateTime</CreatedOn>
      <ModifiedOn>dateTime</ModifiedOn>
      <CollectionCount>int</CollectionCount>
      <SubGroupCount>int</SubGroupCount>
      <GalleryCount>int</GalleryCount>
      <PhotoCount>int</PhotoCount>
      <ParentGroups>
        <Id>int</Id>
        <Id>int</Id>
      </ParentGroups>
      <Elements>
        <Group d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <PhotoSet d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Elements>
    </Group>
    <PhotoSet>
      <Caption>string</Caption>
      <CreatedOn>dateTime</CreatedOn>
      <ModifiedOn>dateTime</ModifiedOn>
      <PhotoCount>int</PhotoCount>
      <PhotoBytes>long</PhotoBytes>
      <Views>int</Views>
      <Type>Gallery or Collection</Type>
      <FeaturedIndex>int</FeaturedIndex>
      <TitlePhoto>
        <Id>int</Id>
        <Width>unsignedInt</Width>
        <Height>unsignedInt</Height>
        <Sequence>string</Sequence>
        <AccessDescriptor d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Title>string</Title>
        <Caption>string</Caption>
        <FileName>string</FileName>
        <UploadedOn>dateTime</UploadedOn>
        <TakenOn>dateTime</TakenOn>
        <Owner>string</Owner>
        <Gallery>int</Gallery>
        <Views>int</Views>
        <Size>int</Size>
        <Rotation>None or Rotate90 or Rotate180 or Rotate270 or Flip or Rotate90Flip or Rotate180Flip or Rotate270Flip</Rotation>
        <Keywords d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Categories d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <PricingKey>long</PricingKey>
        <MimeType>string</MimeType>
        <OriginalUrl>string</OriginalUrl>
        <UrlCore>string</UrlCore>
        <Copyright>string</Copyright>
        <FileHash>base64Binary</FileHash>
      </TitlePhoto>
      <IsRandomTitlePhoto>boolean</IsRandomTitlePhoto>
      <ParentGroups>
        <Id>int</Id>
        <Id>int</Id>
      </ParentGroups>
      <Photos>
        <Photo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <Photo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Photos>
      <Keywords>
        <Keyword>string</Keyword>
        <Keyword>string</Keyword>
      </Keywords>
      <Categories>
        <Category>int</Category>
        <Category>int</Category>
      </Categories>
      <UploadUrl>string</UploadUrl>
    </PhotoSet>
  </Elements>
</Group>

JSON-RPC

The following is a sample JSON-RPC request and response. The placeholders shown need to be replaced with actual values.

POST /api/1.0/zfapi.asmx HTTP/1.1
Host: www.zenfolio.com
Content-Type: application/json
Content-Length: length

{
    "method": "LoadGroupHierarchy",
    "params": [loginName],
    "id": id
}

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

{
    "result": value,
    "error": null,
    "id": id
}

Parameter	Value
loginName: