PhotoSet

The PhotoSet snapshot represents a photoset object.

PhotoSet : GroupElement
{
    //
    // Level 1 fields
    //
    DateTime CreatedOn,
    DateTime ModifiedOn,
    PhotoSetType Type,
    int FeaturedIndex,
    Photo TitlePhoto,
    int PhotoCount,
    int Views,
    string UploadUrl,
    string PageUrl,                  // new in version 1.1
    string MailboxId,                // new in version 1.3
    int TextCn,                      // new in version 1.4
    string VideoUploadUrl,           // new in version 1.5
    string RawUploadUrl,             // new in version 1.8

    //
    // Level 2 fields
    //
    string Caption,
    string[] Keywords,
    int[] Categories,
    bool IsRandomTitlePhoto,
    int FileCount,                   // new in version 1.8

    //
    // Full level fields
    //
    long [] ParentGroups,
    long PhotoBytes,
    long FileBytes,                  // new in version 1.8

    //
    // Other fields
    //
    Photo[] Photos

}

Members

CreatedOn
Date and time when the photoset was created. This attribute is subject to access control.
ModifiedOn
Date and time when the photoset was last modified. This attribute is subject to access control.
Type
Type of the photoset
FeaturedIndex
Index of the photoset within featured photosets of the user. If this value is not returned, the photoset is not featured.
TitlePhoto
Cover photo of this photoset. A null value indicates that no title photo is set.
PhotoCount
The number of photos in the photoset
Views
The number of photoset visitors. This attribute is subject to access control.
UploadUrl
A URL that can be used to upload photos to this gallery. This field is only returned for galleries, for collections it is always null. See Uploading Photos, Videos and Raw Files for more information on uploading photos.
In API versions prior to 1.2, this field only returns the URL path, such as "/p1070112597/upload". Starting from API version 1.2, this field returns the full URL, including the protocol and the host name, for example, "http://upload.zenfolio.com/p1070112597/upload"
PageUrl
In API version 1.1, returns the URL path of the corresponding gallery or collection page on Zenfolio, such as "/p1070112597" or "/example".
Starting from API version 1.2, this field returns the full URL of the corresponding gallery or collection page on Zenfolio, including the protocol and host name, for example, "http://demo.zenfolio.com/p1070112597" or "http://www.mycustomdomain.com/example".
This field was first introduced in API version 1.1.
MailboxId
Identifier of the mailbox associated with this photo. Mailbox IDs are used in message-related operations, such as AddMessage and DeleteMessage.
This field was first introduced in API version 1.3.
TextCn
Text change number of the photoset. This number is incremented each time when one of the following photoset fields changes: Title, Caption, Keywords, Categories.
This field is new in API version 1.4.
VideoUploadUrl
A URL that can be used to upload videos to this gallery. This field is only returned for galleries, for collections it is always null. See Uploading Photos, Videos and Raw Files for more information on uploading videos.
This field is new in API version 1.5.
RawUploadUrl
A URL that can be used to upload Raw files to this gallery. This field is only returned for galleries, for collections it is always null. See Uploading Photos, Videos and Raw Files for more information on uploading Raw files.
This field is new in API version 1.8.
Caption
Photoset caption. This attribute is subject to access control.
Keywords
Keywords associated with this photoset. This attribute is subject to access control.
Categories
Array of category codes for this photoset. Most specific categories are returned first. This attribute is subject to access control.
IsRandomTitlePhoto
Indicates that the title photo is selected randomly among the photos in the photoset.
FileCount
The number of Raw files uploaded to this gallery.
This field is new in API version 1.8.
ParentGroups
Array of identifiers of parent photoset groups, listed starting from the top of the hierarchy. A null value indicates that this information is not loaded.
PhotoBytes
The total number of bytes used by all photos in this photoset.
GalleryBytes
The total number of bytes used by all Raw files in this gallery.
This field is new in API version 1.8.
Photos
Array of photos that belong to the photoset in their display order. This attribute is subject to access control. As of API version 1.4, this field is only returned from LoadPhotoSet when the includePhotos argument is true.

Remarks

The set of fields actually returned in a phototset snapshot depends on the loading method and the information level requested. Please refer to the method documentation for the list of fields loaded in each case.

See Also

Index