API browser of tarmedValidator100 COM module


/images/arrow_right.png ISearch::GetQuantityMultiSessionRestrictions method space
This method has a Restful Webservice representation only!
Method for collecting all multi session quantity restrictions of a base service in one call without the necessity to call iterator pair GetFirstQuantityMultiSessionRestriction / GetNextQuantityMultiSessionRestriction.
 
The services are returned as JSON array however large that search space might be. So this might be a memory and performance bottleneck.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/ISearch/GetQuantityMultiSessionRestrictions
[JSON input data] pISearch:
lRecordID:
pdQuantity:
longValue,    //interface address
longValue,
doubleValue
[JSON result array] { pbstrOperator:
pdQuantity:
pdDays:
pbstrTimeUnit:
pbstrSettlementType:
pbstrServiceGroup:
pbStatus:
"utf8StringValue",
doubleValue,
doubleValue,
"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 Calling argument description
[in] long lRecordID The RecordID for which all multi session quantity restrictions are requested
[out] BSTR *pbstrOperator Operator.
[in,out] double *pdQuantity Quantity.
[out] double *pdDays Number of days for which the quantity restriction applies.
[out] BSTR *pbstrTimeUnit Time unit code.
[out] BSTR *pbstrSettlementType SettlementType for which the restriction applies, an empty value indicates that the restriction applies to the service independently of the settlement type.
[out] BSTR *pbstrServiceGroup Service group code. If not empty the quantity restriction applies to the whole service group.
[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