API browser of generalFormRequest450 COM module


/images/arrow_right.png IGeneralFormResult::GetAddresses method space
This method has a Restful Webservice representation only!
Method for collecting all addresses covered by the IGeneralFormResult interface and returned as JSON array.
 
Please note that IGeneralCreditResult::GetAddresses takes over the functionality of the iterator pair IGeneralCreditResult::GetFirstAddress / IGeneralCreditResult::GetNextAddress with a single call, making the latter superfluous.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralFormResult/GetAddresses
[JSON input data] pIGeneralFormResult: longValue,    //interface address
[JSON result array] { pbstrAddressName:
peAddressRole:
pbstrEAN:
pbstrZSR:
pbstrNIF:
pbstrSpecialty:
pIAddress:





















pbStatus:
"utf8StringValue",
longValue,
"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 Calling argument description
[out] BSTR *pbstrAddressName The PDF internal variable name/placeholder onto which the address was mapped.
[out] AddressRoleType *peAddressRole The semantic typification of the address defined by the AddressRoleType enumerator.
[out] BSTR *pbstrEAN GLN (former EAN13) of the address party as supplied by medwin.ch
bstrEAN is empty if undefined
[out] BSTR *pbstrZSR ZSR number of the address party as supplied by santésuisse
bstrZSR is empty if undefined.

Note, that an employer's national BER number as defined by Swiss Federal Statistical Office MUST be supplied within the bstrZSR variable.

[out] BSTR *pbstrNIF The IV specific identification number NIF of the address party.
bstrNIF is empty if undefined
[out] BSTR *pbstrSpecialty The specialty of the address party, i.e. FMH title of a physician.
bstrSpecialty is empty if undefined
[out] IAddress **pIAddress The IAddress interface handle that allows to get the structured address data back.
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 the end of data is reached
space