Photo

The Photo snapshot represents a photo object.

Photo
{
    //
    // Level 1 fields
    //
    long Id,
    uint Width,
    uint Height,
    string Sequence,
    AccessDescriptor AccessDescriptor,
    string Owner,
    string Title,
    string MimeType,
    int Views,
    int Size,
    int Gallery,
    string OriginalUrl,
    string UrlCore,
    string UrlHost,             // new in version 1.4
    string UrlToken,            // new in version 1.4
    string PageUrl              // new in version 1.1
    string MailboxId,           // new in version 1.3
    int TextCn,                 // new in version 1.4
    PhotoFlags Flags,           // new in version 1.4
    bool IsVideo,               // new in version 1.6
    int Duration,               // new in version 1.6

    //
    // Level 2 fields
    //
    string Caption,
    string FileName,
    DateTime UploadedOn,
    DateTime TakenOn,
    string[] Keywords,
    int[] Categories,
    string Copyright,
    PhotoRotation Rotation,
    ExifTag[] ExifTags,         // new in version 1.4
    string ShortExif            // new in version 1.4
}

Members

Id

64-bit photo identifier. This attribute is always loaded.

Width

Photo width in pixels

Height

Photo height in pixels

Sequence

Photo snapshot version

AccessDescriptor

Photo access control descriptor

Owner

User name of the photo owner

Title

Photo title

MimeType

MIME type of the original photo file

Views

The number of visits to this photo. This attribute is subject to access control.

Size

Size of the original image file in bytes

Gallery

Identifier of the gallery that contains this photo

OriginalUrl

In API versions prior to 1.2, returns the URL path of the original full size photo file, for example, "/img/v0/p12711939.jpg".

Starting from API version 1.2, this field returns the full URL of the original full size photo file, including the protocol and the host name, for example, "http://demo.zenfolio.com/img/v0/p12711939.jpg".

UrlCore

URL core of the photo. See Downloading Photos for more information on how to construct image URLs.

UrlHost

URL host name of the photo. See Downloading Photos for more information on how to construct image URLs.

This field is new in API version 1.4.

UrlToken

URL token of the photo. See Downloading Photos for more information on how to construct image URLs.

This field is new in API version 1.4.

PageUrl

In API version 1.1, returns the URL path of the corresponding photo page on Zenfolio, such as "/p1070112597/e239e27a2" or "/example/e239e27a2".

Starting from API version 1.2, this field returns the full URL of the corresponding page on Zenfolio, including the protocol and host name, for example, "http://demo.zenfolio.com/p1070112597/e239e27a2" or "http://www.mycustomdomain.com/example/e239e27a2".

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 photo. This number is incremented each time when one of the following photo fields changes: Title, Caption, Keywords, Categories, Copyright, FileName.

This field is new in API version 1.4.

Flags

Photo flags that indicate which types of content are available for the photo. Applications can use this field to determine if additional calls for information are necessary.

This field is new in API version 1.4.

IsVideo

Indicates whether this snapshot refers to a video.

This field is new in API version 1.6.

Duration

Returns the video duration in seconds. This field is never returned for photos.

This field is new in API version 1.6.

Caption

Photo caption. This attribute is subject to access control.

FileName

Original file name of the photo. This attribute is subject to access control.

UploadedOn

Date and time when the photo was uploaded. This attribute is subject to access control.

TakenOn

Date and time when the photo was taken. This attribute is subject to access control.

Keywords

Keywords associated with this photo. This attribute is subject to access control.

Categories

Array of category codes for this photo. Most specific categories are returned first. This attribute is subject to access control.

Copyright

Copyright string for the photo

Rotation

Specifies how the photo was rotated relative to the originally uploaded file.

ExifTags

List of EXIF tags extracted from the original photo. Not all EXIF tags are extracted; only a small subset of tags relevant to photography are returned in this field.

This field is new in API version 1.4.

ShortExif

Text string that summarizes the shooting conditions, e.g. "Canon EOS 5D, f/2 @ 85 mm, 1/800, ISO 100, No Flash". An empty string may be returned if the original photo did not contain relevant EXIF tags.

This field is new in API version 1.4.

Remarks

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