Open API Common Messages

Open API Common Messages .proto file

ProtoMessage

Required Type Field Name Description
required uint32 payloadType Contains id of ProtoPayloadType or other custom PayloadTypes (e.g. ProtoOAPayloadType)
optional bytes clientId Serialized protobuf message that corresponds to payloadType
optional string clientMsgId Request message id, assigned by the client that will be returned in the response.


ProtoErrorRes

Required Type Field Name Description
optional ProtoPayloadType payloadType Contains name of ProtoErrorCode or other custom ErrorCodes (e.g. ProtoCHErrorCode)
required string errorCode Error description
optional string description Serialized protobuf message that corresponds to payloadType
optional uint64 maintenanceEndTimestamp Epoch timestamp in second


ProtoHeartbeatEvent

Required Type Field Name Description
optional ProtoPayloadType payloadType Contains name of ProtoErrorCode or other custom ErrorCodes (e.g. ProtoCHErrorCode)