API browser of generalFormRequest450 COM module


/images/arrow_right.png IGeneralFormRequest::AddAddress method space
Sets the structured address and primary parameters like GLN, ZSR, etc. for a certain address define by the PDF form variable name.

The address is defined via a IAddress interface pointer and the IAddress data must be defined prior to call this method.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralFormRequest/AddAddress
[JSON input data] pIGeneralFormRequest:
bstrAddressName:
bstrEAN:
bstrZSR:
bstrNIF:
bstrSpecialty:
pIAddress:
longValue,    //interface address
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
longValue
[JSON result data] pbStatus: 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 AddAddress( BSTR
BSTR
BSTR
BSTR
BSTR
IAddress
VARIANT_BOOL
bstrAddressName,
bstrEAN,
bstrZSR,
bstrNIF,
bstrSpecialty,
*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
[in] BSTR bstrAddressName The variable name/placeholder of the address.

Use the iterator pair GetFirstAddressRole / GetNextAddressRole to retrieve the variable name, the semantical typification and the status (defined or undefined) of all addresses defined by the currently load PDF form.

[in] BSTR bstrEAN GLN (former EAN13) of the given address party as supplied by medwin.ch
Leave empty if the GLN is unknown.
[in] BSTR bstrZSR ZSR number of the given address party as supplied by santésuisse.
Leave empty if the NIF number is unknown.

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

[in] BSTR bstrNIF The IV specific identification number NIF of the given address party.
Leave empty if the NIF number is unknown.
[in] BSTR bstrSpecialty An optional specialty (i.e. FMH title of a physician) of the given address party
Leave empty if the there is no specialty to supply.
[in] IAddress *pIAddress Pointer to an IAddress interface instance that holds the structured address parts.
A NULL pointer is supplied if no address should be set.
[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