The generalInvoiceResponse ATL COM module loads &
analyzes electronic responses to general invoice requests
analyzes electronic responses to general invoice requests
API browser of generalInvoiceResponse450 COM module
IGeneralInvoiceResponse::GetNotifications method | |||
---|---|---|---|
This method has a Restful Webservice representation only! Method for collecting all notification objects covered by the IGeneralInvoiceResponse interface and returned as JSON array. Please note that IGeneralInvoiceResponse::GetNotifications takes over the functionality of the iterator pair IGeneralInvoiceResponse::GetFirstNotification / IGeneralInvoiceResponse::GetNextNotification with a single call, making the latter superfluous. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralInvoiceResponse/GetNotifications | ||
[JSON input data] | pIGeneralInvoiceResponse: | longValue, //interface address |
|
[JSON result array] | { pbstrCode: pbstrText: peIsAnError: plRecordID: pbstrErrorValue: pbstrValidValue: pbStatus: |
"utf8StringValue", "utf8StringValue", longValue, longValue, "utf8StringValue", "utf8StringValue", 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. | ||
Calling argument description | |||
[out] BSTR | *pbstrCode | A message or error code dependent on the notification type.
Note that this code is defined by the "fromEAN" entity and is not standardized. |
|
[out] BSTR | *pbstrText | A message or error text dependent on the notification type.
Note that this text is defined by the "fromEAN" entity and is not standardized. |
|
[out] YesNoType | *peIsAnError | A Boolean that defines if it is an error or a message.
In the latter case bstrErrorValue and bstrValidValue are empty and lRecordID is set to 0. |
|
[out] long | *plRecordID | A record sequence number from the request uniquely identifying the target service record.
If eIsAnError=enYes or the error is not related to a service record lRecordID is 0. |
|
[out] BSTR | *pbstrErrorValue | The erroneous/incorrect value if the notification is casted as error (eIsAnError=enYes) otherwise 0 | |
[out] BSTR | *pbstrValidValue | The valid/correct value if the notification is casted as error (eIsAnError=enYes) otherwise 0 | |
[out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached | |