click

Frontend Version: 0.28.0
API Version: 0.1.8
Icon

Emoticon Library API

> Home > Fun
The Resplace Emoticon Library has an easy to use API which is built around XML, XML (Extensible Markup Language) is a powerful language for creating structured documents, from these structured documents you can obtain specific data for a particular purpose such as in our case, fetching emoticons!
You can fetch these XML documents and obtain specific information regarding this library, you could use this information to then provide a hook between your website and/or software and this emoticon library. For example we have created a SMF forums plugin which enables you to use emoticons from this library in your forums software!
Download Emoticon Library plugin for SMF.

We are in the process of creating generic examples in varoius languages so you have a clear understanding of how to use this API, we are also in the process of creating some API documentation which is shown below.

The Basics...

The API is split up into several different Request types, depending on the information you require you will make these different requests, its normal to have to use more than one request to get the information you are after, these different request types are explained below.

Request Types


Emoticon Category List

Description: Fetches the full list of categorys.
URI: http://fun.resplace.net/Emoticons/api/get.php?req=CategoryList
Structure: <emoticons>
    <category>
        <id></id>
        <dir></dir>
        <name><![CDATA[]]></name>
        <desc><![CDATA[]]></desc>
        <tags><![CDATA[]]></tags>
        <adult></adult>
        <count></count>
        <catimg><![CDATA[]]></catimg>
    </category>
</emoticons>
Entitys:
[ id ] Gives the unique id of the category.
[ dir ] Gives the directory name (which is also the category name used for links), used for linking to the category (http://fun.resplace.net/Emoticons/category/[dir]) or linking directly to the emoticon (http://fun.resplace.net/Emoticons/smiley/[dir]/filename.ext)
[ name ] Gives the display name of the category, useful for display on the screen. The difference between this and [ dir ] is [ name ] will provide a screen readable name, where [ dir ] is sanitised for links and directory naming.
[ desc ] Gives description of the category.
[ tags ] Gives the category's tags in the format "tag, tag2, tag3".
[ adult ] If the category is for adults only this will return 1, if it is not adult orientated then 0 is returned.
[ count ] Gives the total number of emoticons within the category.
[ catimg ] Gives the category front image.


Emoticon Set List

Description: Fetches the full list of sets.
URI: http://fun.resplace.net/Emoticons/api/get.php?req=SetList
Structure: <emoticons>
    <set>
        <id></id>
        <dir></dir>
        <name><![CDATA[]]></name>
        <desc><![CDATA[]]></desc>
        <tags><![CDATA[]]></tags>
        <adult></adult>
        <count></count>
        <setimg><![CDATA[]]></setimg>
    </set>
</emoticons>
Entitys:
[ id ] Gives the unique id of the set.
[ dir ] Gives the directory name, used for linking to the set (http://fun.resplace.net/Emoticons/smiley-sets/[dir]).
[ name ] Gives the display name of the set, useful for display on the screen. The difference between this and [ dir ] is [ name ] will provide a screen readable name, where [ dir ] is sanitised for links and set naming.
[ desc ] Gives description of the set.
[ tags ] Gives the set's tags in the format "tag, tag2, tag3".
[ adult ] If the set is for adults only this will return 1, if it is not adult orientated then 0 is returned.
[ count ] Gives the total number of emoticons within the set.
[ setimg ] Gives the set front image.


Emoticon By Category

Description: Fetches a list of emoticons from a category reference (id), returns the emoticons and category information.
URI: http://fun.resplace.net/Emoticons/api/get.php?req=EmoticonsByCategory&id={id}&p={page}
URI Schema: id - The unique id of the category to fetch.
p - The page number to read from 1 and up.
Structure: <emoticons>
    <emoticon>
        <id></id>
        <filename><![CDATA[]]></filename>
        <name><![CDATA[]]></name>
        <desc><![CDATA[]]></desc>
        <tags><![CDATA[]]></tags>
        <width></width>
        <height></height>
        <user><![CDATA[]]></user>
        <catid></catid>
        <setid></setid>
        <emotemaker></emotemaker>
        <transparency></transparency>
        <animated></animated>
        <adult></adult>
    </emoticon>
    <information>
        <exists></exists>
        <pages></pages>
        <catname><![CDATA[]]></catname>
        <catdir></catdir>
    </information>
</emoticons>
<emoticon> used for information about each emoticon in the category, returns useful information shown below.
<information> Only one Entity exists, gives some useful information about the category were fetching so we dont have to make a seperate call.
Entitys for <emoticon>:
[ id ] Gives the unique id of the emoticon.
[ filename ] Gives the filename of the emoticon including the extension, useful when making a direct link to the emoticon file (http://fun.resplace.net/Emoticons/directory/[filename]) or linking to the emoticon web page (http://fun.resplace.net/Emoticons/smiley/directory/[filename])
Note: You can use the <information> entitys to get the category directory to setup the full path! See below.
[ name ] Gives the display name of the emoticon, useful for display on the screen.
[ desc ] Gives the emoticon description.
[ tags ] Gives the emoticons tags, in the format "tag, tag2, tag3".
[ width ] Gives the emoticons width in pixels. (Will not return a correct value - WIP.)
[ height ] Gives the emoticons height in pixels. (Will not return a correct value - WIP.)
[ user ] Gives the username of the person who uploaded the emoticon.
[ catid ] Gives the category id the emoticon belongs in.
[ setid ] Gives the set id the emoticon belongs in.
[ emotemaker ] This returns 1 if the emoticon was created using EmoteMaker, or 0 if it wasn't.
[ transparency ] If the emoticon has transparency then this returns 1, else it will be 0. (Will not return a correct value - WIP.)
[ animated ] If the emoticon is animated this will return 1, if it is not then it returns 0. (Will not return a correct value - WIP.)
[ adult ] If the emoticon is of adult nature (sexual - bad language - blood) then this will return 1, else it will be 0. (Will not return a correct value - WIP.)
Entitys for <information>:
[ exists ] Gives a 1 or 0 to indicate if the category exists (1) or doesnt exists (0), you should check this before doing anything else with the XML.
[ pages ] Returns how many pages of emoticons there are.
[ catname ] Gives the category name, useful for printing on the screen.
[ catdir ] Gives the directory name (which is also the category name used for links), used for linking to the category (http://fun.resplace.net/Emoticons/category/[dir]) or linking directly to the emoticon (http://fun.resplace.net/Emoticons/smiley/[dir]/filename.ext)


Emoticon By Set

Description: Fetches a list of emoticons from a set reference (id), returns the emoticons and set information.
URI: http://fun.resplace.net/Emoticons/api/get.php?req=EmoticonsBySet&id={id}&p={page}
URI Schema: id - The unique id of the category to fetch.
p - The page number to read from 1 and up.
Structure: <emoticons>
    <emoticon>
        <id></id>
        <filename><![CDATA[]]></filename>
        <name><![CDATA[]]></name>
        <desc><![CDATA[]]></desc>
        <tags><![CDATA[]]></tags>
        <width></width>
        <height></height>
        <user><![CDATA[]]></user>
        <catid></catid>
        <setid></setid>
        <emotemaker></emotemaker>
        <transparency></transparency>
        <animated></animated>
        <adult></adult>
    </emoticon>
    <information>
        <exists></exists>
        <pages></pages>
        <setname><![CDATA[]]></setname>
        <catdir></catdir>
    </information>
</emoticons>
<emoticon> used for information about each emoticon in the category, returns useful information shown below.
<information> Only one Entity exists, gives some useful information about the set were fetching so we dont have to make a seperate call.
Entitys for <emoticon>:
[ id ] Gives the unique id of the emoticon.
[ filename ] Gives the filename of the emoticon including the extension, useful when making a direct link to the emoticon file (http://fun.resplace.net/Emoticons/directory/[filename]) or linking to the emoticon web page (http://fun.resplace.net/Emoticons/smiley/directory/[filename])
Note: You can use the <information> entitys to get the category directory to setup the full path! See below.
[ name ] Gives the display name of the emoticon, useful for display on the screen.
[ desc ] Gives the emoticon description.
[ tags ] Gives the emoticons tags, in the format "tag, tag2, tag3".
[ width ] Gives the emoticons width in pixels. (Will not return a correct value - WIP.)
[ height ] Gives the emoticons height in pixels. (Will not return a correct value - WIP.)
[ user ] Gives the username of the person who uploaded the emoticon.
[ catid ] Gives the category id the emoticon belongs in.
[ setid ] Gives the set id the emoticon belongs in.
[ emotemaker ] This returns 1 if the emoticon was created using EmoteMaker, or 0 if it wasn't.
[ transparency ] If the emoticon has transparency then this returns 1, else it will be 0. (Will not return a correct value - WIP.)
[ animated ] If the emoticon is animated this will return 1, if it is not then it returns 0. (Will not return a correct value - WIP.)
[ adult ] If the emoticon is of adult nature (sexual - bad language - blood) then this will return 1, else it will be 0. (Will not return a correct value - WIP.)
Entitys for <information>:
[ exists ] Gives a 1 or 0 to indicate if the category exists (1) or doesnt exists (0), you should check this before doing anything else with the XML.
[ pages ] Returns how many pages of emoticons there are.
[ catname ] Gives the category name, useful for printing on the screen.
[ catdir ] Gives the directory name (which is also the category name used for links), used for linking to the category (http://fun.resplace.net/Emoticons/category/[dir]) or linking directly to the emoticon (http://fun.resplace.net/Emoticons/smiley/[dir]/filename.ext)


Get Emoticon from ID

Description: Fetches information about an emoticon from it's ID.
URI: http://fun.resplace.net/Emoticons/api/get.php?req=Emoticon&id={id}
URI Schema: id - The unique id of the emoticon to fetch.
Structure: <emoticons>
    <emoticon>
        <id></id>
        <filename><![CDATA[]]></filename>
        <name><![CDATA[]]></name>
        <desc><![CDATA[]]></desc>
        <tags><![CDATA[]]></tags>
        <width></width>
        <height></height>
        <user><![CDATA[]]></user>
        <catid></catid>
        <setid></setid>
        <emotemaker></emotemaker>
        <transparency></transparency>
        <animated></animated>
        <adult></adult>
    </emoticon>
    <information>
        <exists></exists>
        <catname><![CDATA[]]></catname>
        <catdir></catdir>
    </information>
</emoticons>
<emoticon> Only one Entity should be returned, used for information about the emoticon you are calling, returns useful information shown below.
<information> Only one Entity should be returned, gives some useful information about the category the emote is from and whether or not the emote you are fetching actually exists, this is so you do not have to make seperate calls.
Entitys for <emoticon>:
[ id ] Gives the unique id of the emoticon. Although this was sent in the request (Possible deprecation in next review.)
[ filename ] Gives the filename of the emoticon including the extension, useful when making a direct link to the emoticon file (http://fun.resplace.net/Emoticons/directory/[filename]) or linking to the emoticon web page (http://fun.resplace.net/Emoticons/smiley/directory/[filename])
Note: You can use the <information> entitys to get the category directory to setup the full path! See below.
[ name ] Gives the display name of the emoticon, useful for display on the screen.
[ desc ] Gives the emoticon description.
[ tags ] Gives the emoticons tags, in the format "tag, tag2, tag3".
[ width ] Gives the emoticons width in pixels. (Will not return a correct value - WIP.)
[ height ] Gives the emoticons height in pixels. (Will not return a correct value - WIP.)
[ user ] Gives the username of the person who uploaded the emoticon.
[ catid ] Gives the category id the emoticon belongs in.
[ setid ] Gives the set id the emoticon belongs in.
[ emotemaker ] This returns 1 if the emoticon was created using EmoteMaker, or 0 if it wasn't.
[ transparency ] If the emoticon has transparency then this returns 1, else it will be 0. (Will not return a correct value - WIP.)
[ animated ] If the emoticon is animated this will return 1, if it is not then it returns 0. (Will not return a correct value - WIP.)
[ adult ] If the emoticon is of adult nature (sexual - bad language - blood) then this will return 1, else it will be 0. (Will not return a correct value - WIP.)
Entitys for <information>:
[ exists ] Gives a 1 or 0 to indicate if the emoticon exists (1) or doesnt exists (0), you should check this before doing anything else with the XML.
[ catname ] Gives the category name for the emoticon, useful for printing on the screen.
[ catdir ] Gives the directory name of the category, used for linking to the directory page (http://fun.resplace.net/Emoticons/?category=[catdir]) or linking directly to the emoticon (http://fun.resplace.net/Emoticons/[catdir]/filename.ext)

Emoticon Library Version 0.8.3 - API Version 0.1.2

Find Something:




Latest News:


Latest Blog:

xx
550 SC-001 outlook.com rejecting mail for policy reasons – How to remove your server from the blacklist!
[15-10-15 15:46pm]
This article was updated on 15/10/2015 Check if your IP is on a mailing blacklist using our bla...
View Full Article.

xx
“Access Denied” troubles with files and folders in Windows
[02-06-14 23:06pm]
Good Evening, Windows has this really nasty feature called “user permissions”, well its not all nas...
View Full Article.

xx
Author of Game Of Thrones still uses DOS - No-one told him you can turn auto-correct off!
[17-05-14 21:44pm]
I read something absolutely hilarious on BBC news today, the author of Game Of Thrones (George RR Ma...
View Full Article.

xx
PHP: using UTF8 for CSV creation
[17-04-14 08:30am]
If your generating a CSV with PHP you may have stumbled upon the same problem as me where any specia...
View Full Article.

xx
How to update OpenSSL to fix Heartbleed Vulnerability WHM/Plesk/Centos Servers
[12-04-14 09:55am]
So I’m sure everyone has heard about the Heartbleed vulnerability in OpenSSL, it appears SSL has not...
View Full Article.

xx
PHP: Find the file where a class was defined
[09-04-14 08:00am]
It's annoying when you are looking for a particular class in a system you are not very familiar with...
View Full Article.


Facebook Page:


Share Page



Copyright © 2000 - 2017 resplace.net
Tenebris Lemma (Dark Theme)

Last Modified: 12-11-2011 19:46:11 GMT - Constructed in: 0.05512