Sumex1.net/tarmedValidator/C++ API: ICatalog::GetFirstMechanicCode method

API browser of tarmedValidator100 COM module

ICatalog::GetFirstMechanicCode method
Retrieves the first utility information. All tarmed services have associated utility information specified with a so-called mechanic code. Depending on the mechanic code, different rules may apply for the service.

Restful webservice calling syntax
[POST]	/baseURL/ICatalog/GetFirstMechanicCode
[JSON input data]	pICatalog: bstrCode:	longValue, //interface address "utf8StringValue"
[JSON result data]	pbstrCode: pbstrName: pbStatus:	"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.

C/C++ calling syntax
HRESULT GetFirstMechanicCode(	BSTR BSTR BSTR VARIANT_BOOL	bstrCode, pbstrCode, 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.

Calling argument description
[in] BSTR	bstrCode	Mechanic code to search for. Use asterisk symbol (*) to search all records.
[out] BSTR	*pbstrCode	Mechanic code.
[out] BSTR	*pbstrName	Name of mechanism.
[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.