Documentation & Nomenclature


Our goal is to make this documentation usable above all other goals. If you have any suggestions to improve this document, please forward them to NetOps@ECGrid.com.

Data Types

All parameters are required for each web service call. In some cases, default values may be used as indicated when a value itself is optional.

All data types are listed in Visual Basic format for simplicity.

Strings

Wherever necessary Strings are listed with their minimum and maximum lengths using the following format:

    String(min,max)

If this String is fixed length, it is listed as follows:

    String(len)

Integers

The following table describes the integer types used throughout ECGridOS.

Integer Size Values
Byte 1 Byte 0-255
Short 2 Bytes -32,768 through 32,767 (signed)
Integer 4 Bytes -2,147,483,648 through 2,147,483,647
Long 8 Bytes -9,223,372,036,854,775,808 through 9,223,372,036,854,775,807

Boolean

Boolean true/false values are used within the system. Your system might interpret these as integer zero (false) and non-zero (true) values or some other way.

Objects

ECGridOS makes extensive use of Objects to return complex information, and to guarantee a consistent response format. Please familiarize yourself with the class structures used throughout ECGridOS.

Uploading & Downloading Files

When uploading and downloading files Byte Arrays are used: byte(). The .NET Framework automatically converts this data type into BASE64 encoding for transport. A convenient web site for on-line ASCII to BASE64 conversion is located at http://www.paulschou.com/tools/xlate/.


© 2008-2011, Loren Data Corp.
All rights reserved.
ECGrid is a registered service mark of Loren Data Corp.
ECGridOS is a service mark of Loren Data Corp.