Response Metadata

Throttling and Pagination detail is provided within the response header. Pagination detail is provided in both the response body and header.

Body Response Example: No Pagination:

xml response - no pagination

<response_metadata>
    <pagination>
        <total_records>1</total_records>
        <total_pages>1</total_pages>
        <limit>25</limit>
        <max_limit>100</max_limit>
        <next_cursor/>
    </pagination>
</response_metadata>

Body Response Example: Yes Pagination:

xml response - yes pagination

<response_metadata>
    <pagination>
        <total_records>29</total_records>
        <total_pages>2</total_pages>
        <limit>25</limit>
        <max_limit>100</max_limit>
        <next_cursor>eyJwb19pZCI6MjczODE3fQ</next_cursor>
        <next_page>http://staging-portalapp.springsystems.com/api/po-outgoing/export/po.filter.gt.po_id/273788/pagination.next_cursor/eyJwb19pZCI6MjczODE3fQ</next_page>
    </pagination>
</response_metadata>

Body Response Example: Throttle Limit Reached:

json response error

"errors": [  
        "Rate limit exceeded"  
    ]

Body Response Example: Burst Time Limit Reached:

json response error

"errors": [  
        "Too many requests"  
    ]

Header Response Example

KEY	VALUE
Date	Wed, 11 Jan 2023 18:54:02 GMT
Content-Type	text/xml;charset-UTF-8
Transfer-Encoding	chunked
Connection	keep-alive
X-Pagination	{"limit:25,"max_jimit":100,"next_cursor":nuli}}
X-RateLimit-Limit	500
X-RateLimit-Remaining	6
X-RateLimit-Transaction-Limit	5000
X-RateLimit-Transaction-Remaining	4973
X-RateLimit-Requested-Entities-Limit.	50000
X-RateLimit-Requested-Entities-Remaining	49486
X-RateLimit-Retry-After	$2023-01-1211: 21: 06$
Server	Spring Systems
Cache-Control	no-store, must-revalidate, max-age=0