Developer API

About

This page describes the SlideSix developers API. To use this API you must be a registered user of SlideSix. If you are a registered user you can log in to the Management Console, go to your profile and select 'Developer API Keys' to create a new key for your application.

Once you have obtained an API key you may use this API to retrieve data about presentations hosted at SlideSix.com. You can also develop applications that can allow other registered users of SlideSix to post new presentations and edit their profile and groups.

Terms

Usage of this API implies agreement with the following terms:

  • You will not charge users for using any application which interacts with this API
  • API is subject to change at any time, with or without developer notification

Methods

API URL

Developers may use the following base URL to post queries to SlideSix. To call a method, simply attach a URL variable called 'method' indicating which method to call.

http://slidesix.com/api/SlideSix.cfc


Return Formats:

The SlideSix API offers the following return formats:

  • JSON (default)
  • XML

Invalid API Key

If you do not specify an API Key, or pass an invalid key, you will receive one of the following responses (depending on the return format):

An array of objects with 3 keys (for JSON calls)

  • MESSAGE
  • FIELD
  • TYPE

Example:

[
    {
        "FIELD":"",
        "MESSAGE":"Invalid API Key.",
        "TYPE":""
    }
]

An XML document with 1-n ERROR nodes each containing error details (for XML calls)

  • MESSAGE
  • FIELD
  • TYPE

Example:

<ERRORS>
    <ERROR>
        <FIELD></FIELD>
        <MESSAGE>Invalid API Key.</MESSAGE>
        <TYPE></TYPE>
    </ERROR>
</ERRORS>

Authenticating

http://slidesix.com/api/SlideSix.cfc?method=authenticateUser


You must first call the authenicateUser() method to retrieve a session token before calling any other method.

Note: Authenticated sessions will expire after 20 minutes of inactivity. You will receive an 'authorization failed' message as a result if you request a method after your session has expired. Please account for this in your code.

Required Parameters:

  • APIKEY (UUID)
  • LOGINUSER (String)
  • LOGINPASSWORD (String) Must be hashed with an md5 algorithim.
  • RETURNTYPE (String - Default JSON)

Returns (If successful):

An object with 6 keys (for JSON calls)

  • REMOTESESSIONTOKEN
  • USERID
  • FIRSTNAME
  • LASTNAME
  • USERBIO
  • PROFILEPICURL

Example:

{
    "LASTNAME":"Sharp",
    "PROFILEPICURL":"http:\/\/slidesix.com\/userFiles\/userImages\/4AB61F12-1AA0-0560-129019D2CFB06A48.jpg",
    "FIRSTNAME":"Todd",
    "REMOTESESSIONTOKEN":"005958CD-D99B-9674-5E28F16FF39639FF",
    "USERID":"4AB61F12-1AA0-0560-129019D2CFB06A48",
    "USERBIO":"This is my bio."
}

An XML document with 6 nodes (for XML calls)

  • REMOTESESSIONTOKEN
  • USERID
  • FIRSTNAME
  • LASTNAME
  • USERBIO
  • PROFILEPICURL

Example:

<USER>
    <LASTNAME>Sharp</LASTNAME>
    <PROFILEPICURL>http://slidesix.com/userFiles/userImages/4AB61F12-1AA0-0560-129019D2CFB06A48.jpg</PROFILEPICURL>
    <FIRSTNAME>Todd</FIRSTNAME>
    <REMOTESESSIONTOKEN>005EBEFB-94C0-7C6C-DF8077909BDF3B83</REMOTESESSIONTOKEN>
    <USERID>4AB61F12-1AA0-0560-129019D2CFB06A48</USERID>
    <USERBIO>This is my bio.</USERBIO>
</USER>

Returns (If authentication unsuccessful):

An array of objects with 3 keys (for JSON calls)

  • MESSAGE
  • FIELD
  • TYPE

Example:

[
    {
        "FIELD":"",
        "MESSAGE":"Authorization failed. You must first call the authenticateUser method to retrieve a remote session token and then you must pass the remote session token with each call to the API.",
        "TYPE":""
    }
]

An XML document with 1-n ERROR nodes each containing error details (for XML calls)

  • MESSAGE
  • FIELD
  • TYPE

Example:

<ERRORS>
    <ERROR>
        <FIELD></FIELD>
        <MESSAGE>
            Authorization failed. You must first call the
            authenticateUser method to retrieve a remote session token and then
            you must pass the remote session token with each call to the API.
        </MESSAGE>
        <TYPE></TYPE>
        <ERROR>
</ERRORS>

Editing A User Profile

http://slidesix.com/api/SlideSix.cfc?method=saveUser


This method allows you to edit the profile information for the current authenticated user.

Please note: User images must be 150 x 150 (px). If they are not they will be coerced to that size. Results of coercion may be undesirable.

Required Parameters:

  • APIKEY (UUID)
  • REMOTESESSIONTOKEN (UUID)
  • USERID (UUID)
  • RETURNTYPE (String - Default JSON)

Optional Parameters:

  • FIRSTNAME (String - 50 Chars)
  • LASTNAME (String - 50 Chars)
  • USERBIO (String - 1000 Chars)
  • USERIMGUPLOAD (File - Limited to the following types)
    • BMP
    • GIF
    • JPEG
    • JPEG 2000
    • JPEG2000
    • JPG
    • PNG
    • PNM
    • RAW
    • TIF
    • TIFF
    • WBMP

Returns (If successful):

An object with 6 keys (for JSON calls) containing the newly updated profile information

  • REMOTESESSIONTOKEN
  • USERID
  • FIRSTNAME
  • LASTNAME
  • USERBIO
  • PROFILEPICURL

Example:

{
    "LASTNAME":"Sharp",
    "PROFILEPICURL":"http:\/\/slidesix.com\/userFiles\/userImages\/4AB61F12-1AA0-0560-129019D2CFB06A48.jpg",
    "FIRSTNAME":"Todd",
    "REMOTESESSIONTOKEN":"005958CD-D99B-9674-5E28F16FF39639FF",
    "USERID":"4AB61F12-1AA0-0560-129019D2CFB06A48",
    "USERBIO":"This is my bio."
}

An XML document with 6 nodes (for XML calls)

  • REMOTESESSIONTOKEN
  • USERID
  • FIRSTNAME
  • LASTNAME
  • USERBIO
  • PROFILEPICURL

Example:

<USER>
    <LASTNAME>Sharp</LASTNAME>
    <PROFILEPICURL>http://slidesix.com/userFiles/userImages/4AB61F12-1AA0-0560-129019D2CFB06A48.jpg</PROFILEPICURL>
    <FIRSTNAME>Todd</FIRSTNAME>
    <REMOTESESSIONTOKEN>005EBEFB-94C0-7C6C-DF8077909BDF3B83</REMOTESESSIONTOKEN>
    <USERID>4AB61F12-1AA0-0560-129019D2CFB06A48</USERID>
    <USERBIO>This is my bio.</USERBIO>
</USER>

Returns (If authentication unsuccessful):

An array of objects with 3 keys (for JSON calls)

  • MESSAGE
  • FIELD
  • TYPE

Example:

[
    {
        "FIELD":"firstName",
        "MESSAGE":"First Name must be 50 chars or less. Current first name is 70 chars.",
        "TYPE":"length"
    },
    {
        "FIELD":"lastName",
        "MESSAGE":"Last Name must be 50 chars or less. Current last name is 70 chars.",
        "TYPE":"length"
    }
]

An XML document with 1-n ERROR nodes each containing error details (for XML calls)

  • MESSAGE
  • FIELD
  • TYPE

Example:

<ERRORS>
    <ERROR>
        <FIELD>firstName</FIELD>
        <MESSAGE>First Name must be 50 chars or less. Current first name is 70 chars.</MESSAGE>
        <TYPE>length</TYPE>
    </ERROR>
    <ERROR>
        <FIELD>lastName</FIELD>
        <MESSAGE>Last Name must be 50 chars or less. Current last name is 70 chars.</MESSAGE>
        <TYPE>length</TYPE>
    </ERROR>
</ERRORS>

Retrieving User Groups

http://slidesix.com/api/SlideSix.cfc?method=getUserGroups


This method allows you to retrieve a collection of groups that the current authenticated user belongs to.

Required Parameters:

  • APIKEY (UUID)
  • REMOTESESSIONTOKEN (UUID)
  • RETURNTYPE (String - Default JSON)

Optional Parameters:

  • None.

Returns (If successful):

An object containing two keys (for JSON calls)

  • COLUMNS (an array of column names for the dataset)
  • DATA (an array of data values that correspond to the same array position in the COLUMNS array)

Example:

{
    "COLUMNS":
    ["GROUPID","GROUPNAME","GROUPDESCRIPTION","CREATEDON","ISGROUPOWNER","GROUPIMAGEURL"],
    "DATA":
    [
        [
            "DC0E8AAE-8CC5-8C46-423D003E269AF415",
            "Test Group",
            "This group is for testing the SlideSix developer API.",
            "January, 22 2009 16:28:24",
            1,
            "http:\/\/slidesix.com\/images\/no_image.jpg"
        ],
        [
            "00635395-B73D-DDBB-F377DDF12B343853",
            "test group",
            "this is my test group.",
            "January, 22 2009 17:08:44",
            1,
            "http:\/\/slidesix.com\/userFiles\/groups\/test-group-4s8uT\/test-group-4s8uT.jpg"
        ]
    ]
}

An XML document containing nodes for each user group (for XML calls)

Example:

<GROUPS>
    <GROUP>
        <CREATEDON>2009-01-22 16:28:24.0</CREATEDON>
        <GROUPDESCRIPTION>This group is for testing the SlideSix developer
            API.</GROUPDESCRIPTION>
        <GROUPID>DC0E8AAE-8CC5-8C46-423D003E269AF415</GROUPID>
        <GROUPIMAGEURL>http://slidesix.com/images/no_image.jpg</GROUPIMAGEURL>
        <GROUPNAME>Test Group</GROUPNAME>
        <ISGROUPOWNER>1</ISGROUPOWNER>
    </GROUP>
    <GROUP>
        <CREATEDON>2009-01-22 17:08:44.0</CREATEDON>
        <GROUPDESCRIPTION>this is my test group.</GROUPDESCRIPTION>
        <GROUPID>00635395-B73D-DDBB-F377DDF12B343853</GROUPID>
        <GROUPIMAGEURL>http://slidesix.com/userFiles/groups/test-group-4s8uT/test-group-4s8uT.jpg</GROUPIMAGEURL>
        <GROUPNAME>test group</GROUPNAME>
        <ISGROUPOWNER>1</ISGROUPOWNER>
    </GROUP>
</GROUPS>

An array of objects with 3 keys (for JSON calls)

  • MESSAGE
  • FIELD
  • TYPE

Example:

[
    {
        "FIELD":"",
        "MESSAGE":"Authorization failed. You must first call the authenticateUser method to retrieve a remote session token and then you must pass the remote session token with each call to the API.",
        "TYPE":""
    }
]

An XML document with 1-n ERROR nodes each containing error details (for XML calls)

  • MESSAGE
  • FIELD
  • TYPE

Example:

<ERRORS>
    <ERROR>
        <FIELD></FIELD>
        <MESSAGE>
            Authorization failed. You must first call the
            authenticateUser method to retrieve a remote session token and then
            you must pass the remote session token with each call to the API.
        </MESSAGE>
        <TYPE></TYPE>
        <ERROR>
</ERRORS>

Creating User Groups

http://slidesix.com/api/SlideSix.cfc?method=createGroup


This method allows you to create a group for the current authenticated user.

Required Parameters:

  • APIKEY (UUID)
  • REMOTESESSIONTOKEN (UUID)
  • GROUPNAME (String - 50 Chars)
  • GROUPDESCRIPTION (String - 2000 Chars)
  • RETURNTYPE (String - Default JSON)

Optional Parameters:

  • GROUPIMAGE (File - Limited to the following types)
    • BMP
    • GIF
    • JPEG
    • JPEG 2000
    • JPEG2000
    • JPG
    • PNG
    • PNM
    • RAW
    • TIF
    • TIFF
    • WBMP

Returns (If successful):

An object containing two keys (for JSON calls)

  • COLUMNS (an array of column names for the dataset)
  • DATA (an array of data values that correspond to the same array position in the COLUMNS array)

Example:

{
    "COLUMNS":
    ["GROUPID","GROUPNAME","GROUPDESCRIPTION","GROUPALIAS","GROUPIMAGEURL","CREATEDON"],
    "DATA":
    [
        [
            "1F12EEF3-DD16-57EE-AD440BA0A2724866",
            "test group",
            "this is my test group.",
            "test-group-WhpUb",
            "http:\/\/slidesix\/userFiles\/groups\/test-group-WhpUb\/test-group-WhpUb.jpg",
            "January, 28 2009 16:09:09"
        ]
    ]
}

An XML document containing details about your newly created group (for XML calls)

Example:

<GROUPS>
    <GROUP>
        <CREATEDON>2009-01-28 16:08:16.0</CREATEDON>
        <GROUPALIAS>test-group-guBGY</GROUPALIAS>
        <GROUPDESCRIPTION>this is my test group.</GROUPDESCRIPTION>
        <GROUPID>1F12229D-04CE-B24F-4DBACFEF53C1ED0D
        </GROUPID>
        <GROUPIMAGEURL>http://slidesix.com/userFiles/groups/test-group-guBGY/test-group-guBGY.jpg</GROUPIMAGEURL>
        <GROUPNAME>test group</GROUPNAME>
    </GROUP>
</GROUPS>

Returns (If unsuccessful):

An array of objects with 3 keys (for JSON calls) containing details on the group that has been created.

  • FIELD
  • MESSAGE
  • TYPE

Example:

[
    {
        "FIELD":"groupName",
        "MESSAGE":"Group name is required",
        "TYPE":"required"
    }
]

An XML document with 1-n ERROR nodes each containing error details (for XML calls)

  • FIELD
  • MESSAGE
  • TYPE

Example:

<ERRORS>
    <ERROR>
        <FIELD>groupName</FIELD>
        <MESSAGE>Group name is required</MESSAGE>
        <TYPE>required</TYPE>
    </ERROR>
</ERRORS>

Modifying User Groups

http://slidesix.com/api/SlideSix.cfc?method=saveGroup


This method allows you to edit a group that the current authenticated user is the owner of.

Required Parameters:

  • APIKEY (UUID)
  • GROUPID (UUID)

Optional Parameters:

  • GROUPNAME (String - 50 Chars)
  • GROUPDESCRIPTION (String - 2000 Chars)
  • REMOTESESSIONTOKEN (UUID)
  • RETURNTYPE (String - Default JSON)
  • GROUPIMAGE (File - Limited to the following types)
    • BMP
    • GIF
    • JPEG
    • JPEG 2000
    • JPEG2000
    • JPG
    • PNG
    • PNM
    • RAW
    • TIF
    • TIFF
    • WBMP

Returns (If successful):

An object containing two keys (for JSON calls) containing details on the group that has been modified.

  • COLUMNS (an array of column names for the dataset)
  • DATA (an array of data values that correspond to the same array position in the COLUMNS array)

Example:

{
    "COLUMNS":
    ["GROUPID","GROUPNAME","GROUPDESCRIPTION","GROUPALIAS","GROUPIMAGEURL","CREATEDON"],
    "DATA":
    [
        [
            "1F12EEF3-DD16-57EE-AD440BA0A2724866",
            "test group",
            "this is my test group that has been modified.",
            "test-group-WhpUb",
            "http:\/\/slidesix\/userFiles\/groups\/test-group-WhpUb\/test-group-WhpUb.jpg",
            "January, 28 2009 16:09:09"
        ]
    ]
}

An XML document containing details about your newly created group (for XML calls)

Example:

<GROUPS>
    <GROUP>
        <CREATEDON>2009-01-28 16:08:16.0</CREATEDON>
        <GROUPALIAS>test-group-guBGY</GROUPALIAS>
        <GROUPDESCRIPTION>this is my test group that has been modified.</GROUPDESCRIPTION>
        <GROUPID>1F12229D-04CE-B24F-4DBACFEF53C1ED0D
        </GROUPID>
        <GROUPIMAGEURL>http://slidesix.com/userFiles/groups/test-group-guBGY/test-group-guBGY.jpg</GROUPIMAGEURL>
        <GROUPNAME>test group</GROUPNAME>
    </GROUP>
</GROUPS>

Returns (If unsuccessful):

An array of objects with 3 keys (for JSON calls)

  • FIELD
  • MESSAGE
  • TYPE

Example:

[
    {
        "FIELD":"groupName",
        "MESSAGE":"Group name is required",
        "TYPE":"required"
    }
]

An XML document with 1-n ERROR nodes each containing error details (for XML calls)

  • FIELD
  • MESSAGE
  • TYPE

Example:

<ERRORS>
    <ERROR>
        <FIELD>groupName</FIELD>
        <MESSAGE>Group name is required</MESSAGE>
        <TYPE>required</TYPE>
    </ERROR>
</ERRORS>

Retrieving Presentations

http://slidesix.com/api/SlideSix.cfc?method=getSlideShows


This method allows you to search by user ID, search string, tag or group name.

You may call this method to retrieve presentations with or without first authenticating as a registered user.

When searching by user ID, if the user ID is equal to the current authenticated user then all presentations are returned (including non-published and private presentations). Otherwise, only public presentations that have been published are returned.

If you do not pass any arguments your result set is limited to the 50 most recent presentations.

Required Parameters:

  • APIKEY (UUID)
  • REMOTESESSIONTOKEN (UUID)
  • RETURNTYPE (String - Default JSON)

Optional Parameters:

  • CREATEDBY (UUID) UserID of the presentation creator
  • SEARCHSTRING (String) Will search in title, slide contents and abstract for the given string.
  • TAG (String)
  • GROUPNAME (String)

Returns (If successful):

An object containing two keys (for JSON calls)

  • COLUMNS (an array of column names for the dataset)
  • DATA (an array of data values that correspond to the same array position in the COLUMNS array)

Example:

{
    "COLUMNS":
        ["SLIDESHOWID","SLIDESHOWTITLE","ABSTRACT","SLIDESHOWALIAS","LASTPUBLISHEDDATE",
            "GROUPNAME","GROUPID","CREATEDBYUSERID","CREATEDBYUSERNAME","VIEWS","EMBEDDEDVIEWS",
            "FAVORITES","EMBEDCODE","ISIMPORTING","ISPUBLISHING","HASERRORS","THUMBNAILIMAGEURL"
        ],
    "DATA":
        [
            ["EE82F203-2B17-1385-745C003C4B694D01","SlideSix API Test",
            "The purpose of this presentation is to test the SlideSix developer API.",
            "SlideSix-API-Test","January, 22 2009 16:26:05","Test Group",
            "DC0E8AAE-8CC5-8C46-423D003E269AF415","4AB61F12-1AA0-0560-129019D2CFB06A48",
            "cfsilence",0,0,0,
            "<object height=\"425\" width=\"550\"><param name=\"movie\" value=\"http:\/\/slidesix.com\/viewer\/SlideSixViewer.swf?alias=SlideSix-Executive-Summary-vZwcR\" \/><param name=\"menu\" value=\"false\"\/><param name=\"scale\" value=\"noScale\"\/><param name=\"allowFullScreen\" value=\"true\"\/><param name=\"allowScriptAccess\" value=\"always\" \/><embed src=\"http:\/\/slidesix.com\/viewer\/SlideSixViewer.swf?alias=SlideSix-Executive-Summary-vZwcR\" allowscriptaccess=\"always\" allowFullScreen=\"true\" height=\"425\" width=\"550\" type=\"application\/x-shockwave-flash\" \/><\/object>",
            0,0,0,"http:\/\/slidesix\/presentations\/SlideSix-Executive-Summary-vZwcR\/thumbs\/EE82F203-2B17-1385-745C003C4B694D01.jpg"
            ]
        ]
}

An XML document with 1 node for each presentation that matches your search criteria (for XML calls)

Example:

<SLIDESHOWS>
    <SLIDESHOW>
        <ABSTRACT>The purpose of this presentation is to test the SlideSix developer API.</ABSTRACT>
        <CREATEDBYUSERID>4AB61F12-1AA0-0560-129019D2CFB06A48</CREATEDBYUSERID>
        <CREATEDBYUSERNAME>cfsilence</CREATEDBYUSERNAME>
        <EMBEDCODE>
            <![CDATA[
                <object height="425" width="550">
                    <param name="movie" value="http://slidesix.com/viewer/SlideSixViewer.swf?alias=SlideSix-Executive-Summary-vZwcR" />
                    <param name="menu" value="false"/><param name="scale" value="noScale"/><param name="allowFullScreen" value="true"/>
                    <param name="allowScriptAccess" value="always" />
                    <embed src="http://slidesix.com/viewer/SlideSixViewer.swf?alias=SlideSix-Executive-Summary-vZwcR" allowscriptaccess="always" allowFullScreen="true" height="425" width="550" type="application/x-shockwave-flash" />
                </object>
            ]]>
        </EMBEDCODE>
        <EMBEDDEDVIEWS>0</EMBEDDEDVIEWS>
        <FAVORITES>0</FAVORITES>
        <GROUPID>DC0E8AAE-8CC5-8C46-423D003E269AF415</GROUPID>
        <GROUPNAME>Test Group</GROUPNAME>
        <HASERRORS>0</HASERRORS>
        <ISIMPORTING>0</ISIMPORTING>
        <ISPUBLISHING>0</ISPUBLISHING>
        <LASTPUBLISHEDDATE>2009-01-22 16:26:05.0</LASTPUBLISHEDDATE>
        <SLIDESHOWALIAS>SlideSix-API-Test</SLIDESHOWALIAS>
        <SLIDESHOWID>EE82F203-2B17-1385-745C003C4B694D01</SLIDESHOWID>
        <SLIDESHOWTITLE>SlideSix API Test</SLIDESHOWTITLE>
        <THUMBNAILIMAGEURL>
            http://slidesix.com/presentations/SlideSix-Executive-Summary-vZwcR/thumbs/EE82F203-2B17-1385-745C003C4B694D01.jpg
        </THUMBNAILIMAGEURL>
        <VIEWS>0</VIEWS>
    </SLIDESHOW>
</SLIDESHOWS>

Creating Presentations

http://slidesix.com/api/SlideSix.cfc?method=createPresentation


This method allows you to create presentations. The current authenticated user will be associated with the presentation. The presentation will be auto-published after it is converted. Note: You must hash the SlideShow Password (if provided) with an MD5 algorithim. If you fail to do this the user may be unable to view their presentation online.

Required Parameters:

  • APIKEY (UUID)
  • REMOTESESSIONTOKEN (UUID)
  • SLIDESHOWIMPORTFILE (PPT, PPS, MOV, PDF, ODP or SXI File - Max 50mb)
  • TITLE (String - 255 Chars)
  • ABSTRACT (String - 500 Chars)
  • SHOWNOTES (Boolean - Default True) Should imported notes be displayed?
  • NOTIFYCOMMENTS (Boolean - Default True) Should SlideSix email the presenter when comments are posted?
  • RETURNTYPE (String - Default JSON)

Optional Parameters:

  • RECORDEDURL (String - 1000 chars)
  • SLIDESHOWATTACHMENT (ZIP File - Max 1mb)
  • SLIDESHOWPASSWORD (String - 50 Chars)
    • Will make this presentation private. Must be hashed with an MD5 algorithim.
  • REPEATSLIDESHOWPASSWORD (String - Required if SLIDESHOWPASSWORD is passed - 50 Chars)
    • Must be hashed with an MD5 algorithim and must match SLIDESHOWPASSWORD
  • GROUPID (UUID) ID of group to associate preso with (user must belong to that group)
  • TAGS (String) List of comma separated tags.

Returns (If successful):

An object containing two keys (for JSON calls) containing data about the newly created presentation.

  • COLUMNS (an array of column names for the dataset)
  • DATA (an array of data values that correspond to the same array position in the COLUMNS array)

Example:

{
    "COLUMNS":
        ["SLIDESHOWID","SLIDESHOWTITLE","ABSTRACT","SLIDESHOWALIAS","LASTPUBLISHEDDATE","GROUPNAME","GROUPID","CREATEDBYUSERID",
        "CREATEDBYUSERNAME","VIEWS","EMBEDDEDVIEWS","FAVORITES","EMBEDCODE","ISIMPORTING","ISPUBLISHING","HASERRORS",
        "THUMBNAILIMAGEURL"],
    "DATA":
    [
        [
            "1F3754C1-F28A-F06E-12AB8790E59A1B68",
            "This is a remote API test.",
            "This is a test of the remote API.",
            "This-is-a-remote-API-test",
            "January, 28 2009 16:49:20",
            null,
            null,
            "4AB61F12-1AA0-0560-129019D2CFB06A48",
            "cfsilence",
            0,
            0,
            0,
            "<object height=\"425\" width=\"550\"><param name=\"movie\" value=\"http:\/\/slidesix.com\/viewer\/SlideSixViewer.swf?alias=This-is-a-remote-API-test\" \/><param name=\"menu\" value=\"false\"\/><param name=\"scale\" value=\"noScale\"\/><param name=\"allowFullScreen\" value=\"true\"\/><param name=\"allowScriptAccess\" value=\"always\" \/><embed src=\"http:\/\/slidesix.com\/viewer\/SlideSixViewer.swf?alias=This-is-a-remote-API-test\" allowscriptaccess=\"always\" allowFullScreen=\"true\" height=\"425\" width=\"550\" type=\"application\/x-shockwave-flash\" \/><\/object>",
            0,
            0,
            0,
            "http:\/\/slidesix\/presentations\/This-is-a-remote-API-test\/thumbs\/1F3754C1-F28A-F06E-12AB8790E59A1B68.jpg"
        ]
    ]
}

An XML document containing details about your newly created presentation (for XML calls)

Example:

<SLIDESHOWS>
    <SLIDESHOW>
        <ABSTRACT>This is a test of the remote API.</ABSTRACT>
        <CREATEDBYUSERID>4AB61F12-1AA0-0560-129019D2CFB06A48
        </CREATEDBYUSERID>
        <CREATEDBYUSERNAME>cfsilence</CREATEDBYUSERNAME>
        <EMBEDCODE><![CDATA[<object height="425" width="550"><param name="movie" value="http://slidesix.com/viewer/SlideSixViewer.swf?alias=This-is-a-remote-API-test" /><param name="menu" value="false"/><param name="scale" value="noScale"/><param name="allowFullScreen" value="true"/><param name="allowScriptAccess" value="always" /><embed src="http://slidesix.com/viewer/SlideSixViewer.swf?alias=This-is-a-remote-API-test" allowscriptaccess="always" allowFullScreen="true" height="425" width="550" type="application/x-shockwave-flash" /></object>]]></EMBEDCODE>
        <EMBEDDEDVIEWS>0</EMBEDDEDVIEWS>
        <FAVORITES>0</FAVORITES>
        <GROUPID></GROUPID>
        <GROUPNAME></GROUPNAME>
        <HASERRORS>0</HASERRORS>
        <ISIMPORTING>0</ISIMPORTING>
        <ISPUBLISHING>0</ISPUBLISHING>
        <LASTPUBLISHEDDATE>2009-01-28 16:49:27.0</LASTPUBLISHEDDATE>
        <SLIDESHOWALIAS>This-is-a-remote-API-test
        </SLIDESHOWALIAS>
        <SLIDESHOWID>1F37BDFD-BB72-C186-D07ADA41E2236565</SLIDESHOWID>
        <SLIDESHOWTITLE>This is a remote API test.</SLIDESHOWTITLE>
        <THUMBNAILIMAGEURL>
            http://slidesix.com/presentations/This-is-a-remote-API-test/thumbs/1F37BDFD-BB72-C186-D07ADA41E2236565.jpg
        </THUMBNAILIMAGEURL>
        <VIEWS>0</VIEWS>
    </SLIDESHOW>
</SLIDESHOWS>

Returns (If data is invalid):

An array of objects with 3 Keys(for JSON calls)

  • FIELD
  • TYPE
  • MESSAGE

Example:

[
    {
    "FIELD":"slideShowImportFile",
    "MESSAGE":"You must specify a file that you'd like to convert.",
    "TYPE":"required"
    }
]

An XML document with 1 to N children containing 3 nodes (for XML calls)

  • FIELD
  • TYPE
  • MESSAGE

Example:

<ERRORS>
    <ERROR>
        <FIELD>slideShowImportFile</FIELD>
        <TYPE>required</TYPE>
        <MESSAGE>
            You must specify a file that you'd like to convert.
        </MESSAGE>
    </ERROR>
</ERRORS>



Support

For help with this API, please use our Contact form. Developer forums are coming soon.