GET api/v1/Failures/GetByFileId/{fileId}

Get a list of records that failed validation and must be resubmitted.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
fileId

ID of the incoming file

 integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of gme_error
NameDescriptionTypeAdditional information
Id

Our internal error ID

 integer

None.
ErrorCode

The lookup code for the error message

 integer

None.
ErrorDesc

Description of the error

 string

None.
Urn

The URN you submitted for this record

 string

None.
BusinessName

The business name that you submitted

 string

None.
Add1

The add1 that you submitted

 string

None.
Add2

The add2 that you submitted

 string

None.
Locality

The locality that you submitted

 string

None.
Town

The town that you submitted

 string

None.
County

The county that you submitted

 string

None.
Postcode

The postcode that you submitted

 string

None.
Telno

The telno that you submitted

 string

None.
OverlayNumber

The overlay number that you submitted

 string

None.
Url

The URL that you submitted

 string

None.
SectorID

The sector id that you submitted

 string

None.
SectorDesc

The sector desc that you submitted

 string

None.
Employees

The employees that you submitted

 string

None.
LocationType

The location type that you submitted

 string

None.
Action

The Action that you submitted

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": 1,
    "ErrorCode": 4,
    "ErrorDesc": "sample string 5",
    "Urn": "sample string 6",
    "BusinessName": "sample string 7",
    "Add1": "sample string 8",
    "Add2": "sample string 9",
    "Locality": "sample string 10",
    "Town": "sample string 11",
    "County": "sample string 12",
    "Postcode": "sample string 13",
    "Telno": "sample string 14",
    "OverlayNumber": "sample string 15",
    "Url": "sample string 16",
    "SectorID": "sample string 17",
    "SectorDesc": "sample string 18",
    "Employees": "sample string 19",
    "LocationType": "sample string 20",
    "Action": "sample string 21"
  },
  {
    "Id": 1,
    "ErrorCode": 4,
    "ErrorDesc": "sample string 5",
    "Urn": "sample string 6",
    "BusinessName": "sample string 7",
    "Add1": "sample string 8",
    "Add2": "sample string 9",
    "Locality": "sample string 10",
    "Town": "sample string 11",
    "County": "sample string 12",
    "Postcode": "sample string 13",
    "Telno": "sample string 14",
    "OverlayNumber": "sample string 15",
    "Url": "sample string 16",
    "SectorID": "sample string 17",
    "SectorDesc": "sample string 18",
    "Employees": "sample string 19",
    "LocationType": "sample string 20",
    "Action": "sample string 21"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfErrors xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GmeWebApi.Models.Api">
  <Errors>
    <Action>sample string 21</Action>
    <Add1>sample string 8</Add1>
    <Add2>sample string 9</Add2>
    <BusinessName>sample string 7</BusinessName>
    <County>sample string 12</County>
    <Employees>sample string 19</Employees>
    <ErrorCode>4</ErrorCode>
    <ErrorDesc>sample string 5</ErrorDesc>
    <Id>1</Id>
    <Locality>sample string 10</Locality>
    <LocationType>sample string 20</LocationType>
    <OverlayNumber>sample string 15</OverlayNumber>
    <Postcode>sample string 13</Postcode>
    <SectorDesc>sample string 18</SectorDesc>
    <SectorID>sample string 17</SectorID>
    <Telno>sample string 14</Telno>
    <Town>sample string 11</Town>
    <Url>sample string 16</Url>
    <Urn>sample string 6</Urn>
  </Errors>
  <Errors>
    <Action>sample string 21</Action>
    <Add1>sample string 8</Add1>
    <Add2>sample string 9</Add2>
    <BusinessName>sample string 7</BusinessName>
    <County>sample string 12</County>
    <Employees>sample string 19</Employees>
    <ErrorCode>4</ErrorCode>
    <ErrorDesc>sample string 5</ErrorDesc>
    <Id>1</Id>
    <Locality>sample string 10</Locality>
    <LocationType>sample string 20</LocationType>
    <OverlayNumber>sample string 15</OverlayNumber>
    <Postcode>sample string 13</Postcode>
    <SectorDesc>sample string 18</SectorDesc>
    <SectorID>sample string 17</SectorID>
    <Telno>sample string 14</Telno>
    <Town>sample string 11</Town>
    <Url>sample string 16</Url>
    <Urn>sample string 6</Urn>
  </Errors>
</ArrayOfErrors>