Pronto v5 Web Services
MethodGetGroups
Pronto v5 Web Services > All Operations Resource Group : GetGroups (Method)
Request (IProntoService_GetGroups_InputMessage)

The request body is of type GetGroups.

Request Body Parameters

NameDescriptionData Type
serviceAuthentication ServiceAuthenticationModel
groupDetailsRequest GroupDetailsRequestModel
MasterID Element Name Element SmsUrlExpiresInDays Element SmsUrl Element SignatureChromeFooter Element SignatureChromeHeader Element DisableSignatureChrome Element DefaultEmailTemplateSetLanguage Element DefaultEmailTemplateSet Element DefaultContentSet Element DefaultBrand Element ResultsCountStart Element ResultsCountLimit Element EnableLogging Element DefaultUserPasswordChangeInDays Element ProcessSessionExpirationInMinutes Element DefaultDocumentRetentionInDays Element IsActive Element ParentID Element OwnerEmail Element OwnerName Element string Element Sequence ProntoIDs Element Sequence groupDetailsRequest Element ApiPassword Element ApiUsername Element ApiSecretOrAuthData Element ApiKeyOrProntoID Element Sequence serviceAuthentication Element Sequence GetGroups Element

Overview

GetGroups
Sequence
serviceAuthentication optional ServiceAuthenticationModel Complex Type
Sequence
ApiKeyOrProntoID optional xs:string
ApiSecretOrAuthData optional xs:string
ApiUsername optional xs:string
ApiPassword optional xs:string
groupDetailsRequest optional GroupDetailsRequestModel Complex Type
Sequence
ProntoIDs optional ArrayOfstring Complex Type
Sequence
string 0..∞ xs:string
OwnerName optional xs:string
OwnerEmail optional xs:string
ParentID optional xs:string
IsActive optional xs:boolean
DefaultDocumentRetentionInDays optional xs:int
ProcessSessionExpirationInMinutes optional xs:short
DefaultUserPasswordChangeInDays optional xs:short
EnableLogging optional xs:boolean
ResultsCountLimit optional xs:int
ResultsCountStart optional xs:int
DefaultBrand optional xs:string
DefaultContentSet optional xs:string
DefaultEmailTemplateSet optional xs:string
DefaultEmailTemplateSetLanguage optional xs:string
DisableSignatureChrome optional xs:boolean
SignatureChromeHeader optional xs:string
SignatureChromeFooter optional xs:string
SmsUrl optional xs:string
SmsUrlExpiresInDays optional xs:int
Name optional xs:string
MasterID optional xs:string
Response (IProntoService_GetGroups_OutputMessage)

The response body is of type GetGroupsResponse.

Response Body Parameters

NameDescriptionData Type
GetGroupsResult GroupDetailsServiceReturnModel
TimeZoneUtcOffset Element ProcessingTime Element GroupDetailsModel Element Sequence Groups Element Message Element IsSuccessful Element Sequence GetGroupsResult Element Sequence GetGroupsResponse Element

Overview

GetGroupsResponse
Sequence
GetGroupsResult optional GroupDetailsServiceReturnModel Complex Type
Sequence
IsSuccessful optional xs:boolean
Message optional xs:string
Groups optional ArrayOfGroupDetailsModel Complex Type
Sequence
GroupDetailsModel 0..∞ GroupDetailsModel Complex Type
Sequence
ProntoID optional xs:string
AuthData optional xs:string
Name optional xs:string
OwnerName optional xs:string
OwnerEmail optional xs:string
ParentID optional xs:string
IsActive optional xs:boolean
DefaultDocumentRetentionInDays optional xs:int
ProcessSessionExpirationInMinutes optional xs:short
DefaultUserPasswordChangeInDays optional xs:short
CreatedDate optional xs:dateTime
MasterID optional xs:string
ParentName optional xs:string
ContinueOnFailFlags optional xs:int
LogoUrl optional xs:string
DigitalSignatureType optional xs:short
DoNotInheritDigitalSignatureTypeFromParent optional xs:boolean
PrivacyPolicy optional GroupPrivacyPolicyModel Complex Type
Sequence
Label optional xs:string
Url optional xs:string
IsAdminLockedOut optional xs:boolean
AdminHasPermission optional xs:boolean
DefaultBrand optional xs:string
DefaultContentSet optional xs:string
DefaultEmailTemplateSet optional xs:string
Parent optional GroupDetailsModel Complex Type
Sequence
ProntoID optional xs:string
AuthData optional xs:string
Name optional xs:string
OwnerName optional xs:string
OwnerEmail optional xs:string
ParentID optional xs:string
IsActive optional xs:boolean
DefaultDocumentRetentionInDays optional xs:int
ProcessSessionExpirationInMinutes optional xs:short
DefaultUserPasswordChangeInDays optional xs:short
CreatedDate optional xs:dateTime
MasterID optional xs:string
ParentName optional xs:string
ContinueOnFailFlags optional xs:int
LogoUrl optional xs:string
DigitalSignatureType optional xs:short
DoNotInheritDigitalSignatureTypeFromParent optional xs:boolean
PrivacyPolicy optional GroupPrivacyPolicyModel Complex Type
Sequence
Label optional xs:string
Url optional xs:string
IsAdminLockedOut optional xs:boolean
AdminHasPermission optional xs:boolean
DefaultBrand optional xs:string
DefaultContentSet optional xs:string
DefaultEmailTemplateSet optional xs:string
Parent optional GroupDetailsModel Complex Type
IsMfaEnabled optional xs:boolean
MfaEmailTemplate optional GroupMfaEmailTemplateModel Complex Type
Sequence
Body optional xs:string
Subject optional xs:string
UseCustomMfa optional xs:boolean
EnableMultifactorAuth optional xs:boolean
DefaultEmailTemplateSetLanguage optional xs:string
DisableSignatureChrome optional xs:boolean
SignatureChromeHeader optional xs:string
SignatureChromeFooter optional xs:string
CascadePermissions optional xs:boolean
EmailIntegration optional ThirdPartyCredentialDetailsModel Complex Type
Sequence
ID optional xs:int
ProntoID optional xs:string
Type optional xs:string
Name optional xs:string
Data optional xs:string
Credential optional BaseCredential Complex Type
IsAccountWide optional xs:boolean
ClientID optional xs:string
ClientSecret optional xs:string
IsActive optional xs:boolean
AccountName optional xs:string
SmsUrl optional xs:string
SmsUrlExpiresInDays optional xs:int
IsMfaEnabled optional xs:boolean
MfaEmailTemplate optional GroupMfaEmailTemplateModel Complex Type
Sequence
Body optional xs:string
Subject optional xs:string
UseCustomMfa optional xs:boolean
EnableMultifactorAuth optional xs:boolean
DefaultEmailTemplateSetLanguage optional xs:string
DisableSignatureChrome optional xs:boolean
SignatureChromeHeader optional xs:string
SignatureChromeFooter optional xs:string
CascadePermissions optional xs:boolean
EmailIntegration optional ThirdPartyCredentialDetailsModel Complex Type
Sequence
ID optional xs:int
ProntoID optional xs:string
Type optional xs:string
Name optional xs:string
Data optional xs:string
Credential optional BaseCredential Complex Type
Sequence
IsAccountWide optional xs:boolean
ClientID optional xs:string
ClientSecret optional xs:string
IsActive optional xs:boolean
AccountName optional xs:string
SmsUrl optional xs:string
SmsUrlExpiresInDays optional xs:int
ProcessingTime optional xs:string
TimeZoneUtcOffset optional xs:double
Example
var model = new GroupDetailsRequestModel()
{
    ProntoIDs = new string[] 
    { 
        "MyAccountName"
    }
};
var results = serviceClient.GetGroups(sa, model);
if (results.IsSuccessful)
{
    //do work...
}
else
{
    //handle error
}
Dim model = New GroupDetailsRequestModel() With { 
	 .ProntoIDs = New String() {"MyAccountName"} 
}
Dim results = serviceClient.GetGroups(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.