ZfApi


Click here for a complete list of operations.

CreateGroup

Creates a Group. More...

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 /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/CreateGroup"

<?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>
    <CreateGroup xmlns="http://www.zenfolio.com/api">
      <parentId>int</parentId>
      <updater>
        <Title>string</Title>
        <Caption>string</Caption>
      </updater>
    </CreateGroup>
  </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>
    <CreateGroupResponse xmlns="http://www.zenfolio.com/api">
      <CreateGroupResult>
        <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>
      </CreateGroupResult>
    </CreateGroupResponse>
  </soap:Body>
</soap:Envelope>
 

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": "CreateGroup",
    "params": [parentId, updater],
    "id": id
}

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

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