AVEVA™ Production Management

About Web services

Save PDF

TABLE OF CONTENTS

About Web services

Save PDF

Last UpdatedOct 04, 2022
2 minute read

AVEVA™ Production Management web services provide an XML-based web service protocol with the following characteristics:

Contract-first development - Focused on information content and business value.
Invariant interface - Able to pass invariant data to different date time regions.
Increased operability - Adheres to the W3C standard WS-I for Web Service Interoperability.
SOA Compliance - Designed for a service-oriented architecture.

Naming protocol

Web services uses the following structures in the naming protocols.

Web address

The naming protocols for AVEVA™ Production Management web services are standardized to provide a consistent naming structure for AVEVA Production Management web services.

For example, the base address of the web service has this structure:

http://[Hostname]:[Port]/Ampla/[WebServiceName]/[Version year]/[Version month]/Soap11

For example:

http://localhost:8889/Ampla/Data/2008/06/Soap11
http://localhost:8889/Ampla/B2MML/2008/07/Soap11
http://localhost:8889/Ampla/Inventory/2010/03/Soap11

These earlier web service methods stay as previously named:

http://localhost:8889/Ampla/WebService/Data/2007/06
http://localhost:8889/Ampla/WebService/Security/2007/06

Contract

The name of the contract of the public web service has this structure:

Citect.Ampla.Public.[WebServiceName].V[Year][Month].I[WebServiceName]

For example:

Citect.Ampla.Public.WebService.Data.V200706.IDataWebService
Citect.Ampla.Public.WebService.Data.V200806.IDataWebService
Citect.Ampla.Public.WebService.Security.V200706.ISecurityWebService
Citect.Ampla.Public.WebService.B2MML.V200807.IB2MMLWebService

Document literal format

AVEVA™ Production Management web services are implemented in document literal format.

Each Web method accepts a request object called "<webMethod>Request".
Each Web method returns a response object called "<webMethod>Response".

For example: Public GetDataResponse getData(GetDataRequest getDataRequest);

Named element conventions

Named elements in AVEVA™ Production Management web services use the following conventions:

Public web methods use pascal case.
Message element names use pascal case.
Message attribute names use camel case.

DateTime standards

AVEVA™ Production Management web services adopts a specific W3C datetime format. The Web service both accepts and returns datetime values.

There are two basic requirements for the datetime value:

Date times are formatted as invariant; that is, transportable between cultures.
Date time values are transported as UTC; that is, the date time value is converted to Zulu time before it is sent across the wire.

The date time is formatted according to the W3C recommendation for web service transport as "2022-01-22T12:00:00Z".

Based on the ISO 8601 standard.
"T" demarcates the date component from the time component.
"Z" denotes Zulu time (UTC).
This format is tested as a DateTime datatype in the WSDL and tested for compatibility with Java.

AVEVA™ Production Management