sforce logo

Sample SOAP Messages-describeLayout

This topic provides the following sample SOAP messages:

Sample Request Message-describeLayout Call-Enterprise API 

POST /services/Soap/u/5.0 HTTP/1.0 
Content-Type: text/xml; charset=utf-8 
Accept: application/soap+xml, application/dime, multipart/related, text/* 
User-Agent: Axis/1.1 
Host: www.salesforce.com 
Cache-Control: no-cache 
Pragma: no-cache 
SOAPAction: "" 
Content-Length: 660 
 
<?xml version="1.0" encoding="UTF-8"?> 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance"> 
 <soapenv:Header> 
  <ns1:SessionHeader soapenv:mustUnderstand="0" 
xmlns:ns1="urn:enterprise.soap.sforce.com"> 
   <ns1:sessionId>Y0PQJaMRQGBlUtIlWMt0_jXlNKOSU</ns1:sessionId> 
  </ns1:SessionHeader> 
 </soapenv:Header> 
 <soapenv:Body> 
  <describeLayout xmlns="urn:enterprise.soap.sforce.com"> 
   <sObjectType>Lead</sObjectType> 
  </describeLayout> 
 </soapenv:Body> 
</soapenv:Envelope>

Sample Response Message-describeLayout Call-Enterprise API

See Sample Response Message-describeLayout Call-Partner API.

Sample Request Message-describeLayout Call-Partner API 

POST /services/Soap/u/5.0 HTTP/1.0 
Content-Type: text/xml; charset=utf-8 
Accept: application/soap+xml, application/dime, multipart/related, text/* 
User-Agent: Axis/1.1 
Host: www.salesforce.com 
Cache-Control: no-cache 
Pragma: no-cache 
SOAPAction: "" 
Content-Length: 660 
 
<?xml version="1.0" encoding="UTF-8"?> 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance"> 
 <soapenv:Header> 
  <ns1:SessionHeader soapenv:mustUnderstand="0" 
xmlns:ns1="urn:partner.soap.sforce.com"> 
  	<ns1:sessionId>XgmiShQdysIHGb2rlGWn_RNTHhV1xAfr38Fnd0_jXlNKOSU</ns1:sessionId> 
  </ns1:SessionHeader> 
 </soapenv:Header> 
 <soapenv:Body> 
  <describeLayout xmlns="urn:partner.soap.sforce.com"> 
   <sObjectType>Account</sObjectType> 
  </describeLayout> 
 </soapenv:Body> 
</soapenv:Envelope>

Sample Response Message-describeLayout Call-Partner API 

HTTP/1.0 200 OK 
Server: sfdc 
Content-Type: text/xml; charset=utf-8 
Date: Mon, 08 Nov 2004 23:27:27 GMT 
 
<?xml version="1.0" encoding="UTF-8"?> 
   <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance">  
      <soapenv:Body>   
         <describeLayoutResponse xmlns="urn:partner.soap.sforce.com">    
            <result>     
               <layouts>      
                  <detailLayoutSections>       
                     <columns>2</columns>       
                     <heading>Account Information</heading>       
                     <layoutRows>        
                        <layoutItems>         
                           <editable>false</editable>         
                           <label>Account Owner</label>         
                           <layoutComponents>          
                              <tabOrder>1</tabOrder>          
                              <type>Field</type>          
                              <value>OwnerId</value>         
                           </layoutComponents>         
                           <placeholder>false</placeholder>         
                           <required>false</required>        
                        </layoutItems>        
                        <layoutItems>         
                           <editable>false</editable>         
                           <label>Rating</label>         
                           <layoutComponents>          
                              <tabOrder>9</tabOrder>          
                              <type>Field</type>          
                              <value>Rating</value>         
                           </layoutComponents>         
                           <placeholder>false</placeholder>         
                           <required>false</required>        
                        </layoutItems>        
                        <numItems>2</numItems>       
                     </layoutRows>       
 
... 
          </layouts>     
               <recordTypeMappings>      
                  <available>false</available>      
                  <defaultRecordTypeMapping>false</defaultRecordTypeMapping>      
                  <layoutId>00h30000000doxaAAA</layoutId>      
                  <name>0123000000000fzAAA</name>      
                  <picklistsForRecordType>       
                     <picklistName>Type</picklistName>       
                     <picklistValues>        
                        <active>true</active>        
                        <defaultValue>false</defaultValue>        
                        <label>Prospect</label>        
                        <value>Prospect</value>       
                     </picklistValues>       
                     <picklistValues>        
                        <active>true</active>        
                        <defaultValue>false</defaultValue>        
                        <label>Customer - Direct</label>        
                        <value>Customer - Direct</value>       
                     </picklistValues>       
                     <picklistValues>        
                        <active>true</active>        
                        <defaultValue>false</defaultValue>        
                        <label>Customer - Channel</label>        
                        <value>Customer - Channel</value>       
                     </picklistValues>       
                     <picklistValues>        
                        <active>true</active>        
                        <defaultValue>false</defaultValue>        
                        <label>Channel Partner / Reseller</label>        
                        <value>Channel Partner / Reseller</value>       
                     </picklistValues>       
                     <picklistValues>        
                        <active>true</active>        
                        <defaultValue>false</defaultValue>        
                        <label>Installation Partner</label>        
                        <value>Installation Partner</value>       
                     </picklistValues>       
                     <picklistValues>        
                        <active>true</active>        
                        <defaultValue>false</defaultValue>        
                        <label>Technology Partner</label>        
                        <value>Technology Partner</value>       
                     </picklistValues>       
                     <picklistValues>        
                        <active>true</active>        
                        <defaultValue>false</defaultValue>        
                        <label>Other</label>        
                        <value>Other</value>       
                     </picklistValues>      
                  </picklistsForRecordType>      
... 
                  <recordTypeId>0123000000000fzAAA</recordTypeId>     
               </recordTypeMappings>    
            </result>   
         </describeLayoutResponse>  
      </soapenv:Body> 
   </soapenv:Envelope>

www.sforce.com

© Copyright 2000-2003 SalesForce.com, Inc.
All rights reserved • Various trademarks held by their respective owners.