Group

The Group snapshot represents a photoset group – a container for photosets (galleries and collections). Groups can also contain other photoset groups thus forming a hierarchical structure.

Group : GroupElement
{
    //
    // Level 1 fields
    //
    DateTime CreatedOn,
    DateTime ModifiedOn,
    string PageUrl,               // new in version 1.1
    Photo TitlePhoto,             // new in version 1.2
    string MailboxId,             // new in version 1.3
    int ImmediateChildrenCount,   // new in version 1.4
    int TextCn,                   // new in version 1.4

    //
    // Level 2 fields
    //
    string Caption,

    //
    // Full level fields
    //
    int CollectionCount,
    int SubGroupCount,
    int GalleryCount,
    int PhotoCount,
    long[] ParentGroups,

    //
    // Other fields
    //
    GroupElement[] Elements
}

Members

CreatedOn

Date and time when the group was created. This attribute is subject to access control.

ModifiedOn

Date and time when the group was last modified. This attribute is subject to access control.

PageUrl

In API version 1.1, this field return the URL path of the corresponding group page on Zenfolio, such as "/f1070112597" or "/example".

Starting with API version 1.2, this field returns the fully qualified URL of the corresponding group page on Zenfolio, including the protocol and host name, for example, "http://demo.zenfolio.com/f1070112597" or "http://www.mycustomdomain.com/example".

This field was first introduced in API version 1.1.

TitlePhoto

Cover photo of this photoset. A null value indicates that no title photo is set.

The Photo snapshot returned in this field has the following fields loaded: Id, Width, Height, Sequence, AccessDescriptor, MimeType, OriginalUrl, UrlCore, UrlHost, UrlToken, PageUrl.

This field was first introduced in API version 1.2.

MailboxId

Identifier of the mailbox associated with this group. Mailbox ID is used in message-related operations, such as AddMessage and DeleteMessage.

This field is new in API version 1.4.

ImmediateChildrenCount

Number of the immediate group children.

This field is new in API version 1.4.

TextCn

Returns the text change number for the group. This number is incremented each time the group title or caption changes.

This field is new in API version 1.4.

Caption

Group caption. This attribute is subject to access control.

CollectionCount

Number of collections in this and all nested sub-groups

SubGroupCount

Number of photoset groups in this and all nested sub-groups

GalleryCount

Number of galleries in this and all nested sub-groups

PhotoCount

Number of photos in this and all nested sub-groups

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.

Elements

An array of group elements (groups or photosets) in their display order. A null value indicates that this information is not loaded. An empty array indicates that this photoset group is empty. This attribute is subject to access control.

Remarks

The set of fields actually returned in a group 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