pushAdminMessage COM module is a data
exchange system for treatment messages
exchange system for treatment messages
API browser of pushAdminMessage450 COM module
IAddress::GetPerson method | |||
---|---|---|---|
Retrieves the person's naming part of the address.
Call the property GetType first to test if GetPerson or GetCompany should be called. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IAddress/GetPerson | ||
[JSON input data] | pIAddress: | longValue, //interface address |
|
[JSON result data] | pbstrFamilyname: pbstrGivenname: pbstrSalutation: pbstrTitle: pbstrSubaddressing: pbStatus: |
"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 GetPerson( | BSTR
BSTR BSTR BSTR BSTR VARIANT_BOOL |
*pbstrFamilyname,
*pbstrGivenname, *pbstrSalutation, *pbstrTitle, *pbstrSubaddressing, *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 | *pbstrFamilyname | The family name (or last name) of the person. | |
[out] BSTR | *pbstrGivenname | The given name (or first name) of the person. | |
[out] BSTR | *pbstrSalutation | The optional salutation of the person. | |
[out] BSTR | *pbstrTitle | The optional title of the person. | |
[out] BSTR | *pbstrSubaddressing | The optional subaddressing information, e.g. a "c/o" like information as defined by the Post | |
[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. | |