Pronto v5 Web Services
MethodGetUsersUpdateable
Pronto v5 Web Services > All Operations Resource Group : GetUsersUpdateable (Method)
Request (IProntoService_GetUsersUpdateable_InputMessage)

The request body is of type GetUsersUpdateable.

Request Body Parameters

NameDescriptionData Type
serviceAuthentication ServiceAuthenticationModel
userUpdateableRequestModel UserUpdateableRequestModel
ResultsCountStart Element ResultsCountLimit Element EnableLogging Element ControlPanelAuthorityType Element SigningAuthorityType Element IsExpired Element IsLockedOut Element string Element Sequence EmailAddresses Element string Element Sequence Usernames Element int Element Sequence IDs Element string Element Sequence ProntoIDs Element Sequence userUpdateableRequestModel Element ApiPassword Element ApiUsername Element ApiSecretOrAuthData Element ApiKeyOrProntoID Element Sequence serviceAuthentication Element Sequence GetUsersUpdateable Element

Overview

GetUsersUpdateable
Sequence
serviceAuthentication optional ServiceAuthenticationModel Complex Type
Sequence
ApiKeyOrProntoID optional xs:string
ApiSecretOrAuthData optional xs:string
ApiUsername optional xs:string
ApiPassword optional xs:string
userUpdateableRequestModel optional UserUpdateableRequestModel Complex Type
Sequence
ProntoIDs optional ArrayOfstring Complex Type
Sequence
string 0..∞ xs:string
IDs optional ArrayOfint Complex Type
Sequence
int 0..∞ xs:int
Usernames optional ArrayOfstring Complex Type
Sequence
string 0..∞ xs:string
EmailAddresses optional ArrayOfstring Complex Type
Sequence
string 0..∞ xs:string
IsLockedOut optional xs:boolean
IsExpired optional xs:boolean
SigningAuthorityType optional Option.UserProcessAuthorityTypes Simple Type
ControlPanelAuthorityType optional Option.UserControlPanelAuthorityTypes Simple Type
EnableLogging optional xs:boolean
ResultsCountLimit optional xs:int
ResultsCountStart optional xs:int
Response (IProntoService_GetUsersUpdateable_OutputMessage)

The response body is of type GetUsersUpdateableResponse.

Response Body Parameters

NameDescriptionData Type
GetUsersUpdateableResult UserUpdateableServiceReturnModel
TimeZoneUtcOffset Element ProcessingTime Element UserUpdateModel Element Sequence UpdateableUsers Element Message Element IsSuccessful Element Sequence GetUsersUpdateableResult Element Sequence GetUsersUpdateableResponse Element

Overview

GetUsersUpdateableResponse
Sequence
GetUsersUpdateableResult optional UserUpdateableServiceReturnModel Complex Type
Sequence
IsSuccessful optional xs:boolean
Message optional xs:string
UpdateableUsers optional ArrayOfUserUpdateModel Complex Type
Sequence
UserUpdateModel 0..∞ UserUpdateModel Complex Type
Sequence
ID optional xs:int
ProntoID optional xs:string
Username optional xs:string
SigningAuthorityType optional Option.UserProcessAuthorityTypes Simple Type
FirstName optional xs:string
LastName optional xs:string
EmailAddress optional xs:string
SecurityQuestion optional xs:string
SecurityAnswer optional xs:string
Title optional xs:string
Organization optional xs:string
SignatureImage optional xs:base64Binary
ControlPanelAuthorityType optional Option.UserControlPanelAuthorityTypes Simple Type
ViewUnassignedRegUserTransactions optional xs:boolean
FederatedUsername optional xs:string
RequirePasswordChangeOnFirstUse optional xs:boolean
Password optional xs:string
IsLockedOut optional xs:boolean
IsExpired optional xs:boolean
PasswordChangeInDays optional xs:short
Permissions optional ArrayOfUserPermissionUpdateModel Complex Type
Sequence
UserPermissionUpdateModel 0..∞ UserPermissionUpdateModel Complex Type
Sequence
AllowOpenSigning optional xs:boolean
AllowOpenSigningQueue optional xs:boolean
AllowSigning optional xs:boolean
PermissionSetID optional xs:int
ProntoID optional xs:string
Federations optional ArrayOfUserFederationInsertModel Complex Type
Sequence
ProcessingTime optional xs:string
TimeZoneUtcOffset optional xs:double
Example
var model = new UserUpdateableRequestModel() 
{
    IDs = new int[] 
    { 
        123
    }
};
var results = serviceClient.GetUsersUpdateable(sa, model);
if (results.IsSuccessful)
{
    //do work...
}
else
{
    //handle error
}
Dim model = New UserUpdateableRequestModel() With { 
	 .IDs = New Integer() {123} 
}
Dim results = serviceClient.GetUsersUpdateable(sa, model)
If Not results.IsSuccessful Then
    'do work...
Else
    'handle error
End If
See Also
All Operations Resource Group | Pronto v5 Web Services

 

 

© 2022 All Rights Reserved.

Send comments on this topic.