GetServiceCallByKey

Description

Retrieves a single service call object based on the specified service document key.

Parameters

Parameter	Type	Description
key	ServiceDocumentKey	The service document key object that specifies the service call to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetServiceCallByKeyResult	ServiceCall	A service call object.

Interfaces

• Dynamics GP
• Field Service

Examples

The following C# example retrieves a service call object with the service document key value "0000002022". A message box displays the service call customer name.

** Legacy endpoint**

using System;
using System.Collections.Generic;
using System.Text;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            ServiceDocumentKey serviceDocumentKey;
            ServiceCall serviceCall;

            // Create an instance of the service
            DynamicsGP wsDynamicsGP = new DynamicsGP();

            // Be sure the default credentials are used
            wsDynamicsGP.UseDefaultCredentials = true;

            // Create a context with which to call the service
            context = new Context();

            // Specify which company to use (sample company)
            companyKey = new CompanyKey();
            companyKey.Id = (-1);

            // Set up the context object
            context.OrganizationKey = (OrganizationKey)companyKey;

            // Create a service document key object
            serviceDocumentKey = new ServiceDocumentKey();
            serviceDocumentKey.Id = "0000002022";

            // Retrieve the specified service call object
            serviceCall = wsDynamicsGP.GetServiceCallByKey(serviceDocumentKey, context);

            // Display the service call customer name
            MessageBox.Show("Customer: " + serviceCall.CustomerName);
        }
    }
}

** Native endpoint **

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            ServiceDocumentKey serviceDocumentKey;
            ServiceCall serviceCall;

            // Create an instance of the service
            DynamicsGPClient wsDynamicsGP = new DynamicsGPClient();

            // Create a context with which to call the service
            context = new Context();

            // Specify which company to use (sample company)
            companyKey = new CompanyKey();
            companyKey.Id = (-1);

            // Set up the context object
            context.OrganizationKey = (OrganizationKey)companyKey;

            // Create a service document key object
            serviceDocumentKey = new ServiceDocumentKey();
            serviceDocumentKey.Id = "0000002022";

            // Retrieve the specified service call object
            serviceCall = wsDynamicsGP.GetServiceCallByKey(serviceDocumentKey, context);

            // Display the service call customer name
            MessageBox.Show("Customer: " + serviceCall.CustomerName);

            // Close the service
            if(wsDynamicsGP.State != CommunicationState.Faulted)
            {
                wsDynamicsGP.Close();
            }
        }
    }
}