'
Show / Hide Table of Contents

Interface IIntegrationService

The Integration Service allows to manage contracts, retrieve information (including bookings and play logs) and generate Splash reports.

Namespace: Ayuda.BMS.Services.Interfaces
Remarks

This web service can be accessed using an address similar to the following: https://[AYUDA DEPLOYMENT URL]/BMSWebService/IntegrationService.asmx

Methods

DigitalActivity(Guid, String, Nullable<Int32>, Nullable<Int32>, String, String, String, String)

Retrieves the digital activity information.

Declaration
DataSet DigitalActivity(Guid sessionID, string clientCultureName, int? postingYear, int? postingMonth, string networkIDs, string areaIDs, string mediaTypeIDs, string siteNumber)
Parameters
Type Name Description
System.Guid sessionID

Session ID returned by the SignIn method.

System.String clientCultureName

Culture name of the calling machine (ex.: en-CA).

System.Nullable<System.Int32> postingYear

Optional posting year.

System.Nullable<System.Int32> postingMonth

Optional posting months.

System.String networkIDs

Optional list of network ids.

System.String areaIDs

Optional list of area ids.

System.String mediaTypeIDs

Optional list of media ids.

System.String siteNumber

Optional site number.

Returns
Type Description
System.Data.DataSet

A dataset containing information about the digital activity.

Remarks

The following fields are returned: SalesContractNumber, Advertiser, MediaType, DesignName, StartDate, EndDate, FaceLocationTypeCode, PurchaseType, Qty, SpotLength, Network, Area.

DigitalInventorySummary(Guid, String, String, String, String, String, String, String)

Retrieves the digital inventory summary.

Declaration
DataSet DigitalInventorySummary(Guid sessionID, string clientCultureName, string companyIDs, string areaIDs, string networkIDs, string faceLocationTypeIDs, string siteInactiveReasonIDString, string faceInactiveReasonIDString)
Parameters
Type Name Description
System.Guid sessionID

Session ID returned by the SignIn method.

System.String clientCultureName

Culture name of the calling machine (ex.: en-CA).

System.String companyIDs

Optional list of company ids.

System.String areaIDs

Optional list of area ids.

System.String networkIDs

Optional list of network ids.

System.String faceLocationTypeIDs

Optional list of face location type ids.

System.String siteInactiveReasonIDString

Optional site inactive reason ids.

System.String faceInactiveReasonIDString

Optional face inactive reason ids.

Returns
Type Description
System.Data.DataSet

A dataset containing information about the digital inventory.

Remarks

The following fields are returned: SiteCode, SiteName, SiteAddress, SiteCity, SiteState, SitePostalCode, AreaName, Network, FaceLocationTypeCode, FaceID, FaceCode.

GetAreas(Guid, String)

Retrieves all areas at the leaf level.

Declaration
string GetAreas(Guid sessionID, string clientCultureName)
Parameters
Type Name Description
System.Guid sessionID

Session ID returned by the SignIn method.

System.String clientCultureName

Culture name of the calling machine (ex.: en-CA).

Returns
Type Description
System.String

An xml document containing the areas. Use /items/item/ to locate individual areas.

GetCompanies(Guid, String)

Retrieves all the companies/divisions.

Declaration
string GetCompanies(Guid sessionID, string clientCultureName)
Parameters
Type Name Description
System.Guid sessionID

Session ID returned by the SignIn method.

System.String clientCultureName

Culture name of the calling machine (ex.: en-CA).

Returns
Type Description
System.String

An xml document containing the companies/divisions. Use /items/item/ to locate individual companies/divisions.

GetDigitalBookings(Guid, String, DateTime, DateTime)

Retrieves the list of digital bookings

Declaration
DigitalBookingListDataSet GetDigitalBookings(Guid sessionID, string clientCultureName, DateTime startDate, DateTime endDate)
Parameters
Type Name Description
System.Guid sessionID

Session ID returned by the SignIn method.

System.String clientCultureName

Culture name of the calling machine (ex.: en-CA).

System.DateTime startDate

Period start date.

System.DateTime endDate

Period end date.

Returns
Type Description
Ayuda.BMS.Lists.Models.Integration.DigitalBookingListDataSet

A dataset containing the digital bookings.

GetFaceLocationTypes(Guid, String)

Retrieves all the face location types.

Declaration
string GetFaceLocationTypes(Guid sessionID, string clientCultureName)
Parameters
Type Name Description
System.Guid sessionID

Session ID returned by the SignIn method.

System.String clientCultureName

Culture name of the calling machine (ex.: en-CA).

Returns
Type Description
System.String

An xml document containing the face location types. Use /items/item/ to locate individual face location types.

GetInactiveReasons(Guid, String)

Retrieves all the inactive reasons.

Declaration
string GetInactiveReasons(Guid sessionID, string clientCultureName)
Parameters
Type Name Description
System.Guid sessionID

Session ID returned by the SignIn method.

System.String clientCultureName

Culture name of the calling machine (ex.: en-CA).

Returns
Type Description
System.String

An xml document containing the inactive reasons. Use /items/item/ to locate individual inactive reasons.

GetMediaTypes(Guid, String)

Retrieves all the media types.

Declaration
string GetMediaTypes(Guid sessionID, string clientCultureName)
Parameters
Type Name Description
System.Guid sessionID

Session ID returned by the SignIn method.

System.String clientCultureName

Culture name of the calling machine (ex.: en-CA).

Returns
Type Description
System.String

An xml document containing the media types. Use /items/item/ to locate individual media types.

GetNetworks(Guid, String)

Retrieves all the networks.

Declaration
string GetNetworks(Guid sessionID, string clientCultureName)
Parameters
Type Name Description
System.Guid sessionID

Session ID returned by the SignIn method.

System.String clientCultureName

Culture name of the calling machine (ex.: en-CA).

Returns
Type Description
System.String

An xml document containing the networks. Use /items/item/ to locate individual networks.

GetSalesContract(Guid, String, String)

Returns a SalesContract dataset containing all the information needed for a campaign. This dataset may be updated afterward by the customer and returned back to the web service (using the UpdateSite method) to update the database.

Declaration
SalesContractDataSet GetSalesContract(Guid sessionID, string clientCultureName, string salesContractNumber)
Parameters
Type Name Description
System.Guid sessionID

Session ID returned by the SignIn method.

System.String clientCultureName

Culture name of the calling machine (ex.: en-CA).

System.String salesContractNumber

.

Returns
Type Description
Ayuda.BMS.Entities.Models.Integration.SalesContractDataSet

A dataset contaning the sales contract

GetSite(Guid, String, String, String)

Returns a Site dataset containing all the information needed for a site. This dataset may be updated afterward by the customer and returned back to the web service (using the UpdateSite method) to update the database.

Declaration
SiteDataSet GetSite(Guid sessionID, string clientCultureName, string siteCode, string companyName)
Parameters
Type Name Description
System.Guid sessionID

Session ID returned by the SignIn method.

System.String clientCultureName

Culture name of the calling machine (ex.: en-CA).

System.String siteCode

The site code.

System.String companyName

Name of the company/division that the site belongs to.

Returns
Type Description
Ayuda.BMS.Entities.Models.Integration.SiteDataSet

A dataset containing the site

PoPReport(Guid, String, String, String, String, String, String)

Retrieves the digital Proof-of-Performance report.

Declaration
DataSet PoPReport(Guid sessionID, string clientCultureName, string fromDateString, string toDateString, string advertiserCode, string salesContractNumber, string mediaTypeIDString)
Parameters
Type Name Description
System.Guid sessionID

Session ID returned by the SignIn method.

System.String clientCultureName

Culture name of the calling machine (ex.: en-CA).

System.String fromDateString

Optional start date.

System.String toDateString

Optional end date.

System.String advertiserCode

Optional advertiser code.

System.String salesContractNumber

Sales contract number.

System.String mediaTypeIDString

Optional list of media types.

Returns
Type Description
System.Data.DataSet

A dataset containing the report.

SignIn(String, String)

Authenticates the user and returns the Session ID (Guid) if it succeeded. This Session ID is necessary to call all other methods.

Declaration
Guid SignIn(string username, string password)
Parameters
Type Name Description
System.String username

Username.

System.String password

Password.

Returns
Type Description
System.Guid

The session ID.

SignOut(Guid)

Signs the user out. Every SignIn call should be matched by a corresponding SignOut invocation

Declaration
void SignOut(Guid sessionID)
Parameters
Type Name Description
System.Guid sessionID

Session ID returned by the SignIn method.

SiteScheduleHistory(Guid, String, String, String, String)

Retrieves the site scheduling history.

Declaration
DataSet SiteScheduleHistory(Guid sessionID, string clientCultureName, string siteCode, string fromDateString, string toDateString)
Parameters
Type Name Description
System.Guid sessionID

Session ID returned by the SignIn method.

System.String clientCultureName

Culture name of the calling machine (ex.: en-CA).

System.String siteCode

.

System.String fromDateString

.

System.String toDateString

.

Returns
Type Description
System.Data.DataSet

A dataset containing the site scheduling history.

UpdateSalesContract(Guid, String, SalesContractDataSet)

Updates the campaign information in the database using the provided dataset. The row state of every row in every table of the dataset determines the action (insert/update/delete) to apply to the database.

Declaration
void UpdateSalesContract(Guid sessionID, string clientCultureName, SalesContractDataSet dset)
Parameters
Type Name Description
System.Guid sessionID

Session ID returned by the SignIn method.

System.String clientCultureName

Culture name of the calling machine (ex.: en-CA).

Ayuda.BMS.Entities.Models.Integration.SalesContractDataSet dset

A dataset such as one returned from GetSalesContract().

Remarks

If a validation error occurs, an exception is thrown with a descriptive message explaining what went wrong.

UpdateSite(Guid, String, SiteDataSet)

Updates the site information in the database using the provided dataset. The row state of every row in every table of the dataset determines the action (insert/update/delete) to apply to the database.

Declaration
void UpdateSite(Guid sessionID, string clientCultureName, SiteDataSet dset)
Parameters
Type Name Description
System.Guid sessionID

Session ID returned by the SignIn method.

System.String clientCultureName

Culture name of the calling machine (ex.: en-CA).

Ayuda.BMS.Entities.Models.Integration.SiteDataSet dset

A dataset such as one returned from GetSite().

Remarks

If a validation error occurs, an exception is thrown with a descriptive message explaining what went wrong.

Back to top Generated by DocFX