GetSystemStatus

Use the GetSystemStatus method to retrieve the status of your account. Use this method only during exception handling or as the first SOAP API call.

Don’t use this method before every API call or at intervals less than 60 seconds. When troubleshooting, run this method about every 10 minutes.

Note

Parameters

Name	Data Type	Description
`Options`	SystemStatusOptions	Optionally specifies more processing options.
`OverallStatus`	String	Specifies the overall status of the request.
`OverallStatusMessage`	String	Specifies the overall status message of the request.
`RequestID`	String	A unique identifier for the request.

Output

This method returns an array of SystemStatusResult objects.

If the SystemStatusResult SystemStatus property equals OK, no action is required.

If the SystemStatusResult SystemStatus property equals InMaintenance, place your application in queue mode and periodically make the GetSystemStatus call until the status returns to OK.

If the SystemStatusResult SystemStatus property equals UnplannedOutage, place your application in queue mode and periodically make the GetSystemStatus call until the status returns to OK.

To understand and act on the system status, we recommend that you have these elements in place.

A global status container in your application. This container can allow your application to change code paths to ensure that all messages are stored while waiting for the status to return to OK. If the global status container contains an InMaintenance or UnplannedOutage status, wait for the scheduled status checking component to update the global status container to the OK status.
A scheduled status checking component in your software, so it can respond to error situations and update the global status container if the status is different.

Usage

This sample SOAP envelope shows how to retrieve the current system status.

1<?xml version="1.0" encoding="UTF-8"?>
2<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
3            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4            xmlns:xsd="http://www.w3.org/2001/XMLSchema"
5            xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing">
6  <s:Header>
7    <a:Action>GetSystemStatus</a:Action>
8    <a:To>https://YOUR_SUBDOMAIN.soap.marketingcloudapis.com/Service.asmx</a:To>
9    <fueloauth xmlns="http://exacttarget.com">YOUR_ACCESS_TOKEN</fueloauth>
10  </s:Header>
11  <s:Body>
12    <SystemStatusRequestMsg xmlns="http://exacttarget.com/wsdl/partnerAPI">
13      <Options />
14    </SystemStatusRequestMsg>
15  </s:Body>
16</s:Envelope>

On success, the API returns HTTP 200 response with a SOAP body that resembles this example.

1<?xml version="1.0" encoding="UTF-8"?>
2<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"
3            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4            xmlns:xsd="http://www.w3.org/2001/XMLSchema">
5  <s:Body>
6    <SystemStatusResponseMsg xmlns="http://exacttarget.com/wsdl/partnerAPI">
7      <OverallStatus>OK</OverallStatus>
8      <OverallStatusMessage xsi:nil="true"/>
9      <RequestID>a1b2c3d4-e5f6-7890-abcd-ef1234567890</RequestID>
10      <Results xsi:type="SystemStatusResult">
11        <SystemStatus>OK</SystemStatus>
12      </Results>
13    </SystemStatusResponseMsg>
14  </s:Body>
15</s:Envelope>