Interface IIntegrationService2

The IIntegrationService2 Integration Service extension allows to manage bundles and designs and to check availability.

Namespace: Ayuda.BMS.Services.Interfaces

Remarks

This web service can be accessed using an address similar to the following: https://[AYUDA DEPLOYMENT URL]/Ayuda.BMS.Services/IntegrationService.svc

Methods

AddDesignToBundle(Session, BundleDesign)

Adds the design to bundle.

Declaration

[OperationContract]
Guid AddDesignToBundle(Session session, BundleDesign bundleDesign)

Parameters

Type	Name	Description
Session	session	The session.
BundleDesign	bundleDesign	The bundle design.

Returns

Type	Description
System.Guid	BundleDesignID.

CheckFaceAvails(Session, List<Guid>, DateTime, DateTime)

Check face availabilities.

Declaration

[OperationContract]
List<FaceAvailableModel> CheckFaceAvails(Session session, List<Guid> faceIds, DateTime startDate, DateTime endDate)

Parameters

Type	Name	Description
Session	session	The session.
System.Collections.Generic.List<System.Guid>	faceIds	The face ids.
System.DateTime	startDate	The start date.
System.DateTime	endDate	The end date.

Returns

Type	Description
System.Collections.Generic.List<Ayuda.BMS.Splash.Shared.Models.Avails.FaceAvailableModel>	List{FaceAvailableModel}.

CreateBundle(Session, Bundle)

Creates the bundle.

Declaration

[OperationContract]
Guid CreateBundle(Session session, Bundle bundle)

Parameters

Type	Name	Description
Session	session	The session.
Bundle	bundle	The bundle.

Returns

Type	Description
System.Guid	BundleID.

CreateDesign(Session, Design)

Creates the design.

Declaration

[OperationContract]
Guid CreateDesign(Session session, Design design)

Parameters

Type	Name	Description
Session	session	The session.
Design	design	The design.

Returns

Type	Description
System.Guid	DesignID.

DeleteBundle(Session, Guid)

Deletes the bundle.

Declaration

[OperationContract]
void DeleteBundle(Session session, Guid bundleID)

Parameters

Type	Name	Description
Session	session	The session.
System.Guid	bundleID	The bundle ID.

DeleteDesign(Session, Guid)

Deletes the design.

Declaration

[OperationContract]
void DeleteDesign(Session session, Guid designID)

Parameters

Type	Name	Description
Session	session	The session.
System.Guid	designID	The design ID.

GetAdvertisers(Session)

Gets the advertisers.

Declaration

[OperationContract]
IEnumerable<Advertiser> GetAdvertisers(Session session)

Parameters

Type	Name	Description
Session	session	The session.

Returns

Type	Description
System.Collections.Generic.IEnumerable<Advertiser>	IEnumerable{Advertiser}.

GetBundle(Session, Guid)

Gets the bundle.

Declaration

[OperationContract]
Bundle GetBundle(Session session, Guid bundleID)

Parameters

Type	Name	Description
Session	session	The session.
System.Guid	bundleID	The bundle ID.

Returns

Type	Description
Bundle	Bundle.

GetDesign(Session, Guid)

Gets the design.

Declaration

[OperationContract]
Design GetDesign(Session session, Guid designID)

Parameters

Type	Name	Description
Session	session	The session.
System.Guid	designID	The design ID.

Returns

Type	Description
Design	Ayuda.BMS.Services.Models.Design.

GetFaces(Session)

Gets the zones.

Declaration

[OperationContract]
List<Face> GetFaces(Session session)

Parameters

Type	Name	Description
Session	session	The session.

Returns

Type	Description
System.Collections.Generic.List<Face>	List{Ayuda.BMS.Services.Models.Zone}.

GetPlayLists(Session, Guid, DateTime, DateTime)

Gets a playlist.

Declaration

[OperationContract]
List<PlayList> GetPlayLists(Session session, Guid zoneID, DateTime startDateTime, DateTime endDateTime)

Parameters

Type	Name	Description
Session	session	The session.
System.Guid	zoneID	The zone ID.
System.DateTime	startDateTime	The start datetime.
System.DateTime	endDateTime	The end datetime.

Returns

Type	Description
System.Collections.Generic.List<PlayList>	List{PlayList}.

RemoveDesignFromBundle(Session, Guid)

Removes the design from bundle.

Declaration

void RemoveDesignFromBundle(Session session, Guid bundleDesignID)

Parameters

Type	Name	Description
Session	session	The session.
System.Guid	bundleDesignID	The bundle design ID.

RemoveDesignFromBundle(Session, Guid, Guid)

Removes the design from bundle.

Declaration

[OperationContract]
void RemoveDesignFromBundle(Session session, Guid bundleID, Guid designID)

Parameters

Type	Name	Description
Session	session	The session.
System.Guid	bundleID	The bundle ID.
System.Guid	designID	The design ID.

SignIn(String, String)

Signs the user in.

Declaration

[OperationContract]
Session SignIn(string username, string password)

Parameters

Type	Name	Description
System.String	username	The username.
System.String	password	The password.

Returns

Type	Description
Session	A session object

SignOut(Session)

Signs the user out.

Declaration

[OperationContract]
void SignOut(Session session)

Parameters

Type	Name	Description
Session	session	The session.

UpdateBundle(Session, Bundle)

Updates the bundle.

Declaration

[OperationContract]
Guid UpdateBundle(Session session, Bundle bundle)

Parameters

Type	Name	Description
Session	session	The session.
Bundle	bundle	The bundle.

Returns

Type	Description
System.Guid	BundleID.

UpdateDesign(Session, Design)

Updates the design.

Declaration

[OperationContract]
void UpdateDesign(Session session, Design design)

Parameters

Type	Name	Description
Session	session	The session.
Design	design	The design.