Search

Contents

Revindex Storefront

Export Print

Gallery

The gallery is used to store media data such as images.

DeleteGallery

This service is used to delete a Gallery object.

Request Parameters

Node Required Data Type Description
galleryID Yes Integer The object identifier.

 

Return Data

None


GetGallery

This service is used to query the Gallery object.

Request Parameters

Node Required Data Type Description
galleryID Yes Integer The object identifier.

 

Return Data

Node Data Type Description
gallery XML Container node.
  alternateText XML Locale  
  categoryID Integer The Category object identifier if this gallery is associated to a category object.
  createDate DateTime Creation date.
  displayOrder Integer Sort order for display.
  family Integer Group similar galleries of different formats together.
  format Integer The gallery format type (Detailed = 1, Display = 2, Thumbnail = 3).
  galleryID Integer The object identifier.
  height Integer Height in pixels.
  mediaFile XML Locale The localized file name saved to disk.
  mediaData XML Locale The localized media data in Base64 encoding.

e.g. <locale en-US="TWFuIGlzIGRpc3RXNoZ..." fr-FR="AbSTWFuIG1aXNoZ..."/>
  mediaType XML Locale

The localized media type (image/gif, image/jpeg, image/png, video/mp4 or video/webm).

e.g. <locale en-US="image/jpeg" fr-FR="image/jpeg" />

  portalID Integer  
  productID Integer The Product object identifier if this gallery is associated to a product object.
  productVariantID Integer The ProductVariant object identifier if this gallery is associated to a product variant object.
  updateDate DateTime Update date.
  width Integer The width in pixels.
 

 


GetGalleriesByCategory

This service is used to get all the Gallery objects belonging to the category.

Request Parameters

Node Required Data Type Description
categoryID Yes Integer The Category object identifier.

 

Return Data

Node Data Type Description
galleries XML Container node
  gallery XML Zero or more gallery nodes with same data structure as GetGallery service return data.

 


GetGalleriesByProduct

This service is used to get all the Gallery objects belonging to the product.

Request Parameters

Node Required Data Type Description
productID Yes Integer The Product object identifier.

 

Return Data

Node Data Type Description
galleries XML Container node
  gallery XML Zero or more gallery nodes with same data structure as GetGallery service return data.

 


GetGalleriesByProductVariant

This service is used to get all the Gallery objects belonging to the product variant.

Request Parameters

Node Required Data Type Description
productVariantID Yes Integer The ProductVariant object identifier.

 

Return Data

Node Data Type Description
galleries XML Container node
  gallery XML Zero or more gallery nodes with same data structure as GetGallery service return data.

 

 


InsertGallery

This service is used to create a new Gallery object.

Request Parameters

Node Required Data Type Description
alternateText No XML Locale  
categoryID No Integer The Category object identifier if this gallery is associated to a category object. If you specify this value, you must not specify the productID or productVariantID.
displayOrder Yes Integer Sort order for display.
family Yes Integer Group similar galleries of different formats together.
format Yes Integer The gallery format type (Detailed = 1, Display = 2, Thumbnail = 3).
height Yes Integer Height in pixels.
mediaFile Yes XML Locale The localized file name saved to disk. You can set a random filename using a GUID value.
mediaData Yes XML Locale The localized media data in Base64 encoding.

e.g. <locale en-US="TWFuIGlzIGRpc3RpNoZ..." fr-FR="AbSTWFuIp1aXNoZ..."/> 
mediaType Yes XML Locale

The localized media type (image/gif, image/jpeg, image/png, video/mp4 or video/webm).

e.g. <locale en-US="image/jpeg" fr-FR="image/jpeg" />

productID No Integer The Product object identifier if this gallery is associated to a product object. If you specify this value, you must not specify the categoryID or productVariantID.
productVariantID No Integer The ProductVariant object identifier if this gallery is associated to a product variant object. If you specify this value, you must not specify the categoryID or productID.
width Yes Integer The width in pixels.

 

Return Data

Same as GetGallery service return data.

 

Comments

Add comment

Powered by Revindex Wiki