|
|
|
Web Service URL:
http://api.interactrivia.com/ws/Partner.asmx
Web Service WSDL:
http://api.interactrivia.com/ws/Partner.asmx?wsdl
Overview
The Partner service is used to manipulate and retrieve content, game channels and
game scores. Most calls to the Partner service require a valid Authentication Token
to complete. Please see our Authentication Service Overview
for detailed information on generating a token.
Methods
The Partner service has methods for adding, updating, deleting and retrieving game
content (Question, Categories, Quotes, Facts) and game channels. Additionally, you
can retrieve game scores and user scores for any time period with built-in accessors
for the most common time periods.
See the
Partner Service Description
for a detailed list of methods, descriptions and required parameters.
Return Values
All return results inherit from BaseResult and include the following properties:
Status, Message and Result.
Status is a string value and can be any of the following:
- TOKEN_EXPIRED_OR_INVALID - you must retrieve a new Authentication
token from the Authentication service.
- PARAM_INVALID - one of your parameters was invalid, see Message
property for details on the invalid parameter and try again.
- NO_DATA - call succeeded, but no data was returned in the Result
property.
- FAILURE - call failed. Check Message property for more information or try your request again.
- SUCCESS - call succeeded, use Result property to get returned
information.
- ERROR - there was an error processing authentication, see Message
property for more information.
Return Types
All return results inherit from BaseResult and include the following properties:
Status, Message and Result. In all cases, Status and
Message will be string values. Result is a generic container whose
type is determined by the particular return type for each method. Possible return
types and the type of their Result property are:
-
BooleanResult - Result is a boolean value (true / false).
-
CategoriesResult - Result is an array of Question Category
-
ChannelsResult - Result is an array of Channel.
-
ConnectionResult - Result is Connection value.
-
FactsResult - Result is an array of Fact.
-
GameScoresResult - Result is an array of Game Score.
-
IntegerResult - Result is an integer value.
-
LeaderboardResult - Result is an array of Leaderboard.
-
QuestionDisputesResult - Result is an array of Question Dispuate.
-
QuestionsResult - Result is an array of Question.
-
QuotesResult - Result is an array of Quote.
Notes
None.
|
|