InsertGroups (Method)

Pronto v5 Web Services

Method

InsertGroups

Collapse All

Pronto v5 Web Services > All Operations Resource Group : InsertGroups (Method)

Request (IProntoService_InsertGroups_InputMessage)

The request body is of type InsertGroups.

Request Body Parameters

Name	Description	Data Type
serviceAuthentication		ServiceAuthenticationModel
groupInsertRequestModel		GroupInsertRequestModel

Overview

Sequence

serviceAuthentication optional ServiceAuthenticationModel Complex Type

Sequence

ApiKeyOrProntoID optional xs:string

ApiSecretOrAuthData optional xs:string

ApiUsername optional xs:string

ApiPassword optional xs:string

groupInsertRequestModel optional GroupInsertRequestModel Complex Type

Sequence

Groups optional ArrayOfGroupInsertModel Complex Type

Sequence

GroupInsertModel 0..∞ GroupInsertModel Complex Type

Sequence

ProntoID 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

PrivacyPolicy optional GroupPrivacyPolicyModel Complex Type

Sequence

Label optional xs:string

Url optional xs:string

DefaultBrand optional xs:string

DefaultContentSet optional xs:string

DefaultEmailTemplateSet optional xs:string

IsAdminLockedOut optional xs:boolean

DefaultEmailTemplateSetLanguage optional xs:string

DisableSignatureChrome optional xs:boolean

SignatureChromeHeader optional xs:string

SignatureChromeFooter optional xs:string

CascadePermissions optional xs:boolean

SmsUrl optional xs:string

SmsUrlExpiresInDays optional xs:int

MasterID optional xs:string

EnableLogging optional xs:boolean

Response (IProntoService_InsertGroups_OutputMessage)

The response body is of type InsertGroupsResponse.

Response Body Parameters

Name	Description	Data Type
InsertGroupsResult		GroupDetailsServiceReturnModel

Overview

InsertGroupsResponse

Sequence

InsertGroupsResult 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

CS
VB.NET

var model = new GroupInsertRequestModel()
{
    Groups = new GroupInsertModel[] 
    { 
        new GroupInsertModel()
        {
            Name = "Web Services Test Account",
            OwnerName = "Test Owner",
            OwnerEmail = "test@your-domain.com"
        }
    }
};
var results = serviceClient.InsertGroups(sa, model);
if (results.IsSuccessful)
{
    //do work...
}
else
{
    //handle error
}

Dim model = New GroupInsertRequestModel() With { 
	 .Groups = New GroupInsertModel() {New GroupInsertModel() With { 
		 .Name = "Web Services Test Account", 
		 .OwnerName = "Test Owner", 
		 .OwnerEmail = "test@your-domain.com" 
	}} 
}
Dim results = serviceClient.InsertGroups(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.