Bookshelf Home | Contents | Index | PDF |
Oracle Web Services On Demand Guide > Web Services On Demand API Calls > Service API Calls > SalesProcessQueryPageReturns sales process information for a particular user, the default sales process, or all sales processes for a company. UsageYou use the SalesProcessQueryPage method to retrieve sales process information including sales stages, order of the sales stages, default probability, and associated opportunity types. The ListOfSalesProcess argument contains elements for the various fields of a sales process, and for the associated sales stages and opportunity types. There are child elements ListofSalesStage and ListofOpportunityType. In requests, if the <SalesProcessId> element does not contain a value, information for all of the sales processes for the company are returned. If the <SalesProcessId> element contains a value, information for sales processes for the user or role with that sales process ID are returned. You can use the User service to query for the SalesProcId value for a user. If the <Default> element contains the value Y, information for the default sales process is returned. For most of the child elements of ListOfSalesProcess, you can use the sortorder and sortsequence attributes to specify how fields in the returned sales process information are sorted. NOTE: The Name and Description fields of SalesProcess do not support the sort specification. ArgumentsTable 58 describes the arguments taken by the SalesProcessQueryPage method.
Return Value of the CallThe following information is returned by ListOfsalesProcess which contains a <SalesProcess> element for each sales process that matches the query:
For more information about sales process information, see Oracle CRM On Demand Online Help. Sample SOAP Requests and ResponsesThis topic contains sample SOAP requests that invoke SalesProcessQueryPage. Sample SOAP Request 1 - SalesProcessQueryPage with pagesize, startrownum and recordcountneeded AttributesThe following SOAP request retrieves the sales processes defined for the company but only returns a maximum of one record at the SalesProcess parent object level, a maximum of one record at the OpportunityType child object level, and a maximum of five records at the SalesStage level by specifying pagesize, startrownum, and recordcountneeded attributes at each of the list of objects levels. <?xml version="1.0" encoding="utf-8" standalone="no"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <wsse:Username>%%%USERNAME%%%</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password> <SalesProcessQueryPage_Input xmlns="urn:crmondemand/ws/salesproc/"> <ListOfSalesProcess pagesize="1" startrownum="1" recordcountneeded="true"> <ListOfOpportunityType pagesize="1" startrownum="0" recordcountneeded="false"> <ListOfSalesStage pagesize="5" startrownum="0" recordcountneeded="true"> </SalesProcessQueryPage_Input> Sample SOAP Response 1The following is the response for sample SOAP request 1: <?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ns:SalesProcessQueryPage_Output xmlns:ns="urn:crmondemand/ws/salesproc/"> <ListOfSalesProcess xmlns="urn:/crmondemand/xml/salesprocess/Data" recordcount="2" lastpage="true"> <Name>Renewal Sales Process</Name> <Description>Simplified process for renewal sales.</Description> <ListOfOpportunityType lastpage="true"> <ListOfSalesStage recordcount="4" lastpage="true"> </ns:SalesProcessQueryPage_Output> Sample SOAP Request 2 - SalesProcessQueryPage with searchspec, sortorder, and sortsequence AttributesThe following SOAP request queries the sales process by specifying the search criteria in the searchspec attribute. It returns all sales processes with a name like <?xml version="1.0" encoding="utf-8" standalone="no"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <wsse:Username>%%%USERNAME%%%</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password> <SalesProcessQueryPage_Input xmlns="urn:crmondemand/ws/salesproc/"> <ListOfSalesProcess recordcountneeded="true"> <SalesProcess searchspec="[Name] LIKE 'Default*'"> <ListOfSalesStage recordcountneeded="true"> <SalesStage searchspec="[Name] LIKE 'Closed*'"> <Name sortorder="ASC" sortsequence="0"></Name> </SalesProcessQueryPage_Input> Sample SOAP Response 2The following is the response for sample SOAP request 2: <?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ns:SalesProcessQueryPage_Output xmlns:ns="urn:crmondemand/ws/salesproc/"> <ListOfSalesProcess xmlns="urn:/crmondemand/xml/salesprocess/Data" recordcount="1" lastpage="true"> <Name>Default Sales Process</Name> <Description>This sales process is the default defined for your company.</Description> <ListOfOpportunityType lastpage="true"> <ListOfSalesStage recordcount="2" lastpage="true"> |
Oracle Web Services On Demand Guide, Version 21.0 (Oracle CRM On Demand Release 33) | Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices. | |