/
Reporting

Reporting

Owned by Torsten Machert
Nov. 17, 2020

POST

/congree/api/Reporting/v1/Linguistic

Stores the Language Check Report.

The report should be included in the body in following form: 

DocumentId - is guid which uniquely identifies the document.

Request body
{
  "DocumentRuleSet": "string",
  "DocumentId": "00000000-0000-0000-0000-000000000000",
  "TotalCheckedWords": 0,
  "ReleaseLevel": 0,
  "RelativeReleaseLevel": 0,
  "ErrorData": [
    {
      "ErrorType": "Abbreviation",
      "ErrorCount": 0,
      "ErrorSeverity": 0
    }
  ]
}

You can build report based on the response of linguistic check with parameter "IncludeReporting": true. 

Request body example 
{
  "documentRuleSet" : "Congree Standard",
  "documentId": "33BB8BDB-3E9F-4944-9E23-2FFA56C143EE",
  "TotalCheckedWords": 498,
  "ReleaseLevel": 3.82,
  "RelativeReleaseLevel": 1.7976470588235292,
    "ErrorData": [
      {
        "ErrorType": "Abbreviation",
        "ErrorCount": 0,
        "ErrorSeverity": 100.0
      },
      {
        "ErrorType": "Grammar",
        "ErrorCount": 4,
        "ErrorSeverity": 97.59
      },
      {
        "ErrorType": "Spelling",
        "ErrorCount": 2,
        "ErrorSeverity": 59.84
      },
      {
        "ErrorType": "Style",
        "ErrorCount": 7,
        "ErrorSeverity": 98.59
      },
      {
        "ErrorType": "Terminology",
        "ErrorCount": 9,
        "ErrorSeverity": 47.79
      }
    ]
}

Related content