GetReturnMaterialAuthorizationList

Description

Retrieves a list of return material authorization summary objects that match the specified criteria.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Field Service

Examples

The following C# example retrieves the list of return material authorization summary objects where the ReturnTpeId property is equal to "Svc". The customer name and return type of each return material authorization summary object is displayed in a message box.

** 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;
            ReturnMaterialAuthorizationCriteria returnMaterialAuthorizationCriteria;
            LikeRestrictionOfString returnTypeRestriction;
            ReturnMaterialAuthorizationSummary[] returnMaterialAuthorizationSummary;

            // 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 the like restriction of string object
            returnTypeRestriction = new LikeRestrictionOfString();
            returnTypeRestriction.EqualValue = "SVC";

            // Create the return material authorization criteria object
            returnMaterialAuthorizationCriteria = new ReturnMaterialAuthorizationCriteria();
            returnMaterialAuthorizationCriteria.ReturnTypeId = returnTypeRestriction;

            // Retrieve the list of return material authorization summary objects
            returnMaterialAuthorizationSummary = wsDynamicsGP.GetReturnMaterialAuthorizationList
                (returnMaterialAuthorizationCriteria, context);

            // Display the customer name and return type for each member of the summary object list
            StringBuilder summaryList = new StringBuilder();
            foreach (ReturnMaterialAuthorizationSummary a in returnMaterialAuthorizationSummary)
            {
                summaryList.AppendLine("Customer name: " + a.CustomerName + "   Return Type: "
                    + a.ReturnTypeKey.Id);
            }
            MessageBox.Show(summaryList.ToString());
        }
    }
}

** 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;
            ReturnMaterialAuthorizationCriteria returnMaterialAuthorizationCriteria;
            LikeRestrictionOfstring returnTypeRestriction;
            ReturnMaterialAuthorizationSummary[] returnMaterialAuthorizationSummary;

            // 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 the like restriction of string object
            returnTypeRestriction = new LikeRestrictionOfstring();
            returnTypeRestriction.EqualValue = "SVC";

            // Create the return material authorization criteria object
            returnMaterialAuthorizationCriteria = new ReturnMaterialAuthorizationCriteria();
            returnMaterialAuthorizationCriteria.ReturnTypeId = returnTypeRestriction;

            // Retrieve the list of return material authorization summary objects
            returnMaterialAuthorizationSummary = wsDynamicsGP.GetReturnMaterialAuthorizationList
                (returnMaterialAuthorizationCriteria, context);

            // Display the customer name and return type for each member of the summary object list
            StringBuilder summaryList = new StringBuilder();
            foreach (ReturnMaterialAuthorizationSummary a in returnMaterialAuthorizationSummary)
            {
                summaryList.AppendLine("Customer name: " + a.CustomerName + "   Return Type: "
                    + a.ReturnTypeKey.Id);
            }
            MessageBox.Show(summaryList.ToString());

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