The ATL COM module generalNotification is a structured
message exchange protocol between to healthcare partners
message exchange protocol between to healthcare partners
API browser of generalnotification451 COM module
IAddress::GetPostal method | |||
---|---|---|---|
Retrieves the structured postal address part of the address | |||
Restful webservice calling syntax | |||
[POST] | /baseURL/IAddress/GetPostal | ||
[JSON input data] | pIAddress: | longValue, //interface address |
|
[JSON result data] | pbstrStreet: pbstrPoBox: pbstrZip: pbstrCity: pbstrStateCode: pbstrCountryCode: pbStatus: |
"utf8StringValue", "utf8StringValue", "utf8StringValue", "utf8StringValue", "utf8StringValue", "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. | ||
C/C++ calling syntax | |||
HRESULT GetPostal( | BSTR
BSTR BSTR BSTR BSTR BSTR VARIANT_BOOL |
*pbstrStreet,
*pbstrPoBox, *pbstrZip, *pbstrCity, *pbstrStateCode, *pbstrCountryCode, *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. | ||
Calling argument description | |||
[out] BSTR | *pbstrStreet | The street name part of an address. | |
[out] BSTR | *pbstrPoBox | 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. |
|
[out] BSTR | *pbstrZip | The ZIP code part of an address. | |
[out] BSTR | *pbstrCity | The city name of an address. | |
[out] BSTR | *pbstrStateCode | The optional state code part of an address. | |
[out] BSTR | *pbstrCountryCode | The optional ISO country code part 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. | |