|
|
Untitled Document
|
Exact Synergy Enterprise
When should i use the generic, and when the entity specific endpoints?
For the webservice, there are both a set of endpoints that are entity independent(e.g. Exact.Entities), and a set that is linked to a specific entity (e.g. Exact.Entity.Account). These endpoints differ in the following ways: - The specific endpoints only support the SOAP protocol. The REST endpoint is generic.
- With the generic endpoints, the client can choose which properties to include in the request. The data contract for the entity specific endpoints requires that all exposed properties are included in the request payload.
- Using the specific endpoints allows the use of Intellisense(or the equivalent to this in the IDE of other languages) to aid in the construction of the client code. Building the request when using the generic endpoints requires examination of the entity's metadata(available through the Exact.Metadata endpoint) to find out what values are expected by what properties.
- The entity specific endpoints are only maintained and supported for Exact Synergy Enterprise. Within Exact Globe Next only the generic endpoints are supported.
- Adding or changing custom/Configurator fields that are webservice exposed changes the data contract of the entity specific endpoint of the entity to which the fields were added. This in turn invalidates any existing client proxies that were built against an earlier version of that endpoint's contract.
The entity specific endpoints can be used under the following circumstances: - You are accessing Exact Synergy Enterprise.
- There are no intentions to modify the entity that you are accessing through a custom solution or the Configurator in the foreseeable future.
- Data size is not a concern.
- You intend to use SOAP.
- Using tools that recognize the full data contract of an entity is a key consideration in the construction of your client.
Under the following circumstances it is strongly recommended, or even required to use only the generic endpoints: - You are accessing Exact Globe Next (entity specific endpoints are not supported).
- You intend to use REST (only supported by a generic endpoint).
- The entity that you intend to access is likely to be modified through custom solutions or the Configurator(the data contract will be unstable).
- Data size is a concern (the entity specific fields will always include all fields even if they are not relevant).
- You intend to access requests (the request entity will throw errors if fields are offered that are not included in the request definition).
|
 |
|
Document Number: 26.682.994
Disclaimer
|
|
|