9. Skip to content

9. Get Campaign Info

9.1 Overview

Retrieve information regarding currently active campaigns. Prior to client version 3.03.0, this endpoint is able to retrieve information for any specified campaign. In 3.03.0 and later, this endpoint returns information for up to three campaigns of the server’s selection.

Danger

The structure of both the request and response changed in client version 3.03.0, without changing the command ID! Servers must respond with the correct structure for the requested version.

9.2 Request

9.2.1 Prior to client version 3.03.0

4 bytes12 bytesCampaign ID

Parameter Detail
Command ID 11
Minimum supported client version 1.00.0
Campaign ID The campaign to retrieve information regarding

9.2.2 Client version 3.03.0 and later

Empty Payload

Parameter Detail
Command ID 11
Minimum supported client version 3.03.0

9.3 Response

9.3.1 Prior to client version 3.03.0

4 bytes4 bytes4 bytes4 bytesInfo 0(signed)Info 1(signed)Info 2(signed)Info 3(signed)

Parameter Detail
Command ID 12
Minimum supported client version 1.00.0
Info 0-3 Four s32s of arbitrary information. Their meaning is campaign-dependent

9.3.2 Client version 3.03.0 and later

160 bytes160 bytes160 bytesCampaign 1Campaign 2Campaign 34 bytes128 bytes4 bytes4 bytes4 bytes4 bytes4 bytes8 bytesIDNameAnnounceDateStart DateEnd DateDistribstart dateDistribend datePadding

Parameter Detail
Command ID 12
Minimum supported client version 3.03.0
ID The ID of this campaign
Name This campaign’s name
Announce date The date and time to begin announcing the campaign to players
Start date The date and time the campaign begins
End date The date and time the campaign ends
Distrib start date The date and time distribution begins
Distrib end date The date and time distribution ends

A campaign ID of 0 is used to indicate an unpopulated campaign.