AddEventPerformsAction - Revision history

Rcalvo at 17:16, 27 October 2014

2014-10-27T17:16:33Z

Rcalvo at 20:10, 11 July 2014

2014-07-11T20:10:24Z

Rcalvo at 15:28, 11 July 2014

2014-07-11T15:28:45Z

Rcalvo at 14:29, 11 July 2014

2014-07-11T14:29:22Z

Rcalvo at 19:10, 10 July 2014

2014-07-10T19:10:46Z

Rcalvo at 19:10, 10 July 2014

2014-07-10T19:10:30Z

Rcalvo at 19:10, 10 July 2014

2014-07-10T19:10:02Z

Rcalvo at 19:09, 10 July 2014

2014-07-10T19:09:19Z

Rcalvo at 14:03, 8 July 2014

2014-07-08T14:03:27Z

Rcalvo: Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the..."

2014-07-08T13:40:04Z

Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the..."

New page

{{Api_Method_Spec|
Description=

|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=eventData
|ParamType=[[AnalyticsEventItem]]
|ParamRequired=required
|ParamDescription=The eventData parameter is an [[AnalyticsEventItem]] object type and represent a set of data to register the event in the Mongo data base. Each event has the Timestamp, Event and an object with many pair of key:value. It allow to add any pair key:value as you need because it will be add in the Mongo database dynamically inserting a new column by each new key added.
: e.g.
:: {
::: Token: "",
::: mediaInfo: "",
::: eventData: [
:::: {
::::: "Timestamp" : "4315435114",
::::: "Event" : "EventName",
::::: "Data" :
::::::: {
:::::::: "EventType":"STOP",
:::::::: "ChannelNumber":1,
:::::::: "ChannelName":"TVE 1",
:::::::: "ChannelCallLetter":"",
:::::::: "StreamQuality":"SD",
:::::::: "UniqueUserCode":null,
:::::::: "DeviceId":"3333333333332222222222227128",
:::::::: "OBInstanceCode":25,
:::::::: "UserType":null
::::::: }
:::: },
:::: {
::::: "Timestamp" : "34123543156",
::::: "Event" : "AnotherEventName",
::::: "Data" :
::::::: {
:::::::: "EventType":"Rent",
:::::::: "ActionType":"Click",
:::::::: "ProductType":1,
:::::::: "DeviceId":"3333333333332222222222227128",
:::::::: "OBInstanceCode":29,
:::::::: "Advertising":null
:::::::: "MerchantId":123
::::::: }
:::: }
::: ]
:: }
}}
{{Api_Parameter|
ParamName=mediaInfo
|ParamType=String
|ParamRequired=optional
|ParamDescription=This parameter can be found in the [[GetMediaURL]] and has all information about the Movie. Is passed, it will be used to assign the eventData with the movie.
: e.g.
:: "MediaInfo": "eyJNb3ZpZUlkIjozNTkzNiwiTWVkaWFJZCI6 … XlsaXN0SWQiOjAsIk1lZGlhVHlwZSI6MSwiRHVyYXRpb24iOjU4MjB9"
}}

|Returns=
Returns a JSON object containing the information if the event is registered on server.

'''Example:'''

{
: "StatusCode": 0,
: "Severity": 1,
: "StatusMessage": "OK",
: "Content": true
}

|Exceptions=
None

|Cache=
This method is not cached.

|KnownIssues=
None

|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"

{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author

{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral

{{!}}- valign="top"
! 2.4
{{!}}
{{!}} Ricardo Calvo

{{!}}}

|SeeAlso=
* [[AddEvent]]
}}

← Older revision		Revision as of 17:16, 27 October 2014
Line 1:		Line 1:
−	~~{{subst:afd}}~~	+	DEPRECATED

← Older revision		Revision as of 20:10, 11 July 2014
Line 1:		Line 1:
−	~~{{db-g7}}~~	+	{{subst:afd}}
−	{{subst:~~Proposed deletion\|concern=reason for proposed deletion~~}}

← Older revision		Revision as of 15:28, 11 July 2014
Line 1:		Line 1:
	{{db-g7}}		{{db-g7}}
		+	{{subst:Proposed deletion\|concern=reason for proposed deletion}}

← Older revision		Revision as of 14:29, 11 July 2014
Line 1:		Line 1:
−	{{~~Api_Method_Spec\|~~	+	{{db-g7}}
−	~~Description=~~
−
−	~~( CANDIDATE TO BE DEPRECATED IN A SHORT FUTURE )~~
−
−	}}

← Older revision		Revision as of 19:10, 10 July 2014
Line 3:		Line 3:

	( CANDIDATE TO BE DEPRECATED IN A SHORT FUTURE )		( CANDIDATE TO BE DEPRECATED IN A SHORT FUTURE )
		+
		+	}}

← Older revision		Revision as of 19:10, 10 July 2014
Line 4:		Line 4:
	( CANDIDATE TO BE DEPRECATED IN A SHORT FUTURE )		( CANDIDATE TO BE DEPRECATED IN A SHORT FUTURE )

−
−	~~\|Parameters=~~
−	~~{{Api_Parameter\|~~
−	~~ParamName=token~~
−	~~\|ParamType=String~~
−	~~\|ParamRequired=required~~
−	~~\|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.~~
−	}}
−
−
−
−
−	~~\|Returns=~~
−	~~Returns a JSON object containing the information if the event is registered on server.~~
−
−	~~'''Example:'''~~
−
−	{
−	:
−	}
−
−
−	~~\|Exceptions=~~
−	~~None~~
−
−	~~\|Cache=~~
−	~~This method is not cached.~~
−
−	~~\|KnownIssues=~~
−	~~None~~
−
−	~~\|VersionHistory=~~
−	~~{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"~~
−
−	~~{{!}}- style="background:#88ccff;font-size:110%"~~
−	~~! API Version Number~~
−	~~! Change description~~
−	~~! Changes author~~
−
−	~~{{!}}- valign="top"~~
−	~~! 1.0~~
−	~~{{!}} Initial method design~~
−	~~{{!}} Harley Cabral~~

@@ Line 11: / Line 11: @@
 |ParamRequired=required
 |ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
 }}
@@ Line 72: / Line 22: @@
+{
-:  "StatusCode": 0,
+}
@@ Line 100: / Line 47: @@
 {{!}} Initial method design
 {{!}} Harley Cabral
@@ Line 110: / Line 52: @@
 |SeeAlso=
 }}

← Older revision		Revision as of 14:03, 8 July 2014
Line 2:		Line 2:
	Description=		Description=

−		+	( CANDIDATE TO BE DEPRECATED IN A SHORT FUTURE )