Click or drag to resize

Introduction

In Applied Epic SDK 2019 we introduced restful methods. It will require different coding techniques to consume the restful methods rather than the previous WCF methods.
Why Restful

The restful methods are easier for non-.Net developers to consume.

Installation

There are no additional installation steps required. The restful functionality is available simply by installing SDK.

Support

Moving forward new functionality will be exposed using restful methods. In some cases that involve adding new methods to an already existing area, the methods may still continue to be exposed with WCF.

To view the list SDK restful methods refer to the rest section of the Areas Of Integration page.

Development

Consuming restful methods does not involve generating a proxy. For the .Net developers already familiar with consuming the WCF methods with a proxy, it will no longer be possible to use to rely on intellisense to discover method signitures and properties. Discovering restful methods and properties requires referencing the documentation. The root method (/api) can also display Uris for common methods and the Product Version.

There are a variety of technologies that can be used to consume rest style methods. The sample code will demonstrate one way of consuming the methods for the purposes of getting started quickly. However, we don't recommend any particular technology or style of coding. Refer to the Sample Code Notes for more information about the code samples.

Some behavior patterns of the restful methods differ from the previous WCF methods. For example, the error message response format and the handling of partial input. Refer to Status Codes and Error Responses for more information about the error messages. Refer to Partial Input for more information about partial input.