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::GetPhones method | |||
---|---|---|---|
This method has a Restful Webservice representation only! Method for collecting all phone numbers covered by the address and returned as JSON array. Please note that IAddress::GetPhones takes over the functionality of the iterator pair IAddress::GetFirstPhone / IAddress::GetNextPhone with a single call, making the latter superfluous. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IAddress/GetPhones | ||
[JSON input data] | pIAddress: | longValue, //interface address |
|
[JSON result array] | { pbstrNumber: pbstrLocalCode: pbstrInternationalCode: pbstrExt: pbStatus: |
"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. | ||
Calling argument description | |||
[out] BSTR | *pbstrNumber | The pure phone number part of the full telephone number.
It is possible that the full telephone number is returned in this variable and the other parts of the telephone number left empty. |
|
[out] BSTR | *pbstrLocalCode | The local area code part of the telephone number. | |
[out] BSTR | *pbstrInternationalCode | The international calling code part of the telephone number. | |
[out] BSTR | *pbstrExt | the extension number part of the telephone number. | |
[out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached | |