Web Service Types

A Web Service is a method of communication between electronic devices over the web. This communication can be used to add, update or retrieve data from the data base. The Data Exchange Web Services provide the following types of services:

  • A 'Put' Web Service provides the user the ability to add or update information within Spectrum.
  • A 'Get' Web Service provide the user the ability to define a specific set of parameters which then returns the defined data for the user to use.

The Authorization ID associated with a 'Get' Web Service requires a Spectrum operator to provide access based on the operator's job based security and cost center logic. The Parameter fields are the available selection criteria used to collect the data. The Return fields are the results provided back from the web service.

Each 'Get web service contains three fields at the end of each return layout that is used to provide information regarding any errors that may occur. The fields are defined as:

  • Error_Code – displays the web service sync status code. The same codes are used with the Spectrum Office Add-in in the Sync_Status column.
  • Error_Description – displays the associated description that applies to the error that is occurring.
  • Error_Column – displays the parameter field name that is causing the error.

An example would be as follows:

  • Error_Code = E
  • Error_Description = The web service is not Authorized
  • Error_Column = Authorization_ID