Authenticate
| API | Description |
|---|---|
| POST api/Authenticate |
Authenticates user and returns token with expiry. |
Files
Query the files you have submitted to GME
| API | Description |
|---|---|
| GET api/v1/Files |
Returns all files for your agency |
| GET api/v1/Files/GetByFilename/{filename} |
Get list of files by using the filename |
| GET api/v1/Files/GetByFileId/{fileId} |
Get files by using the GME file id |
Records
Query the records you have submitted to GME
| API | Description |
|---|---|
| GET api/v1/Records/GetById118/{id118} |
Return a record by 118 ID (only protected records are returned) |
| GET api/v1/Records/GetByFileId/{fileId} |
Get list of records by using the file ID |
| GET api/v1/Records/GetByFilename/{filename} |
Get list of records by using the filename |
| GET api/v1/Records/GetById/{id} |
Get record by using the GME record id |
| GET api/v1/Records/GetByUrn/{urn} |
Get list of records by using the agency URN - including the full history. |
| GET api/v1/Records/GetLatestByUrn/{urn} |
Get the most recent record by using the agency URN |
| POST api/v1/Records/Submit |
No documentation available. |
Failures
Get a list of records that failed validation and must be resubmitted
| API | Description |
|---|---|
| GET api/v1/Failures/GetByFileId/{fileId} |
Get a list of records that failed validation and must be resubmitted. |
Lookup
List of lookups for the GME system
| API | Description |
|---|---|
| GET api/v1/Lookups/GetErrorCodes |
Returns a list of possible error codes |
| GET api/v1/Lookups/GetSectorCodes |
No documentation available. |