API Web Services
Viewpoint created the Data Exchange Web Services to provide a secure, quick, and easy way to transfer data into Spectrum Construction Software. Using the Web Service’s three components will streamline time-consuming data entry processes via a secure web connection.
The Spectrum Data Exchange’s Web Service contains three components:
- Web Services
- Authorization ID with optional settings
- Spectrum Office Add-in tool
A Web Service is a method of communication between electronic devices over the web. Within Spectrum we have created a group of List of Web Services, and each one has predefined layouts with specific requirements and validation rules for the field names. The Web Services can be accessed using our Spectrum Office Add-In tool, which links data via Microsoft® Excel®, or by connecting with a third-party website.
The structure and functionality for each Web Services (API) is unique for each service and is subject to change. The functionality of the Web Services will not exactly match the existing entry points within Spectrum, see the individual Web Service documentation under Web Service’s Layouts for more information.
The secure Authorization ID is created in the Data Exchange Installation screen and provides access to the individual Web Services to send data to Spectrum. The Authorization ID can be set up for specific companies and Web Services. You can define specific options such as default options for field names, mapping user-defined fields, or creating counter overrides.
To learn more about Authorization ID, refer to the Authorization Setup manual for information on setting up and using an Authorization ID.
The Spectrum Office Add-in allows you to use Excel to create the necessary files to import into Spectrum via our Web Services within the Data Exchange module. The Spectrum Office Add-in needs to be updated (e.g., downloaded and installed) after each new release of Spectrum v14 is installed. Each Web Service has its own template that can be used to bring data into Spectrum. Each Web Service is defined below with specific requirements and validation rules for field names.
To learn more about the Office Add-in tool, refer to the Spectrum Office Add-in manual for information on installation, usage and sync status codes.
The Data Exchange Web Services has a predefined operator (e.g., *WS) that is defined during installation. The Operator ID displays anywhere an Operator ID is needed when a Web Service is used to import data into Spectrum.
The Data Exchange Web Service contains a validation hierarchy. Each Web Service follows the same logic and provides error reporting at each level. The logic is as follows:
- Authorization and required fields.
- Numeric, date, and generic validation (such as lengths, field type, field mask, defaults, and user-defined fields mapping).
- Validation that applies to the specific Web Service.