Interface IErpConnectorWS

EIS Connector, WCF Interface declaration

Namespace: SuperOffice.ErpSync
Assembly: SuperOffice.Plugins.dll
Syntax
public interface IErpConnectorWS

Methods

WSCreateActor(CreateActorRequestWS)

Creates a new actor

Declaration
ActorPluginResponseWS WSCreateActor(CreateActorRequestWS request)
Parameters
Type Name Description
CreateActorRequestWS request
Returns
Type Description
ActorPluginResponseWS

WSDeleteConnection(RequestBaseWS)

Tells the Connector that a connection has been deleted from EIS, in case the Connector needs to know and take some action.

Declaration
ConnectorResultBaseWS WSDeleteConnection(RequestBaseWS request)
Parameters
Type Name Description
RequestBaseWS request
Returns
Type Description
ConnectorResultBaseWS

WSGetActors(GetActorsRequestWS)

Retrieves actors based on primary key and actor type

Declaration
ActorArrayPluginResponseWS WSGetActors(GetActorsRequestWS request)
Parameters
Type Name Description
GetActorsRequestWS request
Returns
Type Description
ActorArrayPluginResponseWS

WSGetActorsByTimestamp(GetActorsByTimestampRequestWS)

Retrieves all actors of a specified actor type updated on or after a given date and time.

Declaration
ActorArrayPluginResponseWS WSGetActorsByTimestamp(GetActorsByTimestampRequestWS request)
Parameters
Type Name Description
GetActorsByTimestampRequestWS request
Returns
Type Description
ActorArrayPluginResponseWS

WSGetConfigData()

Asks the connector what fields are needed to set up a new connection (e.g. database, username and password)

Declaration
FieldMetadataInfoArrayPluginResponseWS WSGetConfigData()
Returns
Type Description
FieldMetadataInfoArrayPluginResponseWS

WSGetList(GetListRequestWS)

Retrieves a list from the connector, using the name specified by the connector itself

Declaration
ListItemArrayPluginResponseWS WSGetList(GetListRequestWS request)
Parameters
Type Name Description
GetListRequestWS request
Returns
Type Description
ListItemArrayPluginResponseWS

WSGetListItems(GetListItemsRequestWS)

Retrieves one or more specific list items from the connector, using the list name specified by the connector itself

Declaration
ListItemArrayPluginResponseWS WSGetListItems(GetListItemsRequestWS request)
Parameters
Type Name Description
GetListItemsRequestWS request
Returns
Type Description
ListItemArrayPluginResponseWS

WSGetSearchableFields(GetSearchableFieldsRequestWS)

Retrieves a list of searchable fields for a given actor type

Declaration
StringArrayPluginResponseWS WSGetSearchableFields(GetSearchableFieldsRequestWS request)
Parameters
Type Name Description
GetSearchableFieldsRequestWS request
Returns
Type Description
StringArrayPluginResponseWS

WSGetSupportedActorTypeFields(GetSupportedActorTypeFieldsRequestWS)

Gets a list of fields that are available for a given connection and a given actor type

Declaration
FieldMetadataInfoArrayPluginResponseWS WSGetSupportedActorTypeFields(GetSupportedActorTypeFieldsRequestWS request)
Parameters
Type Name Description
GetSupportedActorTypeFieldsRequestWS request
Returns
Type Description
FieldMetadataInfoArrayPluginResponseWS

WSGetSupportedActorTypes(RequestBaseWS)

Gets the supported actor types for a given connection

Declaration
StringArrayPluginResponseWS WSGetSupportedActorTypes(RequestBaseWS request)
Parameters
Type Name Description
RequestBaseWS request
Returns
Type Description
StringArrayPluginResponseWS

WSSaveActors(SaveActorsRequestWS)

Saves (updates) existing actors

Declaration
ActorArrayPluginResponseWS WSSaveActors(SaveActorsRequestWS request)
Parameters
Type Name Description
SaveActorsRequestWS request
Returns
Type Description
ActorArrayPluginResponseWS

WSSaveConnection(SaveConnectionRequestWS)

Creates a new connection, or updates an existing one

Declaration
ConnectorResultBaseWS WSSaveConnection(SaveConnectionRequestWS request)
Parameters
Type Name Description
SaveConnectionRequestWS request
Returns
Type Description
ConnectorResultBaseWS

WSSearchActorByParent(SearchActorByParentRequestWS)

Searches for one or more actors given a search string

Declaration
ActorArrayPluginResponseWS WSSearchActorByParent(SearchActorByParentRequestWS request)
Parameters
Type Name Description
SearchActorByParentRequestWS request
Returns
Type Description
ActorArrayPluginResponseWS

WSSearchActors(SearchActorsRequestWS)

Searches for one or more actors given a search string

Declaration
ActorArrayPluginResponseWS WSSearchActors(SearchActorsRequestWS request)
Parameters
Type Name Description
SearchActorsRequestWS request
Returns
Type Description
ActorArrayPluginResponseWS

WSSearchActorsAdvanced(SearchActorsAdvancedRequestWS)

Searches for one or more actors given a search string

Declaration
ActorArrayPluginResponseWS WSSearchActorsAdvanced(SearchActorsAdvancedRequestWS request)
Parameters
Type Name Description
SearchActorsAdvancedRequestWS request
Returns
Type Description
ActorArrayPluginResponseWS

WSTestConfigData(TestConfigDataRequestWS)

Creates a new connection, or updates an existing one

Declaration
ConnectorResultBaseWS WSTestConfigData(TestConfigDataRequestWS request)
Parameters
Type Name Description
TestConfigDataRequestWS request
Returns
Type Description
ConnectorResultBaseWS

WSTestConnection(RequestBaseWS)

Checks if the given connection ID is valid (is the connection up, is the configuration data correct, etc)

Declaration
ConnectorResultBaseWS WSTestConnection(RequestBaseWS request)
Parameters
Type Name Description
RequestBaseWS request
Returns
Type Description
ConnectorResultBaseWS

Extension Methods

EnumUtil.MapEnums<From, To>(From)