 | DataUpdateServiceInsertAddressResidential Method |
Inserts a new residential address.
Namespace:
(Default Namespace)
Assembly:
SeniorSystemsWS (in SeniorSystemsWS.dll) Version: 937.0.0.0 (937.0.0.33)
Syntaxpublic ResultAddress InsertAddressResidential(
int entityNo,
AddressResidential addr,
string authKey
)
Public Function InsertAddressResidential (
entityNo As Integer,
addr As AddressResidential,
authKey As String
) As ResultAddress
public:
ResultAddress^ InsertAddressResidential(
int entityNo,
AddressResidential^ addr,
String^ authKey
)
public function InsertAddressResidential(
entityNo : int,
addr : AddressResidential,
authKey : String
) : ResultAddress
function InsertAddressResidential(entityNo, addr, authKey);
Parameters
- entityNo
- Type: SystemInt32
An entity number (the owner of the address). - addr
- Type: SeniorSystemsWS.EntityAddressResidential
The new residential address. - 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
Success or failure is obtained by checking
ResultAddress.Status.
Additional error information is contained in
ResultAddress.ErrorType.
If successful, the pending address record number can be found in NewAddressNo
The authorization key provided must be linked to an administrator role.
The following are items of note:
- The value in entityNo must reference a parent or constituent.
- AddressCode must be 'Residential'.
- BillCode must be 'Original', 'Copy', or null
- Only constituents can have more than one residential address.
See Also