Jump to content

SimTX API v24/Packets/CatalogUploadResult

From SimTX Wiki
This page documents protocol v24, which current servers no longer accept. See SimTX API for v25.
CatalogUploadResult
Packet ID 21(0x15)
Direction Server → client
Session Control (catalog)
Body size 7 + message length
Permission None
Answered by
Answers CatalogUpload

CatalogUploadResult reports the outcome of a CatalogUpload.

Layout[edit | edit source]

Field Type Description
packetId u8 Always 21.
ok bool True if the entry was published.
message UTF Uploaded for a new entry, Updated for a new revision, otherwise the reason for failure.
entryId i32 The entry's ID on success; −1 on failure.

Typical failure messages[edit | edit source]

  • Publishing requires catalog.publish
  • This server has no catalog
  • Unknown catalog item kind 'X'
  • A preset is exactly one .stxpreset file
  • An item named 'X' already exists (by Author)
  • Catalog entry quota reached (32), Catalog storage quota reached, Server catalog storage is full
  • Manifest validation messages, passed through verbatim.

Show the message to the user; it says what to fix.

SimTX API v24 reference (protocol v24, archived)
Start OverviewQuick startData typesLimits and errorsPacket list
Account service OverviewDevice loginServer directoryGame ticketsPermissionsPublic endpoints
Game protocol Connection and handshakeReceiver sessionTransmitter sessionControl sessionCatalogModeration
Handshake HandshakeHandshakeResult
Receiver ReceiverSessionRequestReceiverRetuneForwardedClientAddressIqStreamDescriptorIqBlockTimedIqBlock
Transmitter TransmitterSessionRequestSampleBlockTxModeInfoTxUpdateTxQueueTxAcceptTxRejectTxKickTxTelemetryTxUpdateAck
Control ControlAckBannerListStationsStationListServerHealthRequestServerHealthReportCoverageMapRequestCoverageMapResponseWeatherMapRequestWeatherMapResponseStartMonitorStopMonitorMonitorBlockMonitorEnd
Catalog CatalogListRequestCatalogListCatalogFetchCatalogEntryCatalogUploadCatalogUploadResultCatalogDeleteCatalogDeleteResult
Moderation KickRequestKickResultIpModerationRequestIpModerationResultBroadcastBannerModerationErrorStationImpactList
Current Protocol v25 reference