API browser of acfValidator100 COM module


/images/arrow_right.png ISearchTMA::GetServices method space
This method has a Restful Webservice representation only!
Method for collecting all service records of the resulting search space in one call without the necessity to call the record positioning methods and the appropriate properties of this interface.
 
The services are returned as JSON array in chunks of 200 services. Please refrain from using the positioning methods MoveFirst(), MoveNext(), etc. before calling GetServices() method. If there are more than 200 services available, just call GetServices() repeatedly until the HTTP return status is 204 == NoContent
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/ISearchTMA/GetServices
[JSON input data] pISearchTMA: longValue,    //interface address
[JSON result array] { pbstrChapterCode:
pbstrChapterName:
pbstrTariffType:
pbstrCode:
pbstrReferenceCode:
pbstrName:
pbstrInterpretation:
pdValidFrom:
pdValidTo:
plServiceProperties:
peTMAType:
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"stringISODateValue",
"stringISODateValue",
longValue,
longValue
  },
[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
[out] BSTR *pbstrChapterCode The chapter or capitulum code that the current service belongs to
[out] BSTR *pbstrChapterName The chapter or capitulum name that the current service belongs to
[out] BSTR *pbstrTariffType The official tariff number for TMA services - this is by definition 'TMA'
[out] BSTR *pbstrCode The TMA code of the current service
[out] BSTR *pbstrReferenceCode The reference code.

Note that this variable is always empty as the ACF tariff does not predefine such reference codes.

[out] BSTR *pbstrName The name of the current TMA service
[out] BSTR *pbstrInterpretation The interpretation (exclusion and inclusion remarks, rules, comments and the like) of the selected service
[out] DATE *pdValidFrom The validity start date of the selected TMA service record
[out] DATE *pdValidTo The validity end date of the selected TMA service record
[out] long *plServiceProperties This value defines all semantic capabilities of a service.
The value is a 32-bit integer composed from ORed values of the ServicePropertyType enumeration list.
[out] TMAType *peTMAType The characterization/type affiliation of the TMA service - the possible value range is predefined in TMAType.
space