GET api/ufc/v{version}/LegacyFaults/Description?faultId={faultId}&softwareId={softwareId}&language={language}&country={country}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
faultId

integer

Required

softwareId

string

Required

language

string

Required

country

string

Required

version

string

None.

Body Parameters

None.

Response Information

Resource Description

FaultResponse
NameDescriptionTypeAdditional information
FaultTypeId

integer

None.

FailureTypeId

integer

None.

ActionId

integer

None.

ShortDescriptionId

integer

None.

LongDescriptionId

integer

None.

FaultTypeDescription

string

None.

FailureTypeDescription

string

None.

ActionDescription

string

None.

ShortDescription

string

None.

LongDescription

string

None.

Response Formats

application/json, text/json

Sample:
{
  "FaultTypeId": 1,
  "FailureTypeId": 1,
  "ActionId": 1,
  "ShortDescriptionId": 1,
  "LongDescriptionId": 1,
  "FaultTypeDescription": "sample string 1",
  "FailureTypeDescription": "sample string 2",
  "ActionDescription": "sample string 3",
  "ShortDescription": "sample string 4",
  "LongDescription": "sample string 5"
}

application/xml, text/xml

Sample:
<FaultResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercury.Vvm.WebApi.Models">
  <ActionDescription>sample string 3</ActionDescription>
  <ActionId>1</ActionId>
  <FailureTypeDescription>sample string 2</FailureTypeDescription>
  <FailureTypeId>1</FailureTypeId>
  <FaultTypeDescription>sample string 1</FaultTypeDescription>
  <FaultTypeId>1</FaultTypeId>
  <LongDescription>sample string 5</LongDescription>
  <LongDescriptionId>1</LongDescriptionId>
  <ShortDescription>sample string 4</ShortDescription>
  <ShortDescriptionId>1</ShortDescriptionId>
</FaultResponse>