Setting up the APS Web Service Client Sample

Get started on running the APS Web Service Client Sample for using the APS SOAP APIs

For information on the Web Service Listeners set up, see our knowledge base article on Setting up the CTP Client Sample

Web Service APIs 

The APS Web Service Client Sample contains several APIs that must be activated inside Visual Studio before building and using the project.

APIs Activation

The APS Web Service Client Sample is set to function with only one API activated at a time. To activate an API, you will need to "uncomment" the related function call. To uncomment, remove the leading double slashes "//" from the front of the "Test" function call line of code related to the desired API.

Set up the Web Service Sample Client

Once the file is downloaded, unzip it to your preferred location. Next, open the project in Visual Studio and build it to generate the .exe file. After the build, the executable will be located in the bin\Debug folder of the project. Finally, you can run it using the Windows Command Prompt. In the Command Prompt window, you will need to enter the full path of the file and the specific number of command-line arguments, each separated by a space required by the selected API.

If any entries are blank values or have spaces in them—such as file path—use double quotes to identify them as a single parameter. For example: "C:\Program Files\PTAPSWebServiceClientSample\bin\Debug\PTAPSWebServiceClientSample.exe" argument1 argument2 "argument 3" "" argument5

Note: Each API uses a different set of arguments that must be provided without omission—providing default values if necessary.

Command Line Arguments

The Client Sample uses several Command-Line Arguments to run the individual API call. Each set of arguments specific to the individual API are required—both required AND optional—to be provided in the specified order for the API to work properly. Please reference the individual API article for the specific combination of arguments to use.

  • ExtraServicesURL*:  http://localhost:8788/APSWebService
  • User Name: A PlanetTogether User name with permissions to run selected action
  • Password: The PlanetTogether User's password
  • IntefaceServiceURL*: http://COMPUTERNAME:8019/IPTInterface.soap
  • Item External Id: The external Id value for the item
  • Warehouse External Id: The external Id of the warehouse the item is located in
  • ScenarioType: The scenario type (i.e., Whatif, Live, Published, RuleSeek, InsertJobs, ShortTerm)
  • TimeoutMinutes:  The number of minutes the call should wait to receive a response
  • ScenarioName: - The name of the scenario to which the import should apply
  • ScenarioId: - The scenario Id to which the import should apply
  • CreateScenarioIfNew: - A true or false value indicating whether a new scenario should be created—upon scenario data input validation failure (e.g., No scenario exists with specified name or Id)

*In the ExtraServicesURL & IntefaceServiceURL arguments, the values must match the local setup. The Port number for each must match InstanceManager settings, and the Computer Name must match your local machine.