You can use this Web API to get campaigns for a logged in user by the passing value “search_campaign” in “action” parameter, Developers can also pass any other optional parameter provided below to get required result set.
This method requires User Context before it can be called. Please either use VIDIZMO JS Login API before calling this method or use VIDIZMO Web Login method and additionally pass the access_token parameter to this call API.
Request
<script type="text/javascript"> var data = JSON.stringify({ CampaignStatusId: 2, CampaignTitle: '', EndDate: null, RecordCount: 10, SortBy: '', SortType: '', StartDate: null, StartIndex: 1 }); var mashupHandler = "http:// video.lexcorpinc.com/Handlers/campaignHandler.ashx"; var queryString = "?action=search_campaign&suppress_response_codes=true"; queryString += "&access_token=" + AccessToken; $.ajax({ type: "Post", url: mashupHandler + queryString, dataType: 'json', data: data, contentType: "application/json", success: function (response) {}, error: function (req, type, ex) {} }); </script>
Parameter
Parameter |
Description |
CampaignStatusId |
Status of Campaign |
CampaignTitle |
Title of a Campaign. |
EndDate |
End date of a campaign. |
StartDate |
Start date of a campaign. |
RecordCount |
Number of records to fetch the result. |
StartIndex |
Start index of a campaign. |
SortBy |
Sort campaign data PossibleValues:”id”,”Title”,”StartDate”,”EndDate”,”UpdatedDate”,”CampaignStatusId” |
Response
{ "result": [ { "CampaignId": 3131, "TenantId": 1785, "TenantChannelName": null, "AddedBy": 304205, "UpdatedBy": 304205, "CampaignStatusId": 2, "CampaignStatusName": "Paused", "Title": "Vidizmo Orientation", "Description": "<p>Vidizmo Orientation</p>", "StartDate": "2014-08-20T00:00:00", "EndDate": null, "AddedDate": "2014-08-20T12:38:24.16", "UpdatedDate": "2014-08-20T12:39:07.637", "IsActive": false, "IsDeleted": null, "SendNotification": null, "IsDraft": false, "UnregisteredUserList": "", "CampaignLink": "http://CHANNELURL/InvitationHandler.aspx?tid=TENANTID&uid=USERID&cid=CAMPAIGNID&referrer=%2fMyMedia.aspx", "CampaignRow": 1, "TotalCount": 3, "MashupList": null, "GroupList": null, "UserList": null, "UserCount": 1, "GroupCount": 0, "LiveMashupCount": 0, "OnDemandMashupCount": 6, "AutoEnrollmentMode": 1, "EnforceDuration": false } ], "status": 1, "status_code": 200, "message": null }
To learn more how these Widgets work, click here on VIDIZMO Web API Library.
For a complete list of VIDIZMO APIs, click here on VIDIZMO Developer APIs.