pushAdminMessage COM module is a data
exchange system for treatment messages
exchange system for treatment messages
API browser of pushAdminMessage450 COM module
IPushAdminMessageRequest::SetMessage4Ambulatory method | |||
---|---|---|---|
Sets and defines the primary administrative message parameters for an ambulatory treatment. | |||
Restful webservice calling syntax | |||
[POST] | /baseURL/IPushAdminMessageRequest/SetMessage4Ambulatory | ||
[JSON input data] | pIPushAdminMessageRequest: eMessageAction: dMessageDate: eTreatmentReason: |
longValue, //interface address longValue, variantDateValue | "stringISODateValue", longValue |
|
[JSON result data] | pbStatus: | 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 SetMessage4Ambulatory( | MessageActionType
DATE TreatmentReasonType VARIANT_BOOL |
eMessageAction,
dMessageDate, eTreatmentReason, *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 | |||
[in] MessageActionType | eMessageAction | The message action is the principle action of message encoded by the MessageActionType enumeration | |
[in] DATE | dMessageDate | The message date is the date and time when the message's action is performed/defined almost like 'message_type::message_action@message_date' | |
[in] TreatmentReasonType | eTreatmentReason | 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. | |