The ATL COM module miscValidator provides methods to
browse, search & validate records of varied tariffs
API browser of miscValidator200 COM module


/images/arrow_right.png ISearch::GetPropertyValue method space
Gets the explicit value of predefined property always returned in string form. Transform the string to a double or boolean as needed.
 
The list of properties whose value can be retrieved is given/returned by GetServiceProperties.
Please note that an error is returned for a property that is not "turned on" in the service properties.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/ISearch/GetPropertyValue
[JSON input data] pISearch:
bstrPropertyName:		 longValue,    //interface address
"utf8StringValue"
[JSON result data] pbstrPropertyValue:
pbStatus:		 "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 GetPropertyValue( BSTR
BSTR
VARIANT_BOOL 		bstrPropertyName,
*pbstrPropertyValue,
*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 bstrPropertyName The name of a property for which the value is requested. The possible property names are predefined as defined below. The names are treated in a case insensitive way.
  • "enServicePropertyHasTP" or in short "TP" returns the tax point of the service if the enServicePropertyHasTP bit is set by the GetServiceProperties property.
  • "enServicePropertyHasTPMin" or in short "TPmin" returns the minimal tax point of a variable TP service record if the enServicePropertyHasTPMin bit is set by the GetServiceProperties property.
    Note that the "enServicePropertyHasTPMax" bit is set as well if the "TPmin" bit is turned on.
  • "enServicePropertyHasTPMax" or in short "TPmax" returns the maximal tax point of a variable TP service record if the enServicePropertyHasTPMax bit is set by the GetServiceProperties property. If there is no explicit upper bound defined then 999999 is returned!
    Note that the "enServicePropertyHasTPMin" bit is set as well if the "TPmax" bit is turned on.
  • "enServicePropertyIsPercentService" or in short "percentService" returns the percent fraction of a percent service record if the enServicePropertyIsPercentService bit is set by the GetServiceProperties property.
    A percent service depends upon another prior defined service and the TP is the product of the scaled TP of the parent service times the (0.01*percent factor).
    Note that the "needsRefCode" bit is set as well if the "percentService" bit is turned on.
  • "enServicePropertyIsFrancService" or in short "francService" returns a Boolean value as string denoting the Franc status of the service.
    The returned value is one of
    • "0" aka is not a Franc service
    • "1" aka is a Franc service
  • "enServicePropertyIsNeedsRefCode" or in short "needsRefCode" returns a comma-separated list of target reference codes if the enServicePropertyIsNeedsRefCode bit is set by the GetServiceProperties property.
    The list of reference codes might be empty if the target reference code is unknown in advance.
    Note that the "needsRefCode" bit is set as well if the "percentService" bit is turned on.
  • "enServicePropertyHasVatRateCode" or in short "vatRateCode" returns the vat rate code the service record "belongs" to if the enServicePropertyHasVatRateCode bit is set by the GetServiceProperties property. Since all services belongs to a vat category this bit is always set.
    The returned vat rate code is one of
    • 0 = none (currently 0% vat rate)
    • 1 = reduced (currently 2.5% vat rate)
    • 2 = full (currently 7.7% vat rate)
  • "enServicePropertyHasExcludedVat" or in short "excludedVat" returns a Boolean value as string denoting the Brutto/Netto status of the service.
    The returned value is one of
    • "0" aka is a Brutto service with the vat included in the TP
    • "1" aka is a Netto service without an included vat in the TP
[out] BSTR *pbstrPropertyValue The property value given as a string.
[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 and value.
space