API browser of pushAdminMessage450 COM module


/images/arrow_right.png IPushAdminMessageResult::GetBiller method space
Retrieves the biller's various identifiers (GLN, ZSR,...) as well as the structured address.
 
The structured address data is read via the methods of the returned Iaddress interface instance.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IPushAdminMessageResult/GetBiller
[JSON input data] pIPushAdminMessageResult: longValue,    //interface address
[JSON result data] pbstrEAN:
pbstrZSR:
pbstrNIF:
pbstrSpecialty:
pIAddress:





















pbStatus:
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
{
  pbIsPrivateAddress: true,
  pbstrCompanyName: "utf8StringValue",
  pbstrDepartment: "utf8StringValue",
  pbstrSalutation: "utf8StringValue",
  pbstrTitle: "utf8StringValue",
  pbstrFamilyname: "utf8StringValue",
  pbstrGivenname: "utf8StringValue",
  pbstrSubaddressing: "utf8StringValue",
  pbstrStreet: "utf8StringValue",
  pbstrPoBox: "utf8StringValue",
  pbstrZip: "utf8StringValue",
  pbstrCity: "utf8StringValue",
  pbstrStateCode: "utf8StringValue",
  pbstrCountryCode: "utf8StringValue",
  pbstrPhone1: "utf8StringValue",
  pbstrPhone2: "utf8StringValue",
  pbstrPhone3: "utf8StringValue",
  pbstrFax: "utf8StringValue",
  pbstrEMail: "utf8StringValue",
  pbstrUrl: "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 GetBiller( BSTR
BSTR
BSTR
BSTR
IAddress
VARIANT_BOOL
*pbstrEAN,
*pbstrZSR,
*pbstrNIF,
*pbstrSpecialty,
**pIAddress,
*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
[out] BSTR *pbstrEAN The GLN (former EAN) number of the biller as supplied by Stiftung Refdata
[out] BSTR *pbstrZSR The optional ZSR number of the biller as supplied by Santesuisse
[out] BSTR *pbstrNIF The optional IV specific identification number NIF of the biller
[out] BSTR *pbstrSpecialty The optional specialty, i.e. FMH title of the biller
[out] IAddress **pIAddress The instance of an IAddress interface that allows to read back the structured address data.
If no address is defined then the handle is NULL.
[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.
space