pushAdminMessage COM module is a data
exchange system for treatment messages
exchange system for treatment messages
API browser of pushAdminMessage450 COM module
IPushAdminMessageResult::GetMessage4Ambulatory method | |||
---|---|---|---|
Retrieves the primary administrative message parameters for an ambulatory treatment.
Call the property GetTreatmentType first to test it is a ambulatory or stationary treatment. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IPushAdminMessageResult/GetMessage4Ambulatory | ||
[JSON input data] | pIPushAdminMessageResult: | longValue, //interface address |
|
[JSON result data] | peMessageAction: pdMessageDate: peTreatmentReason: pbStatus: |
longValue, "stringISODateValue", longValue, booleanValue |
|
[HTTP result status] | 200 | Return status 200 signals a successful method call | |
204 | Return status 204 (noContent) signals that the end of an iteration is reached | ||
>= 400 | Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do. | ||
C/C++ calling syntax | |||
HRESULT GetMessage4Ambulatory( | MessageActionType
DATE TreatmentReasonType VARIANT_BOOL |
*peMessageAction,
*pdMessageDate, *peTreatmentReason, *pbStatus); |
|
[C/C++ return value] | S_OK | This value is returned if the function call was successful. | |
S_FALSE | This value is returned if the end of an iteration is reached | ||
E_name | This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions. | ||
Calling argument description | |||
[out] MessageActionType | *peMessageAction | The message action is the principle action of message encoded by the MessageActionType enumeration | |
[out] DATE | *pdMessageDate | The message date is the date and time when the message's action is performed/defined almost like 'message_type::message_action@message_date' | |
[out] TreatmentReasonType | *peTreatmentReason | The treatment reason given by the TreatmentReasonType enumeration | |
[out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string. | |