Interface IFindService

The Find Service is a read-only service that allows to retrieve data from the Ayuda Platform.

Namespace: Ayuda.BMS.Services.Interfaces

Remarks

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

Methods

CancelSearch(Guid, String, Guid)

Cancels the paged search operation.

Declaration

void CancelSearch(Guid sessionID, string clientCultureName, Guid key)

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.Guid	key	Result set ID.

CheckAvailabilityBySalesMarketPivoted(Guid, String, SmartListBehavior, QueryParameter[])

Checks availability by Sales Market.

Declaration

SmartList CheckAvailabilityBySalesMarketPivoted(Guid sessionID, string clientCultureName, SmartListBehavior smartListBehavior, QueryParameter[] parameters)

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.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.
Ayuda.BMS.Shared.QueryParameter[]	parameters	Filter parameters.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	A smart list containing the availability dataset

CheckAvails(Guid, String, SmartListBehavior, QueryParameter[])

Checks traditional (static) avails.

Declaration

SmartList CheckAvails(Guid sessionID, string clientCultureName, SmartListBehavior smartListBehavior, QueryParameter[] parameters)

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.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.
Ayuda.BMS.Shared.QueryParameter[]	parameters	Filter parameters.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	A smart list containing the availability dataset

CheckPackAvails(Guid, String, SmartListBehavior, QueryParameter[])

Checks traditional (static) pack avails.

Declaration

SmartList CheckPackAvails(Guid sessionID, string clientCultureName, SmartListBehavior smartListBehavior, QueryParameter[] parameters)

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.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.
Ayuda.BMS.Shared.QueryParameter[]	parameters	Filter parameters.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	A smart list containing the pack availability dataset

EvaluateFLAB(Guid, String, String, FLABVariables)

Evaluates a Flexible Lease Agreement Builder formula.

Declaration

decimal EvaluateFLAB(Guid sessionID, string clientCultureName, string formulaXml, FLABVariables variables)

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	formulaXml	The XML containing the formula.
Ayuda.BMS.Shared.FLABVariables	variables	The FLAB formula variables.

Returns

Type	Description
System.Decimal	The result of the evaluation.

Find(Guid, String, Query[], String)

Invokes a collection of custom queries.

Declaration

DataSet Find(Guid sessionID, string clientCultureName, Query[] queries, string dataSetSchema)

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.Shared.Query[]	queries	List of queries to invoke.
System.String	dataSetSchema	Schema defining the return dataset.

Returns

Type	Description
System.Data.DataSet	System.Data.DataSet.

FindAdvertiserAll(Guid, String, Byte[])

Retrieves all advertisers.

Declaration

AdvertiserListDataSet FindAdvertiserAll(Guid sessionID, string clientCultureName, byte[] timeStamp)

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.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.AdvertiserListDataSet	Ayuda.BMS.Lists.Models.AdvertiserListDataSet.

FindAdvertiserCategoryAll(Guid, String, Byte[])

Retrieves all advertiser categories.

Declaration

AdvertiserCategoryListDataSet FindAdvertiserCategoryAll(Guid sessionID, string clientCultureName, byte[] timeStamp)

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.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.AdvertiserCategoryListDataSet	Ayuda.BMS.Lists.Models.AdvertiserCategoryListDataSet.

FindAgencyAll(Guid, String, Byte[])

Retrieves all agencies.

Declaration

AgencyListDataSet FindAgencyAll(Guid sessionID, string clientCultureName, byte[] timeStamp)

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.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.AgencyListDataSet	Ayuda.BMS.Lists.Models.AgencyListDataSet.

FindAreaGroupAll(Guid, String, Byte[])

Retrieves all area groups.

Declaration

AreaGroupListDataSet FindAreaGroupAll(Guid sessionID, string clientCultureName, byte[] timeStamp)

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.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.AreaGroupListDataSet	Ayuda.BMS.Lists.Models.AreaGroupListDataSet.

FindAreaLevelAll(Guid, String, Byte[])

Retrieves all area levels.

Declaration

AreaLevelListDataSet FindAreaLevelAll(Guid sessionID, string clientCultureName, byte[] timeStamp)

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.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.AreaLevelListDataSet	Ayuda.BMS.Lists.Models.AreaLevelListDataSet.

FindAvailsExportFaceList(Guid, String, String)

Retrieves details about the specified faces.

Declaration

AvailsExportFaceListDataSet FindAvailsExportFaceList(Guid sessionID, string clientCultureName, string faceXml)

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	faceXml	An xml document contaning the list of face ids

Returns

Type	Description
Ayuda.BMS.Lists.Models.AvailsExportFaceListDataSet	Ayuda.BMS.Lists.Models.AvailsExportFaceListDataSet.

FindBmsUserSearchByFilterActionControlKey(Guid, String, Guid, String, Byte[])

Finds saved BMS user searches.

Declaration

BmsUserSearchListDataSet FindBmsUserSearchByFilterActionControlKey(Guid sessionID, string clientCultureName, Guid bmsUserID, string filterActionControlKey, byte[] timeStamp)

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.Guid	bmsUserID	BMS User ID.
System.String	filterActionControlKey	Action to filter for.
System.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.BmsUserSearchListDataSet	Ayuda.BMS.Lists.Models.BmsUserSearchListDataSet.

FindCampaignByAdvertiser(Guid, String, Guid, SmartListBehavior)

Finds all campaigns by an advertiser ID.

Declaration

SmartList FindCampaignByAdvertiser(Guid sessionID, string clientCultureName, Guid advertiserID, SmartListBehavior smartListBehavior)

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.Guid	advertiserID	Advertiser ID.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignByAdvertiserName(Guid, String, String, SmartListBehavior)

Finds all campaigns by an advertiser name.

Declaration

SmartList FindCampaignByAdvertiserName(Guid sessionID, string clientCultureName, string advertiserName, SmartListBehavior smartListBehavior)

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	advertiserName	Advertiser name.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignByAgencyName(Guid, String, String, SmartListBehavior)

Finds all campaigns by an agency name.

Declaration

SmartList FindCampaignByAgencyName(Guid sessionID, string clientCultureName, string agencyName, SmartListBehavior smartListBehavior)

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	agencyName	Agency name.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignByDateScheduled(Guid, String, DateTime, DateTime, SmartListBehavior)

Finds all campaigns by an date range.

Declaration

SmartList FindCampaignByDateScheduled(Guid sessionID, string clientCultureName, DateTime startDate, DateTime endDate, SmartListBehavior smartListBehavior)

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	Range start date.
System.DateTime	endDate	Range end date.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignByFaceLocationDescription(Guid, String, String, SmartListBehavior)

Finds all campaigns by face location description.

Declaration

SmartList FindCampaignByFaceLocationDescription(Guid sessionID, string clientCultureName, string faceLocationDescription, SmartListBehavior smartListBehavior)

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	faceLocationDescription	Face description
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignByFaceLocationNumber(Guid, String, String, SmartListBehavior)

Finds all campaigns by face location number.

Declaration

SmartList FindCampaignByFaceLocationNumber(Guid sessionID, string clientCultureName, string faceLocationNumber, SmartListBehavior smartListBehavior)

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	faceLocationNumber	Face number
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignByLatePostings(Guid, String, SmartListBehavior)

Finds all campaigns containing late postings.

Declaration

SmartList FindCampaignByLatePostings(Guid sessionID, string clientCultureName, SmartListBehavior smartListBehavior)

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.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignByLatePostingsWithNoReasonLate(Guid, String, SmartListBehavior)

Finds all campaigns containing late postings with no reasons late.

Declaration

SmartList FindCampaignByLatePostingsWithNoReasonLate(Guid sessionID, string clientCultureName, SmartListBehavior smartListBehavior)

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.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignByMediaTypeGroup(Guid, String, Guid, SmartListBehavior)

Finds all campaigns by media type group.

Declaration

SmartList FindCampaignByMediaTypeGroup(Guid sessionID, string clientCultureName, Guid mediaTypeGroupID, SmartListBehavior smartListBehavior)

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.Guid	mediaTypeGroupID	Media type group ID.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignByName(Guid, String, String, SmartListBehavior)

Finds all campaigns by name.

Declaration

SmartList FindCampaignByName(Guid sessionID, string clientCultureName, string name, SmartListBehavior smartListBehavior)

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	name	Campaign name.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignByNetwork(Guid, String, Guid, SmartListBehavior)

Finds all campaigns by a network.

Declaration

SmartList FindCampaignByNetwork(Guid sessionID, string clientCultureName, Guid networkID, SmartListBehavior smartListBehavior)

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.Guid	networkID	Network ID.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignByPoPUserEmail(Guid, String, String, SmartListBehavior)

Finds all campaigns by POP user e-mail address.

Declaration

SmartList FindCampaignByPoPUserEmail(Guid sessionID, string clientCultureName, string email, SmartListBehavior smartListBehavior)

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	email	POP user e-mail address.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignByPoPUserFullName(Guid, String, String, SmartListBehavior)

Finds all campaigns by POP user full name.

Declaration

SmartList FindCampaignByPoPUserFullName(Guid sessionID, string clientCultureName, string fullName, SmartListBehavior smartListBehavior)

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	fullName	POP user full name.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignByPublishStatusType(Guid, String, Guid, SmartListBehavior)

Finds all campaigns by publish status type.

Declaration

SmartList FindCampaignByPublishStatusType(Guid sessionID, string clientCultureName, Guid publishStatusTypeID, SmartListBehavior smartListBehavior)

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.Guid	publishStatusTypeID	Pubish status type ID.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignByRecentActivities(Guid, String, Int32, SmartListBehavior)

Finds all campaigns having a recent activity.

Declaration

SmartList FindCampaignByRecentActivities(Guid sessionID, string clientCultureName, int numberOfDays, SmartListBehavior smartListBehavior)

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.Int32	numberOfDays	Number of recent days that companies have had activity for.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignBySalesContractNumber(Guid, String, String, SmartListBehavior)

Finds all campaigns by a Sales Contract number.

Declaration

SmartList FindCampaignBySalesContractNumber(Guid sessionID, string clientCultureName, string salesContractNumber, SmartListBehavior smartListBehavior)

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	Sales Contract number.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignBySellingCompany(Guid, String, Guid, SmartListBehavior)

Finds all campaigns by selling company.

Declaration

SmartList FindCampaignBySellingCompany(Guid sessionID, string clientCultureName, Guid companyID, SmartListBehavior smartListBehavior)

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.Guid	companyID	Selling company ID.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignBySiteCompany(Guid, String, Guid, SmartListBehavior)

Finds all campaigns by site company.

Declaration

SmartList FindCampaignBySiteCompany(Guid sessionID, string clientCultureName, Guid companyID, SmartListBehavior smartListBehavior)

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.Guid	companyID	Site company ID.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindCampaignSummary(Guid, String, Guid)

Retrieves a campaign summary.

Declaration

CampaignSummaryListDataSet FindCampaignSummary(Guid sessionID, string clientCultureName, Guid campaignID)

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.Guid	campaignID	Campaign ID.

Returns

Type	Description
Ayuda.BMS.Lists.Models.CampaignSummaryListDataSet	Ayuda.BMS.Lists.Models.CampaignSummaryListDataSet.

FindCampaignSummaryBySalesContractItem(Guid, String, Guid)

Retrieves a campaign by the segment ID.

Declaration

CampaignSummaryListDataSet FindCampaignSummaryBySalesContractItem(Guid sessionID, string clientCultureName, Guid salesContractItemID)

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.Guid	salesContractItemID	Campaign Segment ID

Returns

Type	Description
Ayuda.BMS.Lists.Models.CampaignSummaryListDataSet	Ayuda.BMS.Lists.Models.CampaignSummaryListDataSet.

FindCompany(Guid, String)

Retrieves all companies/divisions.

Declaration

CompanyListDataSet FindCompany(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
Ayuda.BMS.Lists.Models.CompanyListDataSet	Ayuda.BMS.Lists.Models.CompanyListDataSet.

FindData(Guid, String, FindParameter[])

Invokes a collection of custom queries.

Declaration

DataSet[] FindData(Guid sessionID, string clientCultureName, FindParameter[] findParameters)

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.Shared.FindParameter[]	findParameters	List of custom queries along with their dataset schemas.

Returns

Type	Description
System.Data.DataSet[]	System.Data.DataSet[][].

FindDataSet(Guid, String, Query, SmartListBehavior)

Invokes a custom query.

Declaration

SmartList FindDataSet(Guid sessionID, string clientCultureName, Query query, SmartListBehavior smartListBehavior)

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.Shared.Query	query	Custom query.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindDesignByCampaign(Guid, String, Guid)

Finds all designs for a specified campaign.

Declaration

DesignListDataSet FindDesignByCampaign(Guid sessionID, string clientCultureName, Guid campaignID)

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.Guid	campaignID	Campaign ID.

Returns

Type	Description
Ayuda.BMS.Lists.Models.DesignListDataSet	Ayuda.BMS.Lists.Models.DesignListDataSet.

FindDesignRestrictionAll(Guid, String, Byte[])

Retrieves all design restrictions.

Declaration

DesignRestrictionListDataSet FindDesignRestrictionAll(Guid sessionID, string clientCultureName, byte[] timeStamp)

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.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.DesignRestrictionListDataSet	Ayuda.BMS.Lists.Models.DesignRestrictionListDataSet.

FindDesignSelectionByCampaign(Guid, String, Guid)

Finds all postings for a specified campaign.

Declaration

DesignSelectionListDataSet FindDesignSelectionByCampaign(Guid sessionID, string clientCultureName, Guid campaignID)

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.Guid	campaignID	Campaign ID.

Returns

Type	Description
Ayuda.BMS.Lists.Models.DesignSelectionListDataSet	Ayuda.BMS.Lists.Models.DesignSelectionListDataSet.

FindDesignSelectionBySalesContractItem(Guid, String, Guid)

Finds all postings for a specified segment.

Declaration

DesignSelectionListDataSet FindDesignSelectionBySalesContractItem(Guid sessionID, string clientCultureName, Guid salesContractItemID)

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.Guid	salesContractItemID	Segment ID.

Returns

Type	Description
Ayuda.BMS.Lists.Models.DesignSelectionListDataSet	Ayuda.BMS.Lists.Models.DesignSelectionListDataSet.

FindDesignSelectionSummary(Guid, String, Guid, Guid)

Finds all postings for a specified campaign.

Declaration

DesignSelectionSummaryListDataSet FindDesignSelectionSummary(Guid sessionID, string clientCultureName, Guid faceSelectionID, Guid designSelectionID)

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.Guid	faceSelectionID	Booking ID.
System.Guid	designSelectionID	Posting ID.

Returns

Type	Description
Ayuda.BMS.Lists.Models.DesignSelectionSummaryListDataSet	Ayuda.BMS.Lists.Models.DesignSelectionSummaryListDataSet.

FindDigitalBookingLineZoneSummary(Guid, String, Guid, Guid)

Retrieves a DigitalBookingLineZone summary.

Declaration

DigitalBookingLineZoneSummaryListDataSet FindDigitalBookingLineZoneSummary(Guid sessionID, string clientCultureName, Guid digitalBookingLineZoneID, Guid designID)

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.Guid	digitalBookingLineZoneID	DigitalBookingLineZone ID.
System.Guid	designID	Design ID.

Returns

Type	Description
Ayuda.BMS.Lists.Models.DigitalBookingLineZoneSummaryListDataSet	Ayuda.BMS.Lists.Models.DigitalBookingLineZoneSummaryListDataSet.

FindDigitalDesignSelectionByCampaign(Guid, String, Guid)

Retrieves a Digital Design Selection.

Declaration

DigitalBookingLineZoneListDataSet FindDigitalDesignSelectionByCampaign(Guid sessionID, string clientCultureName, Guid campaignID)

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.Guid	campaignID	Campaign ID.

Returns

Type	Description
Ayuda.BMS.Lists.Models.DigitalBookingLineZoneListDataSet	Ayuda.BMS.Lists.Models.DigitalBookingLineZoneListDataSet.

FindFaceByCampaignName(Guid, String, String, SmartListBehavior)

Finds all faces for a specified campaign.

Declaration

SmartList FindFaceByCampaignName(Guid sessionID, string clientCultureName, string campaignName, SmartListBehavior smartListBehavior)

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	campaignName	Campaign name.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindFaceByDateAvailable(Guid, String, SmartListBehavior, QueryParameter[])

Finds available faces by date range.

Declaration

SmartList FindFaceByDateAvailable(Guid sessionID, string clientCultureName, SmartListBehavior smartListBehavior, QueryParameter[] parameters)

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.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.
Ayuda.BMS.Shared.QueryParameter[]	parameters	Filter parameters.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	A smart list containing matching faces

FindFaceByDateScheduled(Guid, String, DateTime, DateTime, SmartListBehavior)

Finds all faces by scheduled dates.

Declaration

SmartList FindFaceByDateScheduled(Guid sessionID, string clientCultureName, DateTime startDate, DateTime endDate, SmartListBehavior smartListBehavior)

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	Range start date.
System.DateTime	endDate	Range end date.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindFaceByLocationDescription(Guid, String, String, SmartListBehavior)

Finds all faces by location description.

Declaration

SmartList FindFaceByLocationDescription(Guid sessionID, string clientCultureName, string locationDescription, SmartListBehavior smartListBehavior)

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	locationDescription	Location description.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindFaceByLocationNumber(Guid, String, String, SmartListBehavior)

Finds all faces by location number.

Declaration

SmartList FindFaceByLocationNumber(Guid sessionID, string clientCultureName, string locationNumber, SmartListBehavior smartListBehavior)

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	locationNumber	Location number.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindFaceByMediaTypeGroupID(Guid, String, Guid, SmartListBehavior)

Finds all faces by Media Type Group.

Declaration

SmartList FindFaceByMediaTypeGroupID(Guid sessionID, string clientCultureName, Guid mediaTypeGroupID, SmartListBehavior smartListBehavior)

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.Guid	mediaTypeGroupID	Media Type Group ID.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindFaceByMediaTypeID(Guid, String, Guid, SmartListBehavior)

Finds all faces by Media Type.

Declaration

SmartList FindFaceByMediaTypeID(Guid sessionID, string clientCultureName, Guid mediaTypeID, SmartListBehavior smartListBehavior)

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.Guid	mediaTypeID	Media Type ID.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindFaceByNetworkID(Guid, String, Guid, SmartListBehavior)

Finds all faces by Network.

Declaration

SmartList FindFaceByNetworkID(Guid sessionID, string clientCultureName, Guid networkID, SmartListBehavior smartListBehavior)

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.Guid	networkID	Network ID.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindFaceByPackList(Guid, String, SmartListBehavior, QueryParameter[])

Finds available faces by pack list.

Declaration

SmartList FindFaceByPackList(Guid sessionID, string clientCultureName, SmartListBehavior smartListBehavior, QueryParameter[] parameters)

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.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.
Ayuda.BMS.Shared.QueryParameter[]	parameters	Filter parameters.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	A smart list containing matching faces

FindFaceBySalesContractNumber(Guid, String, String, SmartListBehavior)

Finds all faces booked in a specified Sales Contract.

Declaration

SmartList FindFaceBySalesContractNumber(Guid sessionID, string clientCultureName, string salesContractNumber, SmartListBehavior smartListBehavior)

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	Sales Contract Number.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindFaceBySalesMarketID(Guid, String, Guid, SmartListBehavior)

Finds all faces by Sales Market.

Declaration

SmartList FindFaceBySalesMarketID(Guid sessionID, string clientCultureName, Guid salesMarketID, SmartListBehavior smartListBehavior)

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.Guid	salesMarketID	Sales Market ID.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

FindFaceLocationTypeAll(Guid, String, Byte[])

Retrieves all face location types.

Declaration

FaceLocationTypeListDataSet FindFaceLocationTypeAll(Guid sessionID, string clientCultureName, byte[] timeStamp)

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.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.FaceLocationTypeListDataSet	Ayuda.BMS.Lists.Models.FaceLocationTypeListDataSet.

FindFaceSummary(Guid, String, Guid)

Retrieves a face summary.

Declaration

FaceSummaryListDataSet FindFaceSummary(Guid sessionID, string clientCultureName, Guid faceID)

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.Guid	faceID	Face ID.

Returns

Type	Description
Ayuda.BMS.Lists.Models.FaceSummaryListDataSet	Ayuda.BMS.Lists.Models.FaceSummaryListDataSet.

FindFaceUsingSmartChart(Guid, String, SmartListBehavior, QueryParameter[])

Finds available faces using the SmartChart functionality.

Declaration

SmartList FindFaceUsingSmartChart(Guid sessionID, string clientCultureName, SmartListBehavior smartListBehavior, QueryParameter[] parameters)

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.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.
Ayuda.BMS.Shared.QueryParameter[]	parameters	Filter parameters.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	A smart list containing matching faces

FindInactiveReasonAll(Guid, String, Byte[])

Retrieves all inactive reasons.

Declaration

InactiveReasonListDataSet FindInactiveReasonAll(Guid sessionID, string clientCultureName, byte[] timeStamp)

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.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.InactiveReasonListDataSet	Ayuda.BMS.Lists.Models.InactiveReasonListDataSet.

FindMediaTypeAll(Guid, String, Byte[])

Retrieves all media types.

Declaration

MediaTypeListDataSet FindMediaTypeAll(Guid sessionID, string clientCultureName, byte[] timeStamp)

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.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.MediaTypeListDataSet	Ayuda.BMS.Lists.Models.MediaTypeListDataSet.

FindMediaTypeGroupAll(Guid, String, Byte[])

Retrieves all media type groups.

Declaration

MediaTypeGroupListDataSet FindMediaTypeGroupAll(Guid sessionID, string clientCultureName, byte[] timeStamp)

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.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.MediaTypeGroupListDataSet	Ayuda.BMS.Lists.Models.MediaTypeGroupListDataSet.

FindOpsTaskSubTypeAll(Guid, String, Byte[])

Retrieves all ops tasks sub-types.

Declaration

OpsTaskSubTypeListDataSet FindOpsTaskSubTypeAll(Guid sessionID, string clientCultureName, byte[] timeStamp)

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.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.OpsTaskSubTypeListDataSet	Ayuda.BMS.Lists.Models.OpsTaskSubTypeListDataSet.

FindPhotoByCampaign(Guid, String, Guid)

Finds a list of photos by campaign.

Declaration

PhotoListDataSet FindPhotoByCampaign(Guid sessionID, string clientCultureName, Guid campaignID)

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.Guid	campaignID	Campaign ID.

Returns

Type	Description
Ayuda.BMS.Lists.Models.PhotoListDataSet	Ayuda.BMS.Lists.Models.PhotoListDataSet.

FindPostingCompanyAll(Guid, String, Byte[])

Retrieves all posting companies.

Declaration

PostingCompanyListDataSet FindPostingCompanyAll(Guid sessionID, string clientCultureName, byte[] timeStamp)

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.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.PostingCompanyListDataSet	Ayuda.BMS.Lists.Models.PostingCompanyListDataSet.

FindPropertyAll(Guid, String, Byte[])

Retrieves all attributes.

Declaration

PropertyListDataSet FindPropertyAll(Guid sessionID, string clientCultureName, byte[] timeStamp)

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.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.PropertyListDataSet	Ayuda.BMS.Lists.Models.PropertyListDataSet.

FindReasonLateAll(Guid, String, Byte[])

Retrieves all reasons late.

Declaration

ReasonLateListDataSet FindReasonLateAll(Guid sessionID, string clientCultureName, byte[] timeStamp)

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.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.ReasonLateListDataSet	Ayuda.BMS.Lists.Models.ReasonLateListDataSet.

FindReferenceData(Guid, String, Query[])

Declaration

List<KeyValuePair<string, int>> FindReferenceData(Guid sessionID, string clientCultureName, Query[] queries)

Parameters

Type	Name	Description
System.Guid	sessionID
System.String	clientCultureName
Ayuda.BMS.Shared.Query[]	queries

Returns

Type	Description
System.Collections.Generic.List<System.Collections.Generic.KeyValuePair<System.String, System.Int32>>

FindSalesContractItemByCampaign(Guid, String, Guid)

Finds all segments by campaign.

Declaration

SalesContractItemListDataSet FindSalesContractItemByCampaign(Guid sessionID, string clientCultureName, Guid campaignID)

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.Guid	campaignID	Campaign ID.

Returns

Type	Description
Ayuda.BMS.Lists.Models.SalesContractItemListDataSet	Ayuda.BMS.Lists.Models.SalesContractItemListDataSet.

FindSalesContractItemTripByCampaign(Guid, String, Guid)

Finds all segment trips by campaign.

Declaration

SalesContractItemTripListDataSet FindSalesContractItemTripByCampaign(Guid sessionID, string clientCultureName, Guid campaignID)

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.Guid	campaignID	Campaign ID.

Returns

Type	Description
Ayuda.BMS.Lists.Models.SalesContractItemTripListDataSet	Ayuda.BMS.Lists.Models.SalesContractItemTripListDataSet.

FindSalesContractItemTripBySalesContractItem(Guid, String, Guid)

Finds all segment trips by segment.

Declaration

SalesContractItemTripListDataSet FindSalesContractItemTripBySalesContractItem(Guid sessionID, string clientCultureName, Guid salesContractItemID)

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.Guid	salesContractItemID	Segment ID.

Returns

Type	Description
Ayuda.BMS.Lists.Models.SalesContractItemTripListDataSet	Ayuda.BMS.Lists.Models.SalesContractItemTripListDataSet.

FindSalesContractItemTripSummary(Guid, String, Guid)

Retrieves a segment trip summary.

Declaration

SalesContractItemTripSummaryListDataSet FindSalesContractItemTripSummary(Guid sessionID, string clientCultureName, Guid salesContractItemTripID)

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.Guid	salesContractItemTripID	Segment trip ID.

Returns

Type	Description
Ayuda.BMS.Lists.Models.SalesContractItemTripSummaryListDataSet	Ayuda.BMS.Lists.Models.SalesContractItemTripSummaryListDataSet.

FindSalesMarketAll(Guid, String, Byte[])

Retrieves all sales markets.

Declaration

SalesMarketListDataSet FindSalesMarketAll(Guid sessionID, string clientCultureName, byte[] timeStamp)

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.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.SalesMarketListDataSet	Ayuda.BMS.Lists.Models.SalesMarketListDataSet.

FindScalar(Guid, String, Query)

Invokes a custom query, returning a scalar result.

Declaration

object FindScalar(Guid sessionID, string clientCultureName, Query query)

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.Shared.Query	query	Custom query.

Returns

Type	Description
System.Object	System.Object.

FindSelectionByCampaign(Guid, String, Guid)

Retrieves bookings and postings for a campaign.

Declaration

SelectionListDataSet FindSelectionByCampaign(Guid sessionID, string clientCultureName, Guid campaignID)

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.Guid	campaignID	Campaign ID.

Returns

Type	Description
Ayuda.BMS.Lists.Models.SelectionListDataSet	Ayuda.BMS.Lists.Models.SelectionListDataSet.

FindVehicleLocationBySalesContractItemTrip(Guid, String, Guid)

Finds vehicle locations by a segment trip.

Declaration

SalesContractItemTripSummaryListDataSet FindVehicleLocationBySalesContractItemTrip(Guid sessionID, string clientCultureName, Guid salesContractItemTripID)

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.Guid	salesContractItemTripID	Segment trip ID.

Returns

Type	Description
Ayuda.BMS.Lists.Models.SalesContractItemTripSummaryListDataSet	Ayuda.BMS.Lists.Models.SalesContractItemTripSummaryListDataSet.

FindVendorAll(Guid, String, Byte[])

Retrieves all vendors.

Declaration

VendorListDataSet FindVendorAll(Guid sessionID, string clientCultureName, byte[] timeStamp)

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.Byte[]	timeStamp	Timestamp of the last previously retrieved entity or a byte array containing a zero.

Returns

Type	Description
Ayuda.BMS.Lists.Models.VendorListDataSet	Ayuda.BMS.Lists.Models.VendorListDataSet.

FindWeatherStatsByClosestLatLong(Guid, String, Double, Double, DateTime)

Retrieves weather statistics.

Declaration

WeatherStatsListDataSet FindWeatherStatsByClosestLatLong(Guid sessionID, string clientCultureName, double latitude, double longitude, DateTime date)

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.Double	latitude	Latitude.
System.Double	longitude	Longitude.
System.DateTime	date	Date.

Returns

Type	Description
Ayuda.BMS.Lists.Models.WeatherStatsListDataSet	Ayuda.BMS.Lists.Models.WeatherStatsListDataSet.

Remarks

This method will retrieve weather information from a weather station nearest from the specified location.

GetAPBatchTransferInformation(Guid, String, Guid, TransferType)

Retrieves leasing batch information.

Declaration

APTransferInformationDataSet GetAPBatchTransferInformation(Guid sessionID, string clientCultureName, Guid apBatchID, TransferType transferType)

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.Guid	apBatchID	Batch ID
Ayuda.BMS.Shared.TransferType	transferType	Transfer type

Returns

Type	Description
Ayuda.BMS.Lists.Models.APTransferInformationDataSet	Ayuda.BMS.Lists.Models.APTransferInformationDataSet.

GetARBatchTransferInformation(Guid, String, Guid, TransferType)

Retrieves invoicing batch information.

Declaration

ARTransferInformationDataSet GetARBatchTransferInformation(Guid sessionID, string clientCultureName, Guid arBatchID, TransferType transferType)

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.Guid	arBatchID	Batch ID
Ayuda.BMS.Shared.TransferType	transferType	Transfer type

Returns

Type	Description
Ayuda.BMS.Lists.Models.ARTransferInformationDataSet	Ayuda.BMS.Lists.Models.ARTransferInformationDataSet.

GetDesignSelectionPhotoAudioBytes(Guid, String, Guid)

Retrieves audio matching a posting photo.

Declaration

byte[] GetDesignSelectionPhotoAudioBytes(Guid sessionID, string clientCultureName, Guid designSelectionPhotoID)

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.Guid	designSelectionPhotoID	Posting photo id.

Returns

Type	Description
System.Byte[]	Audio bytes.

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

Returns a posting photo.

Declaration

byte[] GetDesignSelectionPhotoImageBytes(Guid sessionID, string clientCultureName, Guid designSelectionPhotoID, int? maxWidth, int? maxHeight)

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.Guid	designSelectionPhotoID	Posting photo id.
System.Nullable<System.Int32>	maxWidth	Maximum width (image will be resized if bigger).
System.Nullable<System.Int32>	maxHeight	Maximum height (image will be resized if bigger).

Returns

Type	Description
System.Byte[]	Image bytes.

GetDesignSelectionPhotoImageBytesMaxResolution(Guid, String, Guid)

Returns a posting photo at maximum resolution.

Declaration

byte[] GetDesignSelectionPhotoImageBytesMaxResolution(Guid sessionID, string clientCultureName, Guid designSelectionPhotoID)

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.Guid	designSelectionPhotoID	The design selection photo identifier.

Returns

Type	Description
System.Byte[]	Image bytes.

GetFacePhotoSheetImageBytes(Guid, String, Guid, Int32, Int32)

Retrieves the default photosheet for a face.

Declaration

byte[] GetFacePhotoSheetImageBytes(Guid sessionID, string clientCultureName, Guid faceID, int maxWidth, int maxHeight)

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.Guid	faceID	Face ID.
System.Int32	maxWidth	Maximum width (image will be resized if bigger).
System.Int32	maxHeight	Maximum height (image will be resized if bigger).

Returns

Type	Description
System.Byte[]	Image bytes.

GetFileBytes(Guid, String, Guid)

Retrieves a file.

Declaration

byte[] GetFileBytes(Guid sessionID, string clientCultureName, Guid fileID)

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.Guid	fileID	File ID.

Returns

Type	Description
System.Byte[]	File bytes.

GetImageBytes(Guid, String, Guid, Boolean)

Retrieves an image.

Declaration

byte[] GetImageBytes(Guid sessionID, string clientCultureName, Guid fileID, bool thumbnails)

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.Guid	fileID	Image file ID.
System.Boolean	thumbnails	True if thumbnail is requested, false for the full-sized image.

Returns

Type	Description
System.Byte[]	Image bytes.

GetNextRows(Guid, String, Guid)

Retrieves next rows for paged queries.

Declaration

SmartList GetNextRows(Guid sessionID, string clientCultureName, Guid key)

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.Guid	key	Result set ID.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.

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

Retrieves photo image bytes.

Declaration

byte[] GetPhotoImageBytes(Guid sessionID, string clientCultureName, Guid photoID, int? maxWidth, int? maxHeight)

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.Guid	photoID	Photo ID.
System.Nullable<System.Int32>	maxWidth	Maximum width (image will be resized if bigger).
System.Nullable<System.Int32>	maxHeight	Maximum height (image will be resized if bigger).

Returns

Type	Description
System.Byte[]	Image bytes.

GetPhotoImageBytesMaxResolution(Guid, String, Guid)

Retrieves photo image bytes at maximum resolution.

Declaration

byte[] GetPhotoImageBytesMaxResolution(Guid sessionID, string clientCultureName, Guid designSelectionPhotoID)

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.Guid	designSelectionPhotoID	Photo ID.

Returns

Type	Description
System.Byte[]	Image bytes.

GetReportDefinition(Guid, String, String)

Retrieves a report definition.

Declaration

byte[] GetReportDefinition(Guid sessionID, string clientCultureName, string reportName)

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	reportName	Report name.

Returns

Type	Description
System.Byte[]	System.Byte[][].

GetSalesContractItemPhotoAudioBytes(Guid, String, Guid)

Retrieves audio matching a segment photo.

Declaration

byte[] GetSalesContractItemPhotoAudioBytes(Guid sessionID, string clientCultureName, Guid SalesContractItemPhotoID)

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.Guid	SalesContractItemPhotoID	Segment photo ID.

Returns

Type	Description
System.Byte[]	Image bytes.

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

Retrieves a segment photo.

Declaration

byte[] GetSalesContractItemPhotoImageBytes(Guid sessionID, string clientCultureName, Guid salesContractItemPhotoID, int? maxWidth, int? maxHeight)

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.Guid	salesContractItemPhotoID	The sales contract item photo identifier.
System.Nullable<System.Int32>	maxWidth	Maximum width (image will be resized if bigger).
System.Nullable<System.Int32>	maxHeight	Maximum height (image will be resized if bigger).

Returns

Type	Description
System.Byte[]	Image bytes.

GetSalesContractItemPhotoImageBytesMaxResolution(Guid, String, Guid)

Retrieves a segment photo at maximum resolution.

Declaration

byte[] GetSalesContractItemPhotoImageBytesMaxResolution(Guid sessionID, string clientCultureName, Guid salesContractItemPhotoID)

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.Guid	salesContractItemPhotoID	The sales contract item photo identifier.

Returns

Type	Description
System.Byte[]	Image bytes.

Search(Guid, String, Query, SmartListBehavior)

Invokes a custom query, returning a smart list.

Declaration

SmartList Search(Guid sessionID, string clientCultureName, Query query, SmartListBehavior smartListBehavior)

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.Shared.Query	query	Custom query.
Ayuda.BMS.Lists.SmartListBehavior	smartListBehavior	Defines the smart list behavior.

Returns

Type	Description
Ayuda.BMS.Lists.SmartList	Ayuda.BMS.Lists.SmartList.