LimitInfoHeader

A response header returned from calls to the 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	string	The number of calls for the specified limit type that have already been used in the organization.
limit	string	The organization’s limit for the specified limit type.
type	string	The type of limit information specified in the header. `API REQUESTS`—contains limit information about API calls for the organization. `API REQUESTS PER APP`—contains limit quota information, if there is any, for the currently connected app. API limit app quotas are currently available through a pilot program. For information on enabling this feature for your organization, contact Salesforce. This example includes the limit quota for a `sample-connected-app` connected app. `1<limitInfo> 2 <appName>sample-connected-app</appName> 3 <current>20</current> 4 <limit>250</limit> 5 <type>API REQUESTS PER APP</type> 6</limitInfo>`

Sample Code

This is an example of 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>5000</limit>
10                <type>API REQUESTS</type>
11            </limitInfo>
12        </LimitInfoHeader>
13    </soapenv:Header>
14    <soapenv:Body>
15        <queryResponse>
16            <result xsi:type="QueryResult">
17                <done>true</done>
18                <queryLocator xsi:nil="true"/>
19                <records xsi:type="sf:sObject">
20                    <sf:type>dev_ns__Merchandise__c</sf:type>
21                    <sf:Id>a00D0000008pQSNIA2</sf:Id>
22                    <sf:dev_ns__Description__c>Phone Case for iPhone
23                        4/4S</sf:dev_ns__Description__c>
24                    <sf:dev_ns__Price__c>16.99</sf:dev_ns__Price__c>
25                    <sf:dev_ns__Stock_Price__c>12.99</sf:dev_ns__Stock_Price__c>
26                    <sf:dev_ns__Total_Inventory__c>108.0</sf:dev_ns__Total_Inventory__c>
27                    <sf:Id>a00D0000008pQSNIA2</sf:Id>
28                </records>
29                <size>1</size>
30            </result>
31        </queryResponse>
32    </soapenv:Body>
33</soapenv:Envelope>

SOAP API Developer Guide

LimitInfoHeader

API Calls

Fields

Sample Code