The generalCreditRequest ATL COM module for
generating electronic and paper based credit requests
generating electronic and paper based credit requests
API browser of generalCreditRequest450 COM module
IGeneralCreditRequest::AddXtraData4CantonalPhysician method | |||
---|---|---|---|
Adds a token/value pair to the list of cantonal physician instructions.
It should be noted that the data space for the cantonal physician (CP) is exclusively defined by the Swiss cantonal authorities. While at the moment of this documenbtation all needed data for the CP can be delivered by the SetData4CantonalPhysician method, this generic token/value approach presents a safeguard for allowing an expansion of the data situation (due to corresponding cantonal requirements) without the necessity of changing the basic underlaying standard generalCreditRequest450. Note, that the semantic, grammar and nomenclature of these instructions are unstandardized and bilateral in nature between biller and CP. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralCreditRequest/AddXtraData4CantonalPhysician | ||
[JSON input data] | pIGeneralCreditRequest: bstrToken: bstrValue: |
longValue, //interface address "utf8StringValue", "utf8StringValue" |
|
[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 AddXtraData4CantonalPhysician( | BSTR
BSTR VARIANT_BOOL |
bstrToken,
bstrValue, *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] BSTR | bstrToken | The name of the token/value instruction pair | |
[in] BSTR | bstrValue | The data of the token/value instruction pair | |
[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. | |