Interface IArcherSoapAPI

Namespace: Estrelica.Archer.Utility
Assembly: Estrelica.Archer.Utility.dll
Syntax
[StayPublic]
[DoNotObfuscateType]
public interface IArcherSoapAPI

Methods

ClearValuesListValueNumericValue(int)

Declaration
bool ClearValuesListValueNumericValue(int valuesListValueId)
Parameters
int valuesListValueId

Returns
bool

CreateValuesListValue(int, string)

Declaration
int CreateValuesListValue(int valuesListId, string newValueName)
Parameters
int valuesListId

string newValueName

Returns
int

DeleteValuesListValue(int, int)

Declaration
bool DeleteValuesListValue(int valuesListId, int valuesListValueId)
Parameters
int valuesListId

int valuesListValueId

Returns
bool

ExecuteReport(Guid)

Executes a report

Declaration
IEnumerable<string> ExecuteReport(Guid reportGuid)
Parameters
Guid reportGuid

The Guid id of the report to be executed
Returns
IEnumerable<string>

IEnumerable<string> where each string value represents a page of XML results returned by the report

ExecuteReport(Guid, int)

Executes a report, returning a single page of results

Declaration
string ExecuteReport(Guid reportGuid, int pageNumber)
Parameters
Guid reportGuid

The Guid id of the report to be executed
int pageNumber

The page from the report to be returned
Returns
string

A string containing the XML search results returned by the report
Remarks

Note that standard reports, like standard searches, start with page 1

ExecuteReport(int)

Executes a report

Declaration
IEnumerable<string> ExecuteReport(int reportId)
Parameters
int reportId

The integer id of the report to be executed
Returns
IEnumerable<string>

IEnumerable<string> where each string value represents a page of XML results returned by the report

ExecuteReport(int, int)

Executes a report, returning a single page of results

Declaration
string ExecuteReport(int reportId, int pageNumber)
Parameters
int reportId

The integer id of the report to be executed
int pageNumber

The page from the report to be returned
Returns
string

A string containing the XML search results returned by the report
Remarks

Note that standard reports, like standard searches, start with page 1

ExecuteSearch(string)

Executes a dynamic search against the Archer webservices search engine

Declaration
IEnumerable<string> ExecuteSearch(string searchOptionsXml)
Parameters
string searchOptionsXml

The criteria of the search to be performed
Returns
IEnumerable<string>

IEnumerable<string> where each string value represents a page of XML results returned by the search

ExecuteSearch(string, int)

Executes a dynamic search against the Archer webservices search engine, returning a single page of results

Declaration
string ExecuteSearch(string searchOptionsXml, int pageNumber)
Parameters
string searchOptionsXml

The criteria of the search to be performed
int pageNumber

The page number to be returned from the search. This method should be called repeatedly with an incremented pageNumber (starting at 1) until the returned results contain no records.
Returns
string

A string representing the returned search result page in XML format

ExecuteStatisticsReport(Guid)

Executes a statistics report

Declaration
IEnumerable<string> ExecuteStatisticsReport(Guid reportGuid)
Parameters
Guid reportGuid

The Guid id of the statistics report to be executed
Returns
IEnumerable<string>

IEnumerable<string> where each string value represents a page of XML results returned by the report

ExecuteStatisticsReport(Guid, int)

Executes a report, returning a single page of results

Declaration
string ExecuteStatisticsReport(Guid reportGuid, int pageNumber)
Parameters
Guid reportGuid

The Guid id of the report to be executed
int pageNumber

The page from the report to be returned
Returns
string

A string containing the XML search results returned by the report
Remarks

Note that despite what Archer's documentation states, statistics reports start with page 0

ExecuteStatisticsReport(int)

Executes a statistics report

Declaration
IEnumerable<string> ExecuteStatisticsReport(int reportId)
Parameters
int reportId

The integer id of the statistics report to be executed
Returns
IEnumerable<string>

IEnumerable<string> where each string value represents a page of XML results returned by the report

ExecuteStatisticsReport(int, int)

Executes a report, returning a single page of results

Declaration
string ExecuteStatisticsReport(int reportId, int pageNumber)
Parameters
int reportId

The integer id of the statistics report to be executed
int pageNumber

The page from the report to be returned
Returns
string

A string containing the XML search results returned by the report
Remarks

Note that despite what Archer's documentation states, statistics reports start with page 0

GetModuleIdByGuid(Guid, string)

Declaration
int GetModuleIdByGuid(Guid moduleGuid, string instanceName = null)
Parameters
Guid moduleGuid

string instanceName

Returns
int

GetReportSearchOptionsArcher(Guid)

Declaration
string GetReportSearchOptionsArcher(Guid reportGuid)
Parameters
Guid reportGuid

Returns
string

GetReportSearchOptionsArcher(int)

Declaration
string GetReportSearchOptionsArcher(int reportId)
Parameters
int reportId

Returns
string

GetReportsArcher()

Declaration
string GetReportsArcher()
Returns
string

GetUserId(string, string)

Declaration
int GetUserId(string domain, string username)
Parameters
string domain

string username

Returns
int

GetUserWS(int)

Declaration
string GetUserWS(int userId)
Parameters
int userId

Returns
string

UpdateValuesListValueName(int, string)

Declaration
bool UpdateValuesListValueName(int valuesListValueId, string newValueName)
Parameters
int valuesListValueId

string newValueName

Returns
bool

UpdateValuesListValueNameAndNumericValue(int, string, decimal?)

Declaration
bool UpdateValuesListValueNameAndNumericValue(int valuesListValueId, string newValueName, decimal? numericValue)
Parameters
int valuesListValueId

string newValueName

decimal? numericValue

Returns
bool

Extension Methods