Click or drag to resize

AppOne.Services.V2 Namespace

The namespace AppOne.Services.V2 is used to store all entities and classes that are shared across all versions of the version 2.0 interface. This top level namespace contains the base classes and common service exception classes that are used throughout both the Contracts and Methods namespaces.

Classes
 ClassDescription
Public classBaseService Web service base class for working with common and shared routines.
Public classServiceException Class to handle exceptions that are returned from web service requests
Public classServiceRouter The main 2.0 service entry point where all web service references are served. Every active and available services that is available via the API can be seen here.

Do not point production environments at methods tagged **BETA** these endpoints are subject to change.
Structures
 StructureDescription
Public structureCode exampleAddResult A common structure used to report the results of added objects
Public structureCode exampleDataAction A simple query abstraction layer used to provide a mechanism by which methods can make simple query calls to various models.
Public structureCode exampleDataFilter A simple filter abstraction layer used to provide a mechanism by which methods can make simple filter calls to various models.
Public structureCode exampleDeleteResult A common structure used to report the results of deleted objects.
Public structureCode exampleLaborLevelIDList A labor level list of all 15 labor level IDs.
Public structureCode exampleReport The report structure helps to provide diagnostics information about the service just requested
Public structureUpdateResult A common structure used to report the results of updated objects.
Interfaces
 InterfaceDescription
Public interfaceIServiceIn Interface used to define the common service input parameters
Public interfaceIServiceOut Interface used to define the common service output parameters
Enumerations
 EnumerationDescription
Public enumerationAddResultStatus Used to report on the status of an Add request
Public enumerationCode exampleDateTimeSchema Represents a group of enums that will format any DateTime[Schema] response property based on its type
Public enumerationDeleteResultStatus Used to report on the status of an Delete request
Public enumerationPunchStatus The status of a punch type where it can be either blocked or valid.
Public enumerationUpdateResultStatus Used to report on the status of an Update request