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

Get list of records by using the file ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
fileId

ID of the incoming file

 integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of gme_record
NameDescriptionTypeAdditional information
Id

Our internal GME Id for the record

 integer

None.
Urn

Your URN for this record

 string

None.
FileId

Our internal file ID for the incoming file

 integer

None.
Filename

The filename that this record was submitted with

 string

None.
ProcessedDate

The date this record was last processed

 date

None.
BusinessName

Business name on the record

 string

None.
Add1

Address details for the record

 string

None.
Add2

Address details for the record

 string

None.
Locality

Address details for the record

 string

None.
Town

Address details for the record

 string

None.
County

Address details for the record

 string

None.
Postcode

Postcode for the record

 string

None.
Telno

Telephone number for the record

 string

None.
Url

Website for the record

 string

None.
Employees

Number of Employess

 integer

None.
SectorId

Sector Lookup code

 integer

None.
SectorDesc

Description of the sector

 string

None.
Protected

Is the record protected (1 or 0)

 integer

None.
Status

Current status of record (No Result, Processing, Protected or Deleted)

 string

None.
StatusDesc

More detailed description of the GME status

 string

None.
CallStatus

This is the last call status once records has reached maximum attempts

 string

None.
Id118

The id118 assigned to this record (protected only)

 integer

None.
Corrections

List of corrects made to this record

 Collection of record_correction

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": 1,
    "Urn": "sample string 2",
    "FileId": 3,
    "Filename": "sample string 4",
    "ProcessedDate": "2025-12-06T04:22:11.3905654+00:00",
    "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",
    "Url": "sample string 15",
    "Employees": 1,
    "SectorId": 1,
    "SectorDesc": "sample string 16",
    "Protected": 17,
    "Status": "sample string 18",
    "StatusDesc": "sample string 19",
    "CallStatus": "sample string 20",
    "Id118": 1,
    "Corrections": [
      {
        "Field": "sample string 3",
        "From": "sample string 4",
        "To": "sample string 5",
        "DateChanged": "2025-12-06T04:22:11.3905654+00:00"
      },
      {
        "Field": "sample string 3",
        "From": "sample string 4",
        "To": "sample string 5",
        "DateChanged": "2025-12-06T04:22:11.3905654+00:00"
      }
    ]
  },
  {
    "Id": 1,
    "Urn": "sample string 2",
    "FileId": 3,
    "Filename": "sample string 4",
    "ProcessedDate": "2025-12-06T04:22:11.3905654+00:00",
    "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",
    "Url": "sample string 15",
    "Employees": 1,
    "SectorId": 1,
    "SectorDesc": "sample string 16",
    "Protected": 17,
    "Status": "sample string 18",
    "StatusDesc": "sample string 19",
    "CallStatus": "sample string 20",
    "Id118": 1,
    "Corrections": [
      {
        "Field": "sample string 3",
        "From": "sample string 4",
        "To": "sample string 5",
        "DateChanged": "2025-12-06T04:22:11.3905654+00:00"
      },
      {
        "Field": "sample string 3",
        "From": "sample string 4",
        "To": "sample string 5",
        "DateChanged": "2025-12-06T04:22:11.3905654+00:00"
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GmeWebApi.Models.Api">
  <Record>
    <Add1>sample string 8</Add1>
    <Add2>sample string 9</Add2>
    <BusinessName>sample string 7</BusinessName>
    <CallStatus>sample string 20</CallStatus>
    <Corrections>
      <Correction>
        <DateChanged>2025-12-06T04:22:11.3905654+00:00</DateChanged>
        <Field>sample string 3</Field>
        <From>sample string 4</From>
        <To>sample string 5</To>
      </Correction>
      <Correction>
        <DateChanged>2025-12-06T04:22:11.3905654+00:00</DateChanged>
        <Field>sample string 3</Field>
        <From>sample string 4</From>
        <To>sample string 5</To>
      </Correction>
    </Corrections>
    <County>sample string 12</County>
    <Employees>1</Employees>
    <FileId>3</FileId>
    <Filename>sample string 4</Filename>
    <Id>1</Id>
    <Id118>1</Id118>
    <Locality>sample string 10</Locality>
    <Postcode>sample string 13</Postcode>
    <ProcessedDate>2025-12-06T04:22:11.3905654+00:00</ProcessedDate>
    <Protected>17</Protected>
    <SectorDesc>sample string 16</SectorDesc>
    <SectorId>1</SectorId>
    <Status>sample string 18</Status>
    <StatusDesc>sample string 19</StatusDesc>
    <Telno>sample string 14</Telno>
    <Town>sample string 11</Town>
    <Url>sample string 15</Url>
    <Urn>sample string 2</Urn>
  </Record>
  <Record>
    <Add1>sample string 8</Add1>
    <Add2>sample string 9</Add2>
    <BusinessName>sample string 7</BusinessName>
    <CallStatus>sample string 20</CallStatus>
    <Corrections>
      <Correction>
        <DateChanged>2025-12-06T04:22:11.3905654+00:00</DateChanged>
        <Field>sample string 3</Field>
        <From>sample string 4</From>
        <To>sample string 5</To>
      </Correction>
      <Correction>
        <DateChanged>2025-12-06T04:22:11.3905654+00:00</DateChanged>
        <Field>sample string 3</Field>
        <From>sample string 4</From>
        <To>sample string 5</To>
      </Correction>
    </Corrections>
    <County>sample string 12</County>
    <Employees>1</Employees>
    <FileId>3</FileId>
    <Filename>sample string 4</Filename>
    <Id>1</Id>
    <Id118>1</Id118>
    <Locality>sample string 10</Locality>
    <Postcode>sample string 13</Postcode>
    <ProcessedDate>2025-12-06T04:22:11.3905654+00:00</ProcessedDate>
    <Protected>17</Protected>
    <SectorDesc>sample string 16</SectorDesc>
    <SectorId>1</SectorId>
    <Status>sample string 18</Status>
    <StatusDesc>sample string 19</StatusDesc>
    <Telno>sample string 14</Telno>
    <Town>sample string 11</Town>
    <Url>sample string 15</Url>
    <Urn>sample string 2</Urn>
  </Record>
</ArrayOfRecord>