SOAP API Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
LimitInfoHeader
A response header returned from calls to SOAP API. This
header returns limit information for the organization. Use this header to monitor your
API limits as you make calls against the organization.
API Calls
All calls, except for login().
Fields
| Element Name | Type | Description |
|---|---|---|
| current | long | The number of calls for the specified limit type that have already been used in the organization. |
| limit | long | The organization’s limit for the specified limit type. |
| type | string | The type of limit information specified in the header.
|
Sample Code
This example shows a response to a SOAP request for a Merchandise record. The LimitInfoHeader contains the API usage information for the
organization.
1<?xml version="1.0" encoding="UTF-8"?>
2<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
3 xmlns="urn:partner.soap.sforce.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4 xmlns:sf="urn:sobject.partner.soap.sforce.com">
5 <soapenv:Header>
6 <LimitInfoHeader>
7 <limitInfo>
8 <current>5</current>
9 <limit>100000</limit>
10 <type>API REQUESTS</type>
11 </limitInfo>
12 </soapenv:Header>
13 <soapenv:Body>
14 <queryResponse>
15 <result xsi:type="QueryResult">
16 <done>true</done>
17 <queryLocator xsi:nil="true"/>
18 <records xsi:type="sf:sObject">
19 <sf:type>dev_ns__Merchandise__c</sf:type>
20 <sf:Id>a00D0000008pQSNIA2</sf:Id>
21 <sf:dev_ns__Description__c>Phone Case for iPhone
22 4/4S</sf:dev_ns__Description__c>
23 <sf:dev_ns__Price__c>16.99</sf:dev_ns__Price__c>
24 <sf:dev_ns__Stock_Price__c>12.99</sf:dev_ns__Stock_Price__c>
25 <sf:dev_ns__Total_Inventory__c>108.0</sf:dev_ns__Total_Inventory__c>
26 <sf:Id>a00D0000008pQSNIA2</sf:Id>
27 </records>
28 <size>1</size>
29 </result>
30 </queryResponse>
31 </soapenv:Body>
32</soapenv:Envelope>