TrcAPI (Quality)
Click here for a complete list of operations.
CalculateQuality
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /TrcAPI.asmx HTTP/1.1
Host: kaisv.kommersservices.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.reusecompany.com/requirements-authoring-tool/CalculateQuality"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CalculateQuality xmlns="http://www.reusecompany.com/requirements-authoring-tool/">
<sessionId>string</sessionId>
<headerText>string</headerText>
<descriptionText>string</descriptionText>
</CalculateQuality>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CalculateQualityResponse xmlns="http://www.reusecompany.com/requirements-authoring-tool/">
<CalculateQualityResult>
<GlobalQualityId>int</GlobalQualityId>
<AbsoluteQualityValue>double</AbsoluteQualityValue>
<FeaturesByMetric>
<AuthoringMetric>
<FeaturesAsDict xsi:nil="true" />
<RationaleAsDic xsi:nil="true" />
<FeaturesAsDoubleDict xsi:nil="true" />
<Substitutions xsi:nil="true" />
<Quality>string</Quality>
<QualityLevel>int</QualityLevel>
<MetricPerTypeId>int</MetricPerTypeId>
<MetricName>string</MetricName>
<AbsoluteValue>double</AbsoluteValue>
<MetricRtf>string</MetricRtf>
<Summary>string</Summary>
<Description>string</Description>
<UseMetric>boolean</UseMetric>
<AffectsOverallQuality>boolean</AffectsOverallQuality>
<Weight>int</Weight>
<CanSuggestDomainAbbreviation>boolean</CanSuggestDomainAbbreviation>
<CanSuggestDomainAcronyms>boolean</CanSuggestDomainAcronyms>
<CanSuggestDomainNouns>boolean</CanSuggestDomainNouns>
<CanSuggestDomainVerbs>boolean</CanSuggestDomainVerbs>
<CanSuggestTermDeletion>boolean</CanSuggestTermDeletion>
<CanSuggestTermRenaming>boolean</CanSuggestTermRenaming>
<CanSuggestTermSubstitutions>boolean</CanSuggestTermSubstitutions>
<IsMisspelling>boolean</IsMisspelling>
<FeaturesAsString>string</FeaturesAsString>
<FeatureType>int</FeatureType>
<MetricRanges xsi:nil="true" />
<MatchedRange>int</MatchedRange>
</AuthoringMetric>
<AuthoringMetric>
<FeaturesAsDict xsi:nil="true" />
<RationaleAsDic xsi:nil="true" />
<FeaturesAsDoubleDict xsi:nil="true" />
<Substitutions xsi:nil="true" />
<Quality>string</Quality>
<QualityLevel>int</QualityLevel>
<MetricPerTypeId>int</MetricPerTypeId>
<MetricName>string</MetricName>
<AbsoluteValue>double</AbsoluteValue>
<MetricRtf>string</MetricRtf>
<Summary>string</Summary>
<Description>string</Description>
<UseMetric>boolean</UseMetric>
<AffectsOverallQuality>boolean</AffectsOverallQuality>
<Weight>int</Weight>
<CanSuggestDomainAbbreviation>boolean</CanSuggestDomainAbbreviation>
<CanSuggestDomainAcronyms>boolean</CanSuggestDomainAcronyms>
<CanSuggestDomainNouns>boolean</CanSuggestDomainNouns>
<CanSuggestDomainVerbs>boolean</CanSuggestDomainVerbs>
<CanSuggestTermDeletion>boolean</CanSuggestTermDeletion>
<CanSuggestTermRenaming>boolean</CanSuggestTermRenaming>
<CanSuggestTermSubstitutions>boolean</CanSuggestTermSubstitutions>
<IsMisspelling>boolean</IsMisspelling>
<FeaturesAsString>string</FeaturesAsString>
<FeatureType>int</FeatureType>
<MetricRanges xsi:nil="true" />
<MatchedRange>int</MatchedRange>
</AuthoringMetric>
</FeaturesByMetric>
</CalculateQualityResult>
</CalculateQualityResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /TrcAPI.asmx HTTP/1.1
Host: kaisv.kommersservices.se
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CalculateQuality xmlns="http://www.reusecompany.com/requirements-authoring-tool/">
<sessionId>string</sessionId>
<headerText>string</headerText>
<descriptionText>string</descriptionText>
</CalculateQuality>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CalculateQualityResponse xmlns="http://www.reusecompany.com/requirements-authoring-tool/">
<CalculateQualityResult>
<GlobalQualityId>int</GlobalQualityId>
<AbsoluteQualityValue>double</AbsoluteQualityValue>
<FeaturesByMetric>
<AuthoringMetric>
<FeaturesAsDict xsi:nil="true" />
<RationaleAsDic xsi:nil="true" />
<FeaturesAsDoubleDict xsi:nil="true" />
<Substitutions xsi:nil="true" />
<Quality>string</Quality>
<QualityLevel>int</QualityLevel>
<MetricPerTypeId>int</MetricPerTypeId>
<MetricName>string</MetricName>
<AbsoluteValue>double</AbsoluteValue>
<MetricRtf>string</MetricRtf>
<Summary>string</Summary>
<Description>string</Description>
<UseMetric>boolean</UseMetric>
<AffectsOverallQuality>boolean</AffectsOverallQuality>
<Weight>int</Weight>
<CanSuggestDomainAbbreviation>boolean</CanSuggestDomainAbbreviation>
<CanSuggestDomainAcronyms>boolean</CanSuggestDomainAcronyms>
<CanSuggestDomainNouns>boolean</CanSuggestDomainNouns>
<CanSuggestDomainVerbs>boolean</CanSuggestDomainVerbs>
<CanSuggestTermDeletion>boolean</CanSuggestTermDeletion>
<CanSuggestTermRenaming>boolean</CanSuggestTermRenaming>
<CanSuggestTermSubstitutions>boolean</CanSuggestTermSubstitutions>
<IsMisspelling>boolean</IsMisspelling>
<FeaturesAsString>string</FeaturesAsString>
<FeatureType>int</FeatureType>
<MetricRanges xsi:nil="true" />
<MatchedRange>int</MatchedRange>
</AuthoringMetric>
<AuthoringMetric>
<FeaturesAsDict xsi:nil="true" />
<RationaleAsDic xsi:nil="true" />
<FeaturesAsDoubleDict xsi:nil="true" />
<Substitutions xsi:nil="true" />
<Quality>string</Quality>
<QualityLevel>int</QualityLevel>
<MetricPerTypeId>int</MetricPerTypeId>
<MetricName>string</MetricName>
<AbsoluteValue>double</AbsoluteValue>
<MetricRtf>string</MetricRtf>
<Summary>string</Summary>
<Description>string</Description>
<UseMetric>boolean</UseMetric>
<AffectsOverallQuality>boolean</AffectsOverallQuality>
<Weight>int</Weight>
<CanSuggestDomainAbbreviation>boolean</CanSuggestDomainAbbreviation>
<CanSuggestDomainAcronyms>boolean</CanSuggestDomainAcronyms>
<CanSuggestDomainNouns>boolean</CanSuggestDomainNouns>
<CanSuggestDomainVerbs>boolean</CanSuggestDomainVerbs>
<CanSuggestTermDeletion>boolean</CanSuggestTermDeletion>
<CanSuggestTermRenaming>boolean</CanSuggestTermRenaming>
<CanSuggestTermSubstitutions>boolean</CanSuggestTermSubstitutions>
<IsMisspelling>boolean</IsMisspelling>
<FeaturesAsString>string</FeaturesAsString>
<FeatureType>int</FeatureType>
<MetricRanges xsi:nil="true" />
<MatchedRange>int</MatchedRange>
</AuthoringMetric>
</FeaturesByMetric>
</CalculateQualityResult>
</CalculateQualityResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /TrcAPI.asmx/CalculateQuality?sessionId=string&headerText=string&descriptionText=string HTTP/1.1 Host: kaisv.kommersservices.se
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<RatQualityTextOutput xmlns="http://www.reusecompany.com/requirements-authoring-tool/">
<GlobalQualityId>int</GlobalQualityId>
<AbsoluteQualityValue>double</AbsoluteQualityValue>
<FeaturesByMetric>
<AuthoringMetric>
<FeaturesAsDict>
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</FeaturesAsDict>
<RationaleAsDic>
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</RationaleAsDic>
<FeaturesAsDoubleDict>
<SerializableFeatures d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<SerializableFeatures d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</FeaturesAsDoubleDict>
<Substitutions>
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Substitutions>
<Quality>string</Quality>
<QualityLevel>int</QualityLevel>
<MetricPerTypeId>int</MetricPerTypeId>
<MetricName>string</MetricName>
<AbsoluteValue>double</AbsoluteValue>
<MetricRtf>string</MetricRtf>
<Summary>string</Summary>
<Description>string</Description>
<UseMetric>boolean</UseMetric>
<AffectsOverallQuality>boolean</AffectsOverallQuality>
<Weight>int</Weight>
<CanSuggestDomainAbbreviation>boolean</CanSuggestDomainAbbreviation>
<CanSuggestDomainAcronyms>boolean</CanSuggestDomainAcronyms>
<CanSuggestDomainNouns>boolean</CanSuggestDomainNouns>
<CanSuggestDomainVerbs>boolean</CanSuggestDomainVerbs>
<CanSuggestTermDeletion>boolean</CanSuggestTermDeletion>
<CanSuggestTermRenaming>boolean</CanSuggestTermRenaming>
<CanSuggestTermSubstitutions>boolean</CanSuggestTermSubstitutions>
<IsMisspelling>boolean</IsMisspelling>
<FeaturesAsString>string</FeaturesAsString>
<FeatureType>int</FeatureType>
<MetricRanges>
<AuthoringRange d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<AuthoringRange d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</MetricRanges>
<MatchedRange>int</MatchedRange>
</AuthoringMetric>
<AuthoringMetric>
<FeaturesAsDict>
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</FeaturesAsDict>
<RationaleAsDic>
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</RationaleAsDic>
<FeaturesAsDoubleDict>
<SerializableFeatures d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<SerializableFeatures d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</FeaturesAsDoubleDict>
<Substitutions>
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Substitutions>
<Quality>string</Quality>
<QualityLevel>int</QualityLevel>
<MetricPerTypeId>int</MetricPerTypeId>
<MetricName>string</MetricName>
<AbsoluteValue>double</AbsoluteValue>
<MetricRtf>string</MetricRtf>
<Summary>string</Summary>
<Description>string</Description>
<UseMetric>boolean</UseMetric>
<AffectsOverallQuality>boolean</AffectsOverallQuality>
<Weight>int</Weight>
<CanSuggestDomainAbbreviation>boolean</CanSuggestDomainAbbreviation>
<CanSuggestDomainAcronyms>boolean</CanSuggestDomainAcronyms>
<CanSuggestDomainNouns>boolean</CanSuggestDomainNouns>
<CanSuggestDomainVerbs>boolean</CanSuggestDomainVerbs>
<CanSuggestTermDeletion>boolean</CanSuggestTermDeletion>
<CanSuggestTermRenaming>boolean</CanSuggestTermRenaming>
<CanSuggestTermSubstitutions>boolean</CanSuggestTermSubstitutions>
<IsMisspelling>boolean</IsMisspelling>
<FeaturesAsString>string</FeaturesAsString>
<FeatureType>int</FeatureType>
<MetricRanges>
<AuthoringRange d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<AuthoringRange d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</MetricRanges>
<MatchedRange>int</MatchedRange>
</AuthoringMetric>
</FeaturesByMetric>
</RatQualityTextOutput>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /TrcAPI.asmx/CalculateQuality HTTP/1.1 Host: kaisv.kommersservices.se Content-Type: application/x-www-form-urlencoded Content-Length: length sessionId=string&headerText=string&descriptionText=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<RatQualityTextOutput xmlns="http://www.reusecompany.com/requirements-authoring-tool/">
<GlobalQualityId>int</GlobalQualityId>
<AbsoluteQualityValue>double</AbsoluteQualityValue>
<FeaturesByMetric>
<AuthoringMetric>
<FeaturesAsDict>
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</FeaturesAsDict>
<RationaleAsDic>
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</RationaleAsDic>
<FeaturesAsDoubleDict>
<SerializableFeatures d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<SerializableFeatures d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</FeaturesAsDoubleDict>
<Substitutions>
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Substitutions>
<Quality>string</Quality>
<QualityLevel>int</QualityLevel>
<MetricPerTypeId>int</MetricPerTypeId>
<MetricName>string</MetricName>
<AbsoluteValue>double</AbsoluteValue>
<MetricRtf>string</MetricRtf>
<Summary>string</Summary>
<Description>string</Description>
<UseMetric>boolean</UseMetric>
<AffectsOverallQuality>boolean</AffectsOverallQuality>
<Weight>int</Weight>
<CanSuggestDomainAbbreviation>boolean</CanSuggestDomainAbbreviation>
<CanSuggestDomainAcronyms>boolean</CanSuggestDomainAcronyms>
<CanSuggestDomainNouns>boolean</CanSuggestDomainNouns>
<CanSuggestDomainVerbs>boolean</CanSuggestDomainVerbs>
<CanSuggestTermDeletion>boolean</CanSuggestTermDeletion>
<CanSuggestTermRenaming>boolean</CanSuggestTermRenaming>
<CanSuggestTermSubstitutions>boolean</CanSuggestTermSubstitutions>
<IsMisspelling>boolean</IsMisspelling>
<FeaturesAsString>string</FeaturesAsString>
<FeatureType>int</FeatureType>
<MetricRanges>
<AuthoringRange d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<AuthoringRange d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</MetricRanges>
<MatchedRange>int</MatchedRange>
</AuthoringMetric>
<AuthoringMetric>
<FeaturesAsDict>
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</FeaturesAsDict>
<RationaleAsDic>
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</RationaleAsDic>
<FeaturesAsDoubleDict>
<SerializableFeatures d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<SerializableFeatures d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</FeaturesAsDoubleDict>
<Substitutions>
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<SerializableFeature d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Substitutions>
<Quality>string</Quality>
<QualityLevel>int</QualityLevel>
<MetricPerTypeId>int</MetricPerTypeId>
<MetricName>string</MetricName>
<AbsoluteValue>double</AbsoluteValue>
<MetricRtf>string</MetricRtf>
<Summary>string</Summary>
<Description>string</Description>
<UseMetric>boolean</UseMetric>
<AffectsOverallQuality>boolean</AffectsOverallQuality>
<Weight>int</Weight>
<CanSuggestDomainAbbreviation>boolean</CanSuggestDomainAbbreviation>
<CanSuggestDomainAcronyms>boolean</CanSuggestDomainAcronyms>
<CanSuggestDomainNouns>boolean</CanSuggestDomainNouns>
<CanSuggestDomainVerbs>boolean</CanSuggestDomainVerbs>
<CanSuggestTermDeletion>boolean</CanSuggestTermDeletion>
<CanSuggestTermRenaming>boolean</CanSuggestTermRenaming>
<CanSuggestTermSubstitutions>boolean</CanSuggestTermSubstitutions>
<IsMisspelling>boolean</IsMisspelling>
<FeaturesAsString>string</FeaturesAsString>
<FeatureType>int</FeatureType>
<MetricRanges>
<AuthoringRange d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<AuthoringRange d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</MetricRanges>
<MatchedRange>int</MatchedRange>
</AuthoringMetric>
</FeaturesByMetric>
</RatQualityTextOutput>