This API determines whether a given user can add an ad hoc approver to a list of approval requests. This API accepts a user ID and list of approval requests as input parameter and returns a list of approval requests the user has permissions to. For details on the input structure, refer to PermissionResponseDTO.

API

Signature

canAddAdhocApprover

WebService static List<PermissionResponseDTO> canAddAdhocApprover(ID userId, List<Approval_Request__c> requests);

Request Parameters
NameTypeRequired?Description
userIdIDYesID of a given user. 

Approval_Request__c

ListYesList of approval requests.


Response Parameter
NameTypeDescription
PermissionResponseDTOListList of approval requests.

Integration Details

Use the following information in your integrations with Conga Approvals API. See Integrating Conga with External Systems to get started.

API Prerequisites

None.

Response/Request XML

Example Request

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:app="http://soap.sforce.com/schemas/class/Apttus_Approval/ApprovalsWebService" >
    <soapenv:Header>
        <app:SessionHeader>
            <app:sessionId>00D1100000CM36i!ARkAQAhcDKNrCF6UES74x8alG4XcHv7hoylqycl.Hr.wkayGbXLb9QI81sX45XYS1M8F29cGtznu3RRgupmNsRfO49uJbr2w</app:sessionId>
        </app:SessionHeader>
    </soapenv:Header>
    <soapenv:Body>
        <app:canAddAdhocApprover>
            <app:userId>0051100000CsHKu</app:userId>
            <app:requests>
                <app:Apttus_Approval__Approval_Request__c>
                    <ar:Id>a1W11000008fXduEAE</ar:Id>
                    <!--other fields for approval request instance-->
                </app:Apttus_Approval__Approval_Request__c>
            </app:requests>
        </app:canAddAdhocApprover>
    </soapenv:Body>
</soapenv:Envelope>
XML

Example Response

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns="http://soap.sforce.com/schemas/class/Apttus_Approval/ApprovalsWebService">
    <soapenv:Body>
        <app:canAddAdhocApprover>
            <app:PermissionResponseDTO>
                <app:requestId>a1W11000008fXduEAE</app:requestId>
                <app:hasPermission>true</app:hasPermission>
            </app:PermissionResponseDTO>
        </app:canAddAdhocApprover>
    </soapenv:Body>
</soapenv:Envelope>
XML