API browser of migelValidator100 COM module


/images/arrow_right.png IMigelValidator::GetFirstChapter method space
Retrieves the first chapter information.
 
Method patched for searching tariff dependent on tariff 452 or 454 - cf. variable bstrCode!
The list of all applied patches can be seen at "List of patches for managing the new tariff 454"
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IMigelValidator/GetFirstChapter
[JSON input data] pIMigelValidator:
bstrCode:
longValue,    //interface address
"utf8StringValue"
[JSON result data] pbstrCode:
pbstrName:
pbstrInterpretation:
pbstrLimitation:
pbStatus:
"utf8StringValue",
"utf8StringValue",
"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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT GetFirstChapter( BSTR
BSTR
BSTR
BSTR
BSTR
VARIANT_BOOL
bstrCode,
*pbstrCode,
*pbstrName,
*pbstrInterpretation,
*pbstrLimitation,
*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
[in] BSTR bstrCode Query string for searching in the chapter code field of the tariff. Use asterisk symbol (*) to query for all records.
 
Patch: prepend the tag ("454::" | "452::" | "") allows to focus the search onto the appropriate tariff catalog, with the empty tag as default for tariff 452.
[out] BSTR *pbstrCode Chapter code
[out] BSTR *pbstrName Chapter name
[out] BSTR *pbstrInterpretation Chapter interpretation
[out] BSTR *pbstrLimitation Chapter limitation
[out,retval] VARIANT_BOOL *pbStatus Return status. VARIANT_TRUE means S_OK, VARIANT_FALSE means S_FALSE (e.g. in an iterator) or an error (E_name).
In the later case check for possible errors with the GetAbortInfo method.
space