Import Web Service

Web Service: ImportService

Target Namespace:         http://import.wms.jx2.com/jaws

Port ImportServicePort

Protocol:             SOAP

Default style:    rpc

Transport protocol:         SOAP over HTTP

Operations:

  1. authenticateAndImportFile
  2. importFile
  3. login

1.       authenticateAndImportFile

Operations

Port type ImportService

Operation type:               Request-response. The endpoint receives a message, and sends a correlated message.

Description:       Performs both the “login” and “importFile” methods. Where login is successful with the given username and password, decodes the given a base64 encoded string with the import type and FileFormatAdapterType parameters.

Input:                    ImportService_authenticateAndImportFile (soap:body, use = literal)

username type string
password type string
base64file type string
importTypeName type string
adapterName type string

Output:                ImportService_authenticateAndImportFileResponse (soap:body, use = literal)

result type ImportResponse
message – nillable; type string
status – nillable; type string

Example Response 1:     status: SUCCESS
message: Import successful: N rows evaluated

Example Response 2:     status: ERROR
message: Invalid Login

Example Response 3:     status: ERROR
message: Error – could not match ‘importTypeName’ to an ImportType. Import was unsuccessful

Example Response 4:     status: ERROR
message: Error – could not match ‘adapterName’ to an FileFormatAdapterType. Import was unsuccessful

Example Response 5:     status: ERROR
message: Error – ‘exceptionMessage’. Import was unsuccessful

2.       importFile

Operation type:               Request-response. The endpoint receives a message, and sends a correlated message.

Description:       Given a base64 encoded string, an import type of the file received for import, and a FileFormatAdapterType for identifying the source the file was sent from. The file’s data is imported into the system.

Input:                    ImportService_importFile (soap:body, use = literal)

base64file type string
importTypeName type string
adapterName type string

Output:                ImportService_importFileResponse (soap:body, use = literal)

result type ImportResponse
message – nillable; type string
status – nillable; type string

Example Response 1:     status: SUCCESS
message: Import successful: N rows evaluated

Example Response 2:     status: ERROR
message: Error – could not match ‘importTypeName’ to an ImportType. Import was unsuccessful

Example Response 3:     status: ERROR
message: Error – could not match ‘adapterName’ to an FileFormatAdapterType. Import was unsuccessful

Example Response 4:     status: ERROR
message: Error – ‘exceptionMessage’. Import was unsuccessful

3.       login

Operation type:               Request-response. The endpoint receives a message, and sends a correlated message.

Description:       Attempts to login a system user given the username and password. ** Required to be called before all other methods! (excluding authenticateAndImportFile, as it calls this method)**

Input:    ImportService_login (soap:body, use = literal)

username type string
password type string

Output:                ImportService_loginResponse (soap:body, use = literal)

result type ImportResponse
message – nillable; type string
status – nillable; type string

Example Response 1:     status: SUCCESS
message: ‘generatedAuthKey’

Example Response 2:     status: ERROR
message: Invalid Login

WSDL source code

ImportWebService