Returns a list of images from the Image Library.
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRContentAPI | SRContentAPI | GET, POST | Server. |
This method returns a list of links to image content stored on the Luminate Online site.
The list_filter_text parameter specifies search text to filter the results. It matches, case insensitively, text in the file name, title, or keywords of images.
See topic Common Parameters.
Optional. Specifies whether to include archived images in the results.
Type xsd:boolean.
Default is false.
Optional. Whether the list should be sorted in ascending order.
Type xsd:boolean.
Default is true.
Optional. Security Category filter.
Type xsd:integer.
Optional. The text that will be used to filter results.
Type xsd:string.
Optional. The requested page number (used with "list_page_size"). The first page (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").
Type xsd:integer.
Default is 25.
Optional. The requested initial record number (used with "list_page_size"). The first record (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The column to sort with (used with "list_ascending").
Type xsd:string.
See topic Common Parameters.
Optional. Specifies whether to include archived images in the results.
Type xsd:boolean.
Default is false.
Optional. Whether the list should be sorted in ascending order.
Type xsd:boolean.
Default is true.
Optional. Security Category filter.
Type xsd:integer.
Optional. The text that will be used to filter results.
Type xsd:string.
Optional. The requested page number (used with "list_page_size"). The first page (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The number of results in each page (used with "list_record_offset" or "list_page_offset").
Type xsd:integer.
Default is 25.
Optional. The requested initial record number (used with "list_page_size"). The first record (default) is zero. Only one of "list_record_offset" or "list_page_offset" should be used in a request.
Type xsd:integer.
Optional. The column to sort with (used with "list_ascending").
Type xsd:string.
See topic HTTP Status Codes.
XML response
<?xml version="1.0" encoding="UTF-8"?>
<listImagesResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<pagingMetadata>
<currentSize>2</currentSize>
<isFinalSize>true</isFinalSize>
</pagingMetadata>
<image>
<imageId>1002</imageId>
<title>Sample image 1002</title>
<createdDate>2016-02-01T09:43:44.630-06:00</createdDate>
<originalFilename>local_image.jpg</originalFilename>
<keywords>convio, logo</keywords>
<insecureUrl>http://www.convio.com/images/content/image_1002.jpg</insecureUrl>
<secureUrl>https://www.convio.com/images/content/image_1002.jpg</secureUrl>
<categoryId>0</categoryId>
<archived>false</archived>
<height>0</height>
<width>0</width>
</image>
<image>
<imageId>1003</imageId>
<title>Sample image 1003</title>
<createdDate>2016-02-01T09:43:44.630-06:00</createdDate>
<originalFilename>local_image.jpg</originalFilename>
<keywords>convio, logo</keywords>
<insecureUrl>http://www.convio.com/images/content/image_1003.jpg</insecureUrl>
<secureUrl>https://www.convio.com/images/content/image_1003.jpg</secureUrl>
<categoryId>0</categoryId>
<archived>false</archived>
<height>0</height>
<width>0</width>
</image>
<showSecurityCatFilter>true</showSecurityCatFilter>
</listImagesResponse>
JSON response
{"listImagesResponse":{"pagingMetadata":{"isFinalSize":"true","currentSize":"2"},"showSecurityCatFilter":"true","image":[{"title":"Sample image 1004","height":"0","keywords":"convio, logo","imageId":"1004","archived":"false","width":"0","categoryId":"0","insecureUrl":"http://www.convio.com/images/content/image_1004.jpg","originalFilename":"local_image.jpg","secureUrl":"https://www.convio.com/images/content/image_1004.jpg","createdDate":"2016-02-01T09:43:44.631-06:00"},{"title":"Sample image 1005","height":"0","keywords":"convio, logo","imageId":"1005","archived":"false","width":"0","categoryId":"0","insecureUrl":"http://www.convio.com/images/content/image_1005.jpg","originalFilename":"local_image.jpg","secureUrl":"https://www.convio.com/images/content/image_1005.jpg","createdDate":"2016-02-01T09:43:44.631-06:00"}]}}