SimTX API/Packets/CatalogUploadResult

CatalogUploadResult

Frame	ServerFrame, field 38
Member	catalog_upload_result
Direction	Server → client
Session	Control (catalog)
Roles	ROLE_CONTROL.
Permission	None
Answered by
Answers	CatalogUpload
Defined in	control.proto

CatalogUploadResult confirms a successful CatalogUpload. A refused upload is answered with Error instead; the v24 ok and message fields are gone.

Definition

message CatalogUploadResult {
  reserved 2, 3;
  reserved "ok", "message";
  int64 request_id = 1;
  int32 entry_id = 4;
  bool updated = 5;            // true: replaced your existing publication of that name
}

Fields

#	Field	Type	Description
1	request_id	int64	The request this answers.
4	entry_id	int32	ID of the published entry.
5	updated	bool	True: the upload replaced your existing entry of that name and its revision increased.

Reserved, never reused: field numbers 2, 3 and the names ok, message.

Example

Complete frames, including the varint length prefix, from the protocol's golden test vectors (protocol/simtx/v25/testdata/frames.json).

catalog_upload_result_updated (server to client, 10 bytes):

09        frame length 9
B2 02 06  catalog_upload_result (CatalogUploadResult), 6 bytes
  08 2B   request_id = 43
  20 11   entry_id = 17
  28 01   updated = true

See also

• CatalogUpload