Method: listAssignments

Permissions to Run Request

Account Owner, Account Administrators, Department Administrators or custom roles that allow to grade assignments.

Request Parameters

Parameter	Type	Description
token (required)	string	Access token. You can obtain a token by making a request.
ungraded (optional)	string	If this parameter is not specified, all ungraded assignments will be selected. If there is 1, all ungraded assignments will be selected. If there is, all assignments will be selected.
pageSize (optional)	string	The number of entries per page. If not indicated, equal to 1000.
pageToken (optional)	string	The token to continue to the next page.

Return Values

After the request is successfully processed, the system returns an object with the following properties:

Parameter	Type	Description
assignments	Assignmnent[]	An array containing information about the assignments.
nextPageToken	string	The token to continue to the next page.

Assignmnent

Parameter	Type	Description
assignmentId	string	The ID of the assignment.
title	string	The name of the assignment.

Possible Errors

Error	Description
InvalidArgumentException	Invalid request.
Permission denied	The user doesn't have permission to handle the request.

Sample Request

SoapAction: "https://%HOST%/soap/2.0/listAssignments"

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://ispringlearn.com/go/services/api/soap">
    <soapenv:Header/>
    <soapenv:Body>
        <soap:ListAssignmentsRequest>
            <soap:credentials>
              <soap:token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</soap:token>
            </soap:credentials>
            <soap:pageSize>10</soap:pageSize>
            <soap:pageToken>string</soap:pageToken>
        </soap:ListAssignmentsRequest>
    </soapenv:Body>
</soapenv:Envelope>

XML

Sample Response

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://ispringlearn.com/go/services/api/soap">
    <SOAP-ENV:Body>
        <ns1:ListAssignmentsResult>
            <ns1:assignments>
                <ns1:assignment>
                    <ns1:assignmentId>16888ca8-1fab-11ec-99d4-0242ac120034</ns1:assignmentId>
                    <ns1:title>test 1</ns1:title>
                </ns1:assignment>
                <ns1:assignment>
                    <ns1:assignmentId>63ba9de0-1fab-11ec-acab-0242ac120034</ns1:assignmentId>
                    <ns1:title>test 2</ns1:title>
                </ns1:assignment>
            </ns1:assignments>            
            <ns1:nextPageToken>string</ns1:nextPageToken>
        </ns1:ListAssignmentsResult>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

XML