AD: /* Output Fields */

2020-03-26T08:41:12Z

Output Fields

← Older revision		Revision as of 08:41, 26 March 2020
Line 186:		Line 186:
	! Description		! Description
	\|-		\|-
	\| ''Array of'' [Protocols/WebAPI/Reference/Types#AIMFightUser AIMFightUser]		\| ''Array of'' [[Protocols/WebAPI/Reference/Types#AIMFightUser\|AIMFightUser]]
	\| users		\| users
	\| AIM Fight User information		\| AIM Fight User information

AD: Created page with "{{Protocols/WebAPI}} This page is about WebAPI misc methods, in a series for the WebAPI reference manual..."

2020-03-26T08:39:25Z

Created page with "{{Protocols/WebAPI}} This page is about WebAPI misc methods, in a series for the WebAPI reference manual..."

New page

{{Protocols/WebAPI}}

This page is about WebAPI misc [[Protocols/WebAPI/Reference/Methods|methods]], in a series for the WebAPI [[Protocols/WebAPI/Reference|reference manual]].

== getVanityInfo ==

Retrieve the vanity information for a user.

URL: GET http://api.oscar.nina.bz/aim/getVanityInfo

=== Input Parameters ===

{| class="wikitable"
! Type
! Field
! Description
|-
| [[Protocols/WebAPI/Reference/Enumeration#Format|Format]]
| f
| '' [Required]'' The format of the data returned
|-
| String
| c
| JSONP callback
|-
| String
| r
| Request id
|-
| String
| k
| the AIM Web Key from http://dev.nina.bz/aim - use the same key for all calls
|-
| String
| aimsid
| Use an AIM Session Id from the [[Protocols/WebAPI/Reference/Methods/Session#startSession|startSession]] call for authentication - k is not required
|-
| String
| a
| Use an NINA Authentication Token for authentication, from the [[Protocols/WebAPI/Auth/WebApp/getToken|getToken]] call
|-
| Integer
| ts
| Epoch timestamp - clientLogin required parameter
|-
| String
| sig_sha256
| Signature - clientLogin required parameter.
|}

=== Output Fields ===

{| class="wikitable"
! Type
! Field
! Description
|-
| Integer
| imsSent
| Number of IMs the user has sent during the collection interval
|-
| Integer
| imsReceived
| Number of IMs the user has received during the collection interval
|-
| Integer
| awayMsgs
| Number of away messages set during the collection interval
|-
| Integer
| onlineTime
| Minutes online
|-
| Integer
| collectionInterval
| Minutes since the first time data was collected
|}

=== Common Status Codes ===

{| class="wikitable"
! Status Code
! Description
|-
| 200
| Success
|-
| 401
| Authorization required
|-
| 460
| Missing required parameter
|-
| 462
| Parameter error
|}

=== Common Status Detail Codes ===

{| class="wikitable"
! Status Detail Code
! Description
|-
| 1004
| Referer used to create token doesn't match referer of call
|-
| 1014
| Signature is bad, see the signature notes of [[Protocols/WebAPI/Reference/Methods/Session#startSession|startSession]]
|}

=== Sample JSON Output ===

<pre>
{"response":{
"statusCode":200,
"statusText":"Ok",
"requestId":"123",
"data":{
"imsSent":10,
"imsReceived":20,
"awayMsgs":30,
"onlineTime":30,
"collectionInterval":300
}
}
}
</pre>

=== Sample XML Output ===

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<statusCode>200</statusCode>
<statusText>Ok</statusText>
<requestId>123</requestId>
<data>
<imsSent>10</imsSent>
<imsReceived>20</imsReceived>
<awayMsgs>30</awayMsgs>
<onlineTime>30</onlineTime>
<collectionInterval>300</collectionInterval>
</data>
</response>
</pre>

== getAIMFight ==

Get the AIM Fight score and rank for multiple aimIds

URL: GET http://api.oscar.nina.bz/aim/getAIMFight

=== Input Parameters ===

{| class="wikitable"
! Type
! Field
! Description
|-
| [[Protocols/WebAPI/Reference/Enumeration#Format|Format]]
| f
| '' [Required]'' The format of the data returned
|-
| String
| c
| JSONP callback
|-
| String
| r
| Request id
|-
| String
| k
| ''[Required]'' either an AIM Web Key or AIM Presence Key from http://dev.nina.bz/aim
|-
| String
| t
| Target aimIds, multiple t parameters are allowed
|}

=== Output Fields ===

{| class="wikitable"
! Type
! Field
! Description
|-
| ''Array of'' [Protocols/WebAPI/Reference/Types#AIMFightUser AIMFightUser]
| users
| AIM Fight User information
|}

=== Common Status Codes ===

{| class="wikitable"
! Status Code
! Description
|-
| 200
| Success
|-
| 460
| Missing required parameter
|-
| 462
| Parameter error
|}

=== Sample JSON Output ===

<pre>
{"response":{
"statusCode":200,
"statusText":"Ok",
"requestId":"123",
"data":{
"users":[
{
"aimId":"chattingchuck",
"score":10000000,
"rank":1
}
]
}
}
}
</pre>

=== Sample XML Output ===

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<statusCode>200</statusCode>
<statusText>Ok</statusText>
<requestId>123</requestId>
<data>
<users>
<user>
<aimId>chattingchuck</aimId>
<score>10000000</score>
<rank>1</rank>
</user>
</users>
</data>
</response>
</pre>

== addTempBuddy ==

Add a temporary buddy for presence updates

URL: GET http://api.oscar.nina.bz/aim/addTempBuddy

=== Input Parameters ===

{| class="wikitable"
! Type
! Field
! Description
|-
| [[Protocols/WebAPI/Reference/Enumeration#Format|Format]]
| f
| '' [Required]'' The format of the data returned
|-
| String
| c
| JSONP callback
|-
| String
| r
| Request id
|-
| String
| aimsid
| ''[Required]'' Use an AIM Session Id from the [[Protocols/WebAPI/Reference/Methods/Session#startSession|startSession]] call for authentication
|-
| String
| t
| ''[Required]'' buddy name, multiple t= parameters are allowed
|}

=== Common Status Codes ===

{| class="wikitable"
! Status Code
! Description
|-
| 200
| Success
|-
| 401
| Authorization required
|-
| 460
| Missing required parameter
|-
| 462
| Parameter error
|}

'''Example:''' http://api.oscar.nina.bz/aim/addTempBuddy?f=json&c=callback&aimsid=AIMSID&t=msft@relegence.com

=== Sample JSON Output ===

<pre>
{"response":{
"statusCode":200,
"statusText":"Ok",
"requestId":"123",
"data":{
}
}
}
</pre>

=== Sample XML Output ===

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<statusCode>200</statusCode>
<statusText>Ok</statusText>
<requestId>123</requestId>
<data>
</data>
</response>
</pre>

== removeTempBuddy ==

Remove a temporary buddy for presence updates

URL: GET http://api.oscar.nina.bz/aim/removeTempBuddy

=== Input Parameters ===

{| class="wikitable"
! Type
! Field
! Description
|-
| [[Protocols/WebAPI/Reference/Enumeration#Format|Format]]
| f
| '' [Required]'' The format of the data returned
|-
| String
| c
| JSONP callback
|-
| String
| r
| Request id
|-
| String
| aimsid
| ''[Required]'' Use an AIM Session Id from the [[Protocols/WebAPI/Reference/Methods/Session#startSession|startSession]] call for authentication
|-
| String
| t
| ''[Required]'' Buddy name, multiple t= parameters are allowed
|}

=== Common Status Codes ===

{| class="wikitable"
! Status Code
! Description
|-
| 200
| Success
|-
| 401
| Authorization required
|-
| 460
| Missing required parameter
|-
| 462
| Parameter error
|}

'''Example:''' http://api.oscar.nina.bz/aim/removeTempBuddy?f=json&c=callback&aimsid=AIMSID&t=msft@relegence.com

=== Sample JSON Output ===

<pre>
{"response":{
"statusCode":200,
"statusText":"Ok",
"requestId":"123",
"data":{
}
}
}
</pre>

=== Sample XML Output ===

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<statusCode>200</statusCode>
<statusText>Ok</statusText>
<requestId>123</requestId>
<data>
</data>
</response>
</pre>

== getHostBuddyInfo ==

Get host buddy info. Only valid format supported is html.

URL: GET http://api.oscar.nina.bz/aim/getHostBuddyInfo

=== Input Parameters ===

{| class="wikitable"
! Type
! Field
! Description
|-
| String
| f
| ''[Required]'' Only f=html is supported
|-
| String
| k
| the AIM Web Key from http://dev.nina.bz/aim - use the same key for all calls
|-
| String
| aimsid
| Use an AIM Session Id from the [[Protocols/WebAPI/Reference/Methods/Session#startSession|startSession]] call for authentication - k is not required
|-
| String
| a
| Use an NINA Authentication Token for authentication, from the [[Protocols/WebAPI/Auth/WebApp/getToken|getToken]] call
|-
| Integer
| ts
| Epoch timestamp - clientLogin required parameter
|-
| String
| sig_sha256
| Signature - clientLogin required parameter.
|-
| String
| t
| Target to query buddy info for
|-
| String
| language
| the language and locale in "<lang>-<locale>" format. The lang is the 2 letter language code for I18N (default: en) and the locale is the 2 letter Locale code for I18N (default: us).
|}

=== Common Status Codes ===

{| class="wikitable"
! Status Code
! Description
|-
| 200
| Success
|-
| 401
| Authorization required
|-
| 460
| Missing required parameter
|-
| 462
| Parameter error
|}

=== Common Status Detail Codes ===

{| class="wikitable"
! Status Detail Code
! Description
|-
| 1004
| Referer used to create token doesn't match referer of call
|-
| 1014
| Signature is bad, see the signature notes of [[Protocols/WebAPI/Reference/Methods/Session#startSession|startSession]]
|}

=== Sample JSON Output ===

<pre>
{"response":{
"statusCode":200,
"statusText":"Ok",
"requestId":"123",
"data":{
}
}
}
</pre>

=== Sample XML Output ===

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<statusCode>200</statusCode>
<statusText>Ok</statusText>
<requestId>123</requestId>
<data>
</data>
</response>
</pre>

== aimStartPage ==

This method will redirect the caller to the correct AIM Start Page for given language. If WIM is being used from a web page then calling this api directly is enough. If WIM is being used from a clientLogin session or from the OSCAR protocol then a wrapping Single Signon call must be used. See [[Protocols/OSCAR/Sign_On/Single_Sign_On_to_Web_Pages|here]] for an example of using Single Sign On.

URL: GET http://api.oscar.aol.com/aim/getStartPage

=== Input Parameters ===

{| class="wikitable"
! Type
! Field
! Description
|-
| [[Protocols/WebAPI/Reference/Enumeration#Format|Format]]
| f
| '' [Required]'' The format of the data returned
|-
| String
| c
| JSONP callback
|-
| String
| r
| Request id
|-
| String
| language
| the required language and locale of the error/status messages. This is always in "<lang>-<locale>" format. The lang is the 2 letter language code for I18N (default: en) and the locale is the 2 letter Locale code for I18N (default: us). If not passed in, the language will be extracted from HTTP header (Accept-Language) and if that is not available will default to "en-us".
|-
| String
| k
| ''[Required]'' the AIM Web Key from http://dev.aol.com/aim - use the same key for all calls
|}

=== Common Status Codes ===

{| class="wikitable"
! Status Code
! Description
|-
| 200
| Success
|-
| 460
| Missing required parameter
|-
| 462
| Parameter error
|}

=== Sample JSON Output ===

<pre>
{"response":{
"statusCode":200,
"statusText":"Ok",
"requestId":"123",
"data":{
}
}
}
</pre>

=== Sample XML Output ===

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<statusCode>200</statusCode>
<statusText>Ok</statusText>
<requestId>123</requestId>
<data>
</data>
</response>
</pre>

== aimExpressionsPage ==

This method will redirect the caller to the correct AIM Expressions page for given language. If WIM is being used from a web page then calling this api directly is enough. If WIM is being used from a clientLogin session or from the OSCAR protocol then a wrapping Single Signon call must be used. See [http://web.archive.org/web/20090218224837/http://dev.aol.com/aim/oscar#STARTCHOOSER here] for an example of using Single Signon.

URL: GET http://api.oscar.aol.com/aim/getExpressionsPage

=== Input Parameters ===

{| class="wikitable"
! Type
! Field
! Description
|-
| [[Protocols/WebAPI/Reference/Enumeration#Format|Format]]
| f
| '' [Required]'' The format of the data returned
|-
| String
| c
| JSONP callback
|-
| String
| r
| Request id
|-
| String
| language
| the required language and locale of the error/status messages. This is always in "<lang>-<locale>" format. The lang is the 2 letter language code for I18N (default: en) and the locale is the 2 letter Locale code for I18N (default: us). If not passed in, the language will be extracted from HTTP header (Accept-Language) and if that is not available will default to "en-us".
|-
| String
| k
| ''[Required]'' the AIM Web Key from http://dev.aol.com/aim - use the same key for all calls
|}

=== Common Status Codes ===

{| class="wikitable"
! Status Code
! Description
|-
| 200
| Success
|-
| 460
| Missing required parameter
|-
| 462
| Parameter error
|}

=== Sample JSON Output ===

<pre>
{"response":{
"statusCode":200,
"statusText":"Ok",
"requestId":"123",
"data":{
}
}
}
</pre>

=== Sample XML Output ===

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<response>
<statusCode>200</statusCode>
<statusText>Ok</statusText>
<requestId>123</requestId>
<data>
</data>
</response>
</pre>

[[Category:Stub]]
[[Category:AOL]]
[[Category:AIM]]
[[Category:Protocols/WebAPI]]
[[Category:Protocols/WebAPI/Reference]]
[[Category:Work_In_Progress]]

Protocols/WebAPI/Reference/Methods/Misc - Revision history

AD: /* Output Fields */

AD: Created page with "{{Protocols/WebAPI}} This page is about WebAPI misc methods, in a series for the WebAPI reference manual..."