开发XBRL文件Web API按指定Period获取Context列表返回空数组求助

1. 修正XBRL命名空间错误 #

你的代码中使用的XNamespace是http://www.xbrl.org/2003/linkbase，但XBRL实例中的<context>和<period>元素属于instance命名空间，正确的命名空间应为：

XNamespace xbrli = "http://www.xbrl.org/2003/instance";

命名空间不匹配会导致Descendants(xbrli + "context")根本找不到任何元素，直接返回空列表。

2. 正确提取Period的日期值 #

XBRL的<period>元素并非直接包含文本值，它通常包含<startDate>和<endDate>（期间型）或<instant>（时点型）子元素。直接取context.Element(xbrli + "period").Value会得到所有子元素文本的拼接，格式和你传入的2022-01-01/2022-12-31完全不匹配，导致过滤条件失效。

修改Period提取逻辑：

string contextPeriod = string.Empty;
var periodElement = context.Element(xbrli + "period");
if (periodElement != null)
{
    var startDate = periodElement.Element(xbrli + "startDate")?.Value;
    var endDate = periodElement.Element(xbrli + "endDate")?.Value;
    var instantDate = periodElement.Element(xbrli + "instant")?.Value;
    
    // 处理期间型Period
    if (!string.IsNullOrEmpty(startDate) && !string.IsNullOrEmpty(endDate))
    {
        contextPeriod = $"{startDate}/{endDate}";
    }
    // 处理时点型Period
    else if (!string.IsNullOrEmpty(instantDate))
    {
        contextPeriod = instantDate;
    }
}
return contextPeriod == period;

3. 验证XBRL实例的解码正确性 #

Postman中传入的XBRLInstance是Base64编码字符串，虽然.NET默认会自动将Json中的Base64字符串反序列化为byte[]，但仍需验证：

• 在Post方法中添加日志，输出xbrlInstance的内容，确认是否是有效的XBRL XML文本，没有乱码或截断。
• 如果XBRL文件本身不是UTF-8编码（比如GB2312），使用Encoding.UTF8.GetString会导致XML解析错误，此时需要确认文件编码并对应调整解码方式。

4. 处理空引用异常与调试日志 #

在过滤逻辑中，直接访问context.Element(xbrli + "period").Value或context.Attribute("id").Value可能出现空引用，建议添加空值检查，并通过日志输出关键信息：

• 日志输出传入的period参数值，确认是否和Postman传入的一致。
• 日志输出xbrlData.Descendants(xbrli + "context")的数量，确认是否找到Context元素。
• 日志输出每个Context的Period值，对比是否和传入参数匹配。

修改后的GetContextsByPeriod方法示例：

private List<string> GetContextsByPeriod(XDocument xbrlData, string period)
{
    XNamespace xbrli = "http://www.xbrl.org/2003/instance";
    var filteredContexts = new List<string>();

    var allContexts = xbrlData.Descendants(xbrli + "context");
    // 日志输出找到的Context总数
    Console.WriteLine($"找到{allContexts.Count()}个Context元素");

    foreach (var context in allContexts)
    {
        var contextId = context.Attribute("id")?.Value;
        if (string.IsNullOrEmpty(contextId)) continue;

        var periodElement = context.Element(xbrli + "period");
        if (periodElement == null) continue;

        string contextPeriod = string.Empty;
        var startDate = periodElement.Element(xbrli + "startDate")?.Value;
        var endDate = periodElement.Element(xbrli + "endDate")?.Value;
        var instantDate = periodElement.Element(xbrli + "instant")?.Value;

        if (!string.IsNullOrEmpty(startDate) && !string.IsNullOrEmpty(endDate))
        {
            contextPeriod = $"{startDate}/{endDate}";
        }
        else if (!string.IsNullOrEmpty(instantDate))
        {
            contextPeriod = instantDate;
        }

        // 日志输出每个Context的ID和Period
        Console.WriteLine($"Context ID: {contextId}, Period: {contextPeriod}");

        if (contextPeriod == period)
        {
            filteredContexts.Add(contextId);
        }
    }

    return filteredContexts;
}

5. 验证Postman请求格式 #

确认Postman请求的Content-Type设置为application/json，且XBRLInstance的Base64字符串完整，没有换行或截断。可以将Base64字符串解码后，直接用XML工具打开，确认其中包含预期的<context>和对应的Period信息。

内容的提问来源于stack exchange，提问作者Lud