Image API

Endpoints:

Image API - Endpoints

Images?FolderGUID={Id} - GET

Summary: Gets the image objects that the user has access to within the specified folder.

Behavior: Returns information about all images that the current user has access to and exist within the specified folder.

Parameters
Name	Type	Required	Description
Id	GUID	true	Id of an image folder.

Possible Responses
Status	Body	Description
200 OK	Array of Images	Returns an array of Image objects that current user has access to and exist within the specified folder.

Example Responses:

Name: Success

Status: 200 OK

Body:

                        “[{Caption:'Sunset', Url:'http://www.mydomain.com/image/sunset.jpg'}]”

Images?Tag={TagName} - GET

Summary: Gets the image objects that the user has access to tagged with the specified tag.

Behavior: Returns information about all images that the current user has access to and are tagged with the specified tag.

Parameters
Name	Type	Required	Description
TagName	String	true	Name of the tag

Possible Responses
Status	Body	Description
200 OK	Array of Images	Returns an array of Image objects that current user has access to and are tagged with the specified tag.

Example Responses:

Name: Success

Status: 200 OK

Body:

              “[{Caption:'Sunset', Url:'http://www.mydomain.com/image/sunset.jpg'}]”

Images/{FolderName}/SubFolderName} - GET

Summary: Gets the image objects that the user has access to under the specified folder name/path.

Behavior: Returns information about all images that the current user has access to and exist under the specified folder path.

Parameters
Name	Type	Required	Description
FolderName	String	true	Path/name of the folder.

Possible Responses
Status	Body	Description
200 OK	Array of Images	Returns an array of Image objects that current user has access to and exist under the specified folder path.
404 Not Found		No folder exists at the given path.

Example Responses:

Name: Success

Status: 200 OK

Body:

              “[{Caption:'Sunset', Url:'http://www.mydomain.com/image/sunset.jpg'}]”