SimTX API/Packets/CatalogUploadResult
| Frame | ServerFrame, field 38
|
|---|---|
| Member | catalog_upload_result
|
| Direction | Server → client |
| Session | Control (catalog) |
| Roles | ROLE_CONTROL.
|
| Permission | None |
| Answers | CatalogUpload |
| Defined in | control.proto
|
CatalogUploadResult confirms a successful CatalogUpload. A refused upload is answered with Error instead.
Definition[edit | edit source]
message CatalogUploadResult {
reserved 2, 3;
int64 request_id = 1;
int32 entry_id = 4;
bool updated = 5; // true: replaced your existing publication of that name
}
Fields[edit | edit source]
| # | 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. |
Field numbers 2 and 3 are reserved; do not use them.
Example[edit | edit source]
Complete frames, including the varint length prefix.
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