 | DataUpdateServiceDeleteAddress Method |
Deletes an existing address.
Namespace:
(Default Namespace)
Assembly:
SeniorSystemsWS (in SeniorSystemsWS.dll) Version: 937.0.0.0 (937.0.0.33)
Syntaxpublic ResultAddress DeleteAddress(
int addressNo,
string authKey
)
Public Function DeleteAddress (
addressNo As Integer,
authKey As String
) As ResultAddress
public:
ResultAddress^ DeleteAddress(
int addressNo,
String^ authKey
)
public function DeleteAddress(
addressNo : int,
authKey : String
) : ResultAddress
function DeleteAddress(addressNo, authKey);
Parameters
- addressNo
- Type: SystemInt32
An address number. - authKey
- Type: SystemString
Authentication Key obtained from the loginExt method in UserManagementService for a current administrator connection.
Return Value
Type:
ResultAddress
A
ResultAddress object.
Exceptions
Remarks
This method creates a pending address change record for the address
addressNo. This pending address will be
marked for delete. If the addresses number provides points to an existing pending address record, the pending record will be
marked for delete.
Success or failure is obtained by checking ResultAddress.Status.
Additional error information is contained in ResultAddress.ErrorType.
The authorization key provided must be linked to an administrator role.
See Also