Management

Service for managing the WIP instance.

ChangeAddressLookupProvider

Change address lookup provider.

Input

  • provider Mandatory

    Provider name found in the unity.config file.

    string

Output

Retruns Aptic.WebIntegrationPlatform.Soap.SystemSettingResult object with result code and error message (if any).
Object

SystemSettingResult

Result from a system setting operation.

  • ErrorMessage

    Error message.

    string

  • ResultCode Mandatory

    Result code, 0 = good, x > 0 = bad.

    int

  • Value

    If the method returns a value, it will be found here.

    string

ChangeCreditInfoProvider

Change credit information provider.

Input

  • provider Mandatory

    Provider name found in the unity.config file.

    string

Output

Retruns Aptic.WebIntegrationPlatform.Soap.SystemSettingResult object with result code and error message (if any).
Object

SystemSettingResult

Result from a system setting operation.

  • ErrorMessage

    Error message.

    string

  • ResultCode Mandatory

    Result code, 0 = good, x > 0 = bad.

    int

  • Value

    If the method returns a value, it will be found here.

    string

GetAddressLookupProvider

Gets current address lookup provider.

Output

Retruns Aptic.WebIntegrationPlatform.Soap.SystemSettingResult with the name of the provider.
Object

SystemSettingResult

Result from a system setting operation.

  • ErrorMessage

    Error message.

    string

  • ResultCode Mandatory

    Result code, 0 = good, x > 0 = bad.

    int

  • Value

    If the method returns a value, it will be found here.

    string

GetCreditInfoProvider

Gets current credit info provider.

Output

Retruns Aptic.WebIntegrationPlatform.Soap.SystemSettingResult with the name of the provider.
Object

SystemSettingResult

Result from a system setting operation.

  • ErrorMessage

    Error message.

    string

  • ResultCode Mandatory

    Result code, 0 = good, x > 0 = bad.

    int

  • Value

    If the method returns a value, it will be found here.

    string

GetStatus

Returns the status of the current Integration Platform instance.

Output

Status of WIP
Object

StatusResult

Status result.

  • CurrentRequestCount Mandatory

    Current number of concurrent connections to the Integration Platform instance.

    int

  • IsMainDataSynchronizer Mandatory

    True if this instance is the main data syncronizer.

    bool

  • Uptime Mandatory

    Uptime of the Integration Platform instance measured in milliseconds.

    long

GetSystemSetting

Get a system setting.
Legacy, currently not in use, might change in the future.

Input

  • key Mandatory

    Key.

    string

Output

Retruns Aptic.WebIntegrationPlatform.Soap.SystemSettingResult with the value.
Object

SystemSettingResult

Result from a system setting operation.

  • ErrorMessage

    Error message.

    string

  • ResultCode Mandatory

    Result code, 0 = good, x > 0 = bad.

    int

  • Value

    If the method returns a value, it will be found here.

    string

PrepareForShutdown

Prepares the Integration Platform instance for shutdown.
The Integration Platform shuts down its interface, new incomming connections and lets the running connections to finish.

Output

Number of current concurrent connections.

int

RemoveSetting

Remove a system setting.
Legacy, currently not in use, might change in the future.

Input

  • key Mandatory

    Key.

    string

Output

Retruns Aptic.WebIntegrationPlatform.Soap.SystemSettingResult object with result code and error message (if any).
Object

SystemSettingResult

Result from a system setting operation.

  • ErrorMessage

    Error message.

    string

  • ResultCode Mandatory

    Result code, 0 = good, x > 0 = bad.

    int

  • Value

    If the method returns a value, it will be found here.

    string

SetSystemSetting

Set a system setting.
Legacy, currently not in use, might change in the future.

Input

  • key Mandatory

    Key.

    string

  • value Mandatory

    Value.

    string

Output

Retruns Aptic.WebIntegrationPlatform.Soap.SystemSettingResult object with result code and error message (if any).
Object

SystemSettingResult

Result from a system setting operation.

  • ErrorMessage

    Error message.

    string

  • ResultCode Mandatory

    Result code, 0 = good, x > 0 = bad.

    int

  • Value

    If the method returns a value, it will be found here.

    string

Shutdown

Shuts down Integration Platform.
If any reqeusts are still executing those request will be allowed to finish, same goes for background threads. This is the "nice" way to shut down WIP. It's not necessary to run Aptic.WebIntegrationPlatform.Soap.IManagement.PrepareForShutdown before this, but its nice to do so.

UpdateConfiguration

Update a configuration value.

Input

  • module Mandatory

    Module to update.

    string

  • key Mandatory

    Key.

    string

  • value Mandatory

    New value.

    string

Output

Retruns Aptic.WebIntegrationPlatform.Soap.SystemSettingResult object with result code and error message (if any).
Object

SystemSettingResult

Result from a system setting operation.

  • ErrorMessage

    Error message.

    string

  • ResultCode Mandatory

    Result code, 0 = good, x > 0 = bad.

    int

  • Value

    If the method returns a value, it will be found here.

    string