SOAP Instruction Set

Details
Category: API Documentation

It is simple to get an overview of the supported instruction set that can be processed by the EazyWebServer. Just open your browser and go to:

http://xxx.eazyworks.com/EazyWebService.asmx

Where xxx.eazyworks.com is the address for you MES application.

The browser will show you an overview of all supported functions. You can drill down for each function to see the SOAP formats and needed arguments.

Supported instructions

Examples of instructions that are supported:

  1. Hello World: Test instruction
  2. mFR_MoveToStep : Is used to move travelers around
    1. Sample : {"sFR":"FR10-000000999", "sSF":"next", "bNoChecks":false, "bConfirm":false, "bConfirmAttach":false}
      1. sFR : is the FR Job Number
      2. sSF :  is the SF Job Number or, "next", "prev", "first" are built in shortcuts
      3. bNoChecks: will tell the system if it should check for required data
      4. bConfirm:will come back with a return object to confirm it can move if it can
      5. bConfirmAttach: will confirm files are attached
  3.  mFR_NV_JSON_Loader : Is used to update data at a step on a Traveler, supports file uploads as well.
  4. mGenerateFile: Will return the result of the MES Query as a file. Dependent on the sFileType attribute, it will return the file in CSV or XLS format.
  5. mGenerateJSON : Will return the result of the MES Query as a single string in JSON format.
  6. mGetServerObj: Gets JSON data for this application
  7. mGet_OBJ : Gets the JS Obj for the Job Supplied
    1. Sample :{"sJob":"FR10-000000999"} 
      1. sJob is the ID of the Job Object
      2. oServer: can also be passed in to get Server Info
  8.  mJobFile : Will get files from the system based on the Job they are attached to.
    1. Sample: {"sJob":"DC10-000004", "sFile":"all"}
    2. Sample: {"sJob":"DC10-000004", "sFile":"all", "sOutput":"zip"}
    3. Sample: {"sJob":"DC10-000004", "sSearch":"*.doc", "sFile":"all", "sOutput":"zip"}
      1. sJob : is the ID of the Job Object
      2. sFile: is the name of the file you want or "all" for all files.
      3. sSearch: is optional and if defined can be used to filter out files.
      4. sOutput: if defined and set to "zip" will zip the files before encoding.
    4. Output Format: [{"sFileName":"File Name.txt", "sBinary":[208,207,17,.........]}, {"sFileName":"File Name3.txt", "sBinary":[204,207,17,.........]}]
  9.  mLogIn 
  10.  mLogOut
  11. mTestPassKey: will test the user credentials

Example Syntax for mGenerateFile

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values. mes.acme.com is the web address for the MES application.

Outgoing SOAP message

POST /eazywebservice.asmx HTTP/1.1

Host: mes.acme.com

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

 

    http://eazyworks.com">

      string

      string

      string

      string

      string

      string

      string

   

Returned SOAP message

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

 

    http://eazyworks.com">

      base64Binary

   

All the Input arguments in the SOAP envelop are the same as the input arguments in the EZ_SoapReaderApplication.

 

Useful Links