SalesStageQueryPage
Extracts sales stage information for one or more sales stages, depending on the search criteria that you specify.
Usage
Use the SalesStageQueryPage method to retrieve sales stage information including additional required fields, process coach steps, automated tasks, and useful resources (file and URL attachments).
The ListOfSalesStage argument contains elements for the various fields of a sales stage, and for the associated process coach steps, automated tasks, attachments, and additional required fields. There are child elements <ListOfProcessCoach>, <ListOfAutomatedTask>, <ListOfTranslation>, <ListOfProcessCoachTranslation>, <ListOfAttachments>, <ListOfAutomatedTaskTranslation>, and <ListOfRequiredFields>. You can search for specific sales stages, by specifying search criteria in the child elements of <SaleStage>. For example, you can search for the following:
-
A specific sales stage, by specifying the ID of the sales stage, as follows: <Id>'Id to search'</Id>
-
A specific sales stage, by specifying the language-independent name of the sales stage, as follows: <BaseName>='Name to search'</BaseName>
If there is more than one sales stage with the same name associated with different sales processes, then all of the sales stages with the specified name are returned, unless you also specify the language-independent name of the sales process that the sales stage is associated with in the <SalesProcessBaseName> element. You can use the SalesProcessQueryPage method to extract the language-independent names of the sales processes.
-
All sales stages created after a certain date, for example: <CreatedDate>>='2020-11-25T09:00:00Z'</CreatedDate>
If you do not specify any search criteria, then the information for all of the sales stages for the company is returned.
For most of the child elements of <ListOfSalesStage>, you can use the sortorder and sortsequence attributes to specify how fields in the returned sales stage information are sorted.
See SalesStageInsertOrUpdate for information about the sales stage data specified in <ListOfSalesStage>.
Arguments
The following table describes the arguments taken by the SalesStageQueryPage method.
| Name | Description | Required | Default | I/O |
|---|---|---|---|---|
|
ListOfSalesStage |
The list of sales stages queried (input), and after query execution, the list of sales stages returned (output). |
Yes |
Not applicable |
Input/Output |
|
PageSize |
The maximum number of records displayed on a page following a query. |
No |
10 |
Input |
|
StartRowNum |
Indicates the row from which the SalesStageQueryPage method starts to return records. For example, if PageSize=100 and you want to return records 1-100, you set StartRowNum to 0. Then, if you want to return records 101-200, you set StartRowNum to 100, and run the query again. You continue doing this until the last page is returned. In this way, you can return all records for a particular query. |
No |
0 |
Input |
|
recordcountneeded |
Indicates whether a record count for the object is to be returned. |
No |
False |
Input |
|
searchspec |
Indicates the search specification for a field or for all the fields of an object. |
No |
Not applicable |
Input |
|
sortsequence |
An integer value that determines the order of the sort specification. |
No |
Not applicable |
Input |
|
sortorder |
Determines the sort order for the records returned by the query, either ASC for ascending or DESC for descending. |
No |
ASC |
Input |
Return Value of the Call
The sales stage data is returned.