ZfApi


Click here for a complete list of operations.

UpdatePhotoSet

Updates a photoset. 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.6/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/1.6/UpdatePhotoSet"

<?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>
    <UpdatePhotoSet xmlns="http://www.zenfolio.com/api/1.6">
      <photoSetId>int</photoSetId>
      <updater>
        <Title>string</Title>
        <Caption>string</Caption>
        <Keywords>
          <Keyword>string</Keyword>
          <Keyword>string</Keyword>
        </Keywords>
        <Categories>
          <Category>int</Category>
          <Category>int</Category>
        </Categories>
        <CustomReference>string</CustomReference>
      </updater>
    </UpdatePhotoSet>
  </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>
    <UpdatePhotoSetResponse xmlns="http://www.zenfolio.com/api/1.6">
      <UpdatePhotoSetResult>
        <Caption>string</Caption>
        <CreatedOn>dateTime</CreatedOn>
        <ModifiedOn>dateTime</ModifiedOn>
        <PhotoCount>int</PhotoCount>
        <ImageCount>int</ImageCount>
        <VideoCount>int</VideoCount>
        <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>
            <RealmId>int</RealmId>
            <AccessType>Private or UserList or Password or Public</AccessType>
            <IsDerived>boolean</IsDerived>
            <AccessMask>ProtectAll or NoCollections or None or NoPrivateSearch or NoPublicSearch or NoRecentList or HideDateCreated or HideDateModified or HideDateTaken or ProtectExif or ProtectExtraLarge or ProtectLarge or ProtectMedium or HideMetaData or ProtectOriginals or HideUserStats or HideVisits or NoPublicGuestbookPosts or NoPrivateGuestbookPosts or NoAnonymousGuestbookPosts or NoPublicComments or NoPrivateComments or NoAnonymousComments or ProtectGuestbook or ProtectComments or PasswordProtectOriginals or ProtectXXLarge or UnprotectCover</AccessMask>
            <Viewers xsi:nil="true" />
            <PasswordHint>string</PasswordHint>
            <SrcPasswordHint>string</SrcPasswordHint>
          </AccessDescriptor>
          <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>
            <Keyword>string</Keyword>
            <Keyword>string</Keyword>
          </Keywords>
          <Categories>
            <Category>int</Category>
            <Category>int</Category>
          </Categories>
          <Flags>None or HasTitle or HasCaption or HasKeywords or HasCategories or HasExif or HasComments</Flags>
          <TextCn>int</TextCn>
          <PricingKey>long</PricingKey>
          <MimeType>string</MimeType>
          <OriginalUrl>string</OriginalUrl>
          <UrlCore>string</UrlCore>
          <UrlHost>string</UrlHost>
          <UrlToken>string</UrlToken>
          <Copyright>string</Copyright>
          <FileHash>base64Binary</FileHash>
          <PageUrl>string</PageUrl>
          <ExifTags>
            <Id>int</Id>
            <Value>string</Value>
            <DisplayValue>string</DisplayValue>
          </ExifTags>
          <ExifTags>
            <Id>int</Id>
            <Value>string</Value>
            <DisplayValue>string</DisplayValue>
          </ExifTags>
          <ShortExif>string</ShortExif>
          <MailboxId>string</MailboxId>
          <IsVideo>boolean</IsVideo>
          <Duration>int</Duration>
        </TitlePhoto>
        <IsRandomTitlePhoto>boolean</IsRandomTitlePhoto>
        <ParentGroups>
          <Id>int</Id>
          <Id>int</Id>
        </ParentGroups>
        <Photos>
          <Photo>
            <Id>int</Id>
            <Width>unsignedInt</Width>
            <Height>unsignedInt</Height>
            <Sequence>string</Sequence>
            <AccessDescriptor xsi:nil="true" />
            <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 xsi:nil="true" />
            <Categories xsi:nil="true" />
            <Flags>None or HasTitle or HasCaption or HasKeywords or HasCategories or HasExif or HasComments</Flags>
            <TextCn>int</TextCn>
            <PricingKey>long</PricingKey>
            <MimeType>string</MimeType>
            <OriginalUrl>string</OriginalUrl>
            <UrlCore>string</UrlCore>
            <UrlHost>string</UrlHost>
            <UrlToken>string</UrlToken>
            <Copyright>string</Copyright>
            <FileHash>base64Binary</FileHash>
            <PageUrl>string</PageUrl>
            <ExifTags xsi:nil="true" />
            <ExifTags xsi:nil="true" />
            <ShortExif>string</ShortExif>
            <MailboxId>string</MailboxId>
            <IsVideo>boolean</IsVideo>
            <Duration>int</Duration>
          </Photo>
          <Photo>
            <Id>int</Id>
            <Width>unsignedInt</Width>
            <Height>unsignedInt</Height>
            <Sequence>string</Sequence>
            <AccessDescriptor xsi:nil="true" />
            <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 xsi:nil="true" />
            <Categories xsi:nil="true" />
            <Flags>None or HasTitle or HasCaption or HasKeywords or HasCategories or HasExif or HasComments</Flags>
            <TextCn>int</TextCn>
            <PricingKey>long</PricingKey>
            <MimeType>string</MimeType>
            <OriginalUrl>string</OriginalUrl>
            <UrlCore>string</UrlCore>
            <UrlHost>string</UrlHost>
            <UrlToken>string</UrlToken>
            <Copyright>string</Copyright>
            <FileHash>base64Binary</FileHash>
            <PageUrl>string</PageUrl>
            <ExifTags xsi:nil="true" />
            <ExifTags xsi:nil="true" />
            <ShortExif>string</ShortExif>
            <MailboxId>string</MailboxId>
            <IsVideo>boolean</IsVideo>
            <Duration>int</Duration>
          </Photo>
        </Photos>
        <Keywords>
          <Keyword>string</Keyword>
          <Keyword>string</Keyword>
        </Keywords>
        <Categories>
          <Category>int</Category>
          <Category>int</Category>
        </Categories>
        <UploadUrl>string</UploadUrl>
        <VideoUploadUrl>string</VideoUploadUrl>
        <PageUrl>string</PageUrl>
        <MailboxId>string</MailboxId>
        <TextCn>int</TextCn>
        <PhotoListCn>int</PhotoListCn>
      </UpdatePhotoSetResult>
    </UpdatePhotoSetResponse>
  </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.6/zfapi.asmx HTTP/1.1
Host: www.zenfolio.com
Content-Type: application/json
Content-Length: length

{
    "method": "UpdatePhotoSet",
    "params": [photoSetId, 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