API browser of generalInvoiceRequest450 COM module


/images/arrow_right.png IGeneralInvoiceResult::GetFirstGrouperRecord method space
Retrieves the first Grouper record from the list of Grouper records.
 
VARIANT_FALSE is returned if the end of the Grouper record list is reached.
 
A copy of the data set that can be expected back, can be found under the important documents section.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralInvoiceResult/GetFirstGrouperRecord
[JSON input data] pIGeneralInvoiceResult: longValue,    //interface address
[JSON result data] peGrouperRecordType:
plNumber:
pbstrName:
pbStatus:
longValue,
longValue,
"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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT GetFirstGrouperRecord( GrouperRecordType
long
BSTR
VARIANT_BOOL
*peGrouperRecordType,
*plNumber,
*pbstrName,
*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.
space
/images/arrow_right.png Calling argument description
[out] GrouperRecordType *peGrouperRecordType The type of Grouper record for which the number=name pair is supplied.
[out] long *plNumber The number part of a number=name pair
 
For example, the 2nd choice of the grouper provider type (enGrouperProviderType) is Maison des naissances in french. Therefore to code this combination use number="1" and name="Maison des naissances" for language="french".
[out] BSTR *pbstrName The name part of a number=name pair
 
For example, the 2nd choice of the grouper provider type (enGrouperProviderType) is Maison des naissances in french. Therefore to code this combination use number="1" and name="Maison des naissances" for language="french".
[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached
space