Services Estimator API Developer Reference

ffscpq.RefreshRatesService

global with sharing class RefreshRatesService

A service that provides functionality related to refreshing estimate rates.

Methods

refreshRates

global static List<ffscpq.RefreshRatesService.RefreshRatesResponse> refreshRates(List<ffscpq.RefreshRatesService.RefreshRatesRequest> requests)

A method that refreshes the rates of estimates.

Input Parameters

Name Type Description
requests List<ffscpq.RefreshRatesService.RefreshRatesRequest> The list of RefreshRatesRequest.

Return Value

This service returns RefreshRatesResponse in a list that parallels the input list.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

// A list of estimate IDs that will have their rates refreshed.
List<Id> estimateIds = new List<Id>{ 'a6321000000XmT0AaC' };

// Construct the request
ffscpq.RefreshRatesService.RefreshRatesRequest request = new ffscpq.RefreshRatesService.RefreshRatesRequest(
    estimateIds
);

List<ffscpq.RefreshRatesService.RefreshRatesResponse> responses = ffscpq.RefreshRatesService.refreshRates(
    new List<ffscpq.RefreshRatesService.RefreshRatesRequest>{ request }
);

// Extract the IDs of the estimates whose rates have been refreshed successfully.
System.debug('Ids of estimates that had their rates refreshed: ' + responses[0].EstimateIds);

ffscpq.RefreshRatesService.RefreshRatesRequest

global with sharing class RefreshRatesRequest

The request structure for refreshing the rates of estimates.

Properties

Name Type Description
estimateIds List<Id> A list of IDs of the estimates to refresh the rates of.

Methods

RefreshRatesRequest

global RefreshRatesRequest(List<Id> estimateIds)

Input Parameters

Name Type Description
estimateIds List<Id> Contains the list of IDs of the estimates to refresh the rates of.

ffscpq.RefreshRatesService.RefreshRatesResponse

global with sharing class RefreshRatesResponse

The result returned after refreshing the rates of estimates.

Properties

Name Type Description
estimateIds List<Id> A list of IDs of the estimates that have had their rates refreshed.
jobId Id An ID of the Job that has been enqueued.

Methods

RefreshRatesResponse

global RefreshRatesResponse(List<Id> estimateIds, Id jobId)

© Copyright 2009–2024 Certinia Inc. All rights reserved. Various trademarks held by their respective owners.