Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
When you add a service for a new type of document, you need to use the Dynamics GP Service framework as your service foundation. The Dynamics GP Service framework allows you to add new document types.
The Dynamics GP Service framework defines a standard set of operations. The framework operations enable your service methods to perform actions on the Dynamics GP database. When you define the methods for your service, you need to select the framework operation that applies to each method. Your service methods can perform the following types of operations.
Operation |
Description |
|---|---|
Create |
Inserts the data from a new document into the Microsoft Dynamics GP database. Requires you to supply the data fields for the complete document. |
Delete |
Removes an existing document from the Microsoft Dynamics GP database. Requires you to supply a key value that specifies the document to remove. |
GetByKey |
Retrieves a single document. Requires you to supply a key value that specifies the document to retrieve. |
GetList |
Retrieves a collection of one or more summary documents. Requires you to specify the criteria to use to query records for the collection. |
Update |
Modifies an existing document in the Dynamics GP database. Requires you to supply the data fields for the complete document. |
Void |
Marks an existing document as void but does not remove the document from the Microsoft Dynamics GP database. A Void operation begins like a Delete operation, you supply a key value that specifies the document to void. You complete the Void operation like an Update operation, you update the existing record and set a specified value in the field that identifies void records. |
In addition, the Dynamics GP Service framework enables your service to use the native service endpoint, the legacy service endpoint, or both endpoints. The endpoints your service supports is based on the needs of the applications that use the service. The sample Leads service implements both endpoints. For more information about endpoints, see Endpoints.