tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDocuments

Last updated: 2024-04-01 19:34:39

    1. API Description

    This API will be disused soon.

    Planned disuse time: 2023-07-19 20:06:57

    Domain name for API request: lcic.tencentcloudapi.com.

    有新接口替换

    A new API is offered for this action now.

    This API is used to query courseware. It has been deprecated. Please use BatchDescribeDocument instead.

    A maximum of 20 requests can be initiated per second for this API.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: DescribeDocuments.
    Version Yes String Common Params. The value used for this API: 2022-08-17.
    Region No String Common Params. This parameter is not required.
    SchoolId Yes Integer The school ID.
    Page Yes Integer The page to return records from. Pagination starts from 1.
    Limit Yes Integer The maximum number of records per page. The value of this parameter cannot exceed 1000.
    Permission.N Yes Array of Integer The courseware access. [0]: The private courseware of the specified user (Owner) will be returned; [1]: The public courseware of the specified user will be returned; [0,1]: Both the private and public courseware of the specified user will be returned; [2]: The private courseware of the specified user and the public courseware of all users (including Owner) will be returned.
    Owner No String The user ID of the courseware owner. If you do not specify this parameter, all courseware under the school ID will be returned.
    Keyword No String The filename keyword.
    DocumentId.N No Array of String The courseware IDs. Non-existent IDs will be ignored.

    3. Output Parameters

    Parameter Name Type Description
    Total Integer The total number of records that meet the conditions.
    Documents Array of DocumentInfo The information of the courseware.
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying courseware

    This example shows you how to query courseware.

    Input Example

    POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDocuments
<Common request parameters>

{
    "SchoolId": 1,
    "Page": 0,
    "Limit": 0,
    "Permission": [
        1
    ],
    "Owner": "abc",
    "Keyword": "abc",
    "DocumentId": [
        "abc"
    ]
}

    Output Example

    {
    "Response": {
        "Total": 0,
        "Documents": [
            {
                "DocumentId": "abc",
                "DocumentUrl": "abc",
                "DocumentName": "abc",
                "Owner": "abc",
                "SdkAppId": 1,
                "Permission": 1,
                "TranscodeResult": "abc",
                "TranscodeType": 1,
                "TranscodeProgress": 1,
                "TranscodeState": 1,
                "TranscodeInfo": "abc",
                "DocumentType": "abc",
                "DocumentSize": 1,
                "UpdateTime": 1,
                "Pages": 1,
                "Width": 1,
                "Height": 1,
                "Cover": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidParameter.SdkAppId SdkAppId is incorrect.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy