getChecklistByName sample API Call

Example Request getChecklistByNameSubmissionId

  • Input: single Submission ID and optional question_name parameter
    URL for use via HTTP request after Digest Authentication is performed:\

    https://mc-api.manuscriptcentral.com/api/s1m/v2/submissions/full/checklistsbyname/submissionids?_type=xml&site_name=salesdemoplus&ids='WRK4-15-Dec-0033'&locale_id=1&question_name=CONFIG_RES:CustomField:181547:5498:name

Example Response: getChecklistByNameSubmissionId

  • The response provides comprehensive details for the configured checklist, additionally refined using the question_name optional parameter.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
    <status>SUCCESS</status>
    <callId>e84dff0e-1296-4e92-ac9a-e2a1b6425571</callId>
    <result xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="checkListFull">
        <document>
            <checkLists>
                <checkList>
                    <detailId>37940</detailId>
                    <detailName>CONFIG_RES:FieldGroup:37940:name</detailName>
                    <displayDetailName>Admin Checklist</displayDetailName>
                    <displayTaskName>Admin Checklist</displayTaskName>
                    <documentTaskId>177125582</documentTaskId>
                    <questions>
                        <question>
                            <answerType>TYPE_CHECKBOX</answerType>
                            <answers>
                                <answer>
                                    <abbreviatedResponse></abbreviatedResponse>
                                    <answerId>451963</answerId>
                                    <answerName>asdf</answerName>
                                    <answerStatus>ACTIVE</answerStatus>
                                </answer>
                            </answers>
                            <questionId>181547</questionId>
                            <displayQuestionName>Color Figures OK</displayQuestionName>
                            <questionName>CONFIG_RES:CustomField:181547:5498:name</questionName>
                            <questionStatus>ACTIVE</questionStatus>
                            <questionText>Color Figures OK</questionText>
                        </question>
                    </questions>
                    <taskId>193137</taskId>
                    <taskName>CONFIG_RES:Task:193137:name</taskName>
                </checkList>
            </checkLists>
            <documentId>22130607</documentId>
            <documentIdLatest>22130607</documentIdLatest>
            <documentIdOriginal>22130607</documentIdOriginal>
            <submissionId>WRK4-15-Dec-0033</submissionId>
            <submissionIdLatest>WRK4-15-Dec-0033</submissionIdLatest>
            <submissionIdOriginal>WRK4-15-Dec-0033</submissionIdOriginal>
            <submissionStatus>
                <documentStatusId>3</documentStatusId>
                <documentStatusName>Submitted</documentStatusName>
                <inDraftFlag>false</inDraftFlag>
            </submissionStatus>
        </document>
    </result>
</Response>