API browser of generalnotification451 COM module


/images/arrow_right.png IAddress::SetPostal method space
Sets the structured postal address part.

The Swiss ISO county code is the default but is filtered in the printing.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IAddress/SetPostal
[JSON input data] pIAddress:
bstrStreet:
bstrPoBox:
bstrZip:
bstrCity:
bstrStateCode:
bstrCountryCode:
longValue,    //interface address
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue"
[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 SetPostal( BSTR
BSTR
BSTR
BSTR
BSTR
BSTR
VARIANT_BOOL
bstrStreet,
bstrPoBox,
bstrZip,
bstrCity,
bstrStateCode,
bstrCountryCode,
*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 bstrStreet The street name part of an address.
[in] BSTR bstrPoBox The P.O. box code part of an address.

Note that according to the Post the street and poBox parts should be used mutually exclusive.

[in] BSTR bstrZip The mandatory ZIP code part of an address.
[in] BSTR bstrCity The mandatory city name of an address.
[in] BSTR bstrStateCode The optional state code part of an address.
[in] BSTR bstrCountryCode The ISO country code of an address.
[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