GET api/documentkeys/{documentId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
documentId

integer

Required

Body Parameters

None.

Response Information

Resource Description

FileValidationModel
NameDescriptionTypeAdditional information
Parameters

Collection of FileModelKey

None.

Ratings

Collection of FileModelRating

None.

AlertaCociente

decimal number

None.

Response Formats

application/json, text/json

Sample:
{
  "Parameters": [
    {
      "Name": "sample string 1",
      "Type": "sample string 2",
      "Data": [
        {
          "Tax": "sample string 1",
          "Value": "sample string 2",
          "RegEx": "sample string 3"
        },
        {
          "Tax": "sample string 1",
          "Value": "sample string 2",
          "RegEx": "sample string 3"
        }
      ]
    },
    {
      "Name": "sample string 1",
      "Type": "sample string 2",
      "Data": [
        {
          "Tax": "sample string 1",
          "Value": "sample string 2",
          "RegEx": "sample string 3"
        },
        {
          "Tax": "sample string 1",
          "Value": "sample string 2",
          "RegEx": "sample string 3"
        }
      ]
    }
  ],
  "Ratings": [
    {
      "Character": "sample string 1",
      "Color": "sample string 2",
      "Percentage": 3
    },
    {
      "Character": "sample string 1",
      "Color": "sample string 2",
      "Percentage": 3
    }
  ],
  "AlertaCociente": 1.1
}

application/xml, text/xml

Sample:
<FileValidationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlDocumentario.Services.Models">
  <AlertaCociente>1.1</AlertaCociente>
  <Parameters>
    <FileModelKey>
      <Data>
        <TaxParameters>
          <RegEx>sample string 3</RegEx>
          <Tax>sample string 1</Tax>
          <Value>sample string 2</Value>
        </TaxParameters>
        <TaxParameters>
          <RegEx>sample string 3</RegEx>
          <Tax>sample string 1</Tax>
          <Value>sample string 2</Value>
        </TaxParameters>
      </Data>
      <Name>sample string 1</Name>
      <Type>sample string 2</Type>
    </FileModelKey>
    <FileModelKey>
      <Data>
        <TaxParameters>
          <RegEx>sample string 3</RegEx>
          <Tax>sample string 1</Tax>
          <Value>sample string 2</Value>
        </TaxParameters>
        <TaxParameters>
          <RegEx>sample string 3</RegEx>
          <Tax>sample string 1</Tax>
          <Value>sample string 2</Value>
        </TaxParameters>
      </Data>
      <Name>sample string 1</Name>
      <Type>sample string 2</Type>
    </FileModelKey>
  </Parameters>
  <Ratings>
    <FileModelRating>
      <Character>sample string 1</Character>
      <Color>sample string 2</Color>
      <Percentage>3</Percentage>
    </FileModelRating>
    <FileModelRating>
      <Character>sample string 1</Character>
      <Color>sample string 2</Color>
      <Percentage>3</Percentage>
    </FileModelRating>
  </Ratings>
</FileValidationModel>