 | DataUpdateServiceDeletePendingNote Method |
Deletes a pending note.
Namespace:
(Default Namespace)
Assembly:
SeniorSystemsWS (in SeniorSystemsWS.dll) Version: 937.0.0.0 (937.0.0.33)
Syntaxpublic ResultNotes DeletePendingNote(
int entityNo,
string authKey
)
Public Function DeletePendingNote (
entityNo As Integer,
authKey As String
) As ResultNotes
public:
ResultNotes^ DeletePendingNote(
int entityNo,
String^ authKey
)
public function DeletePendingNote(
entityNo : int,
authKey : String
) : ResultNotes
function DeletePendingNote(entityNo, authKey);
Parameters
- entityNo
- Type: SystemInt32
The entity number of the person who sent the message. - authKey
- Type: SystemString
Authentication Key obtained from the loginExt method in UserManagementService for a current administrator connection.
Return Value
Type:
ResultNotes
A
ResultNotes object.
Exceptions
Remarks
A note can be sent to the school to pass along any information/changes that should be made to someone's account
that cannot be done with any existing methods. This method will delete a note that has been sent but has not yet been approved.
The value in entityNo must reference a parent or constituent.
Success or failure is obtained by checking ResultNotes.Status.
Additional error information is contained in ResultNotes.ErrorType.
The authorization key provided must be linked to an administrator role.
See Also