GET v1/Clients/{clientId}/SirResults?facilityId={facilityId}&tankId={tankId}&year={year}&month={month}
Gets all SIR Results for the client that match the query, if provided. Will not include file bytes. If you need file bytes, use v1/Clients/{clientId}/SirResults/Files
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientId |
Client identifier. |
globally unique identifier |
Required |
facilityId | integer |
None. |
|
tankId | integer |
None. |
|
year | integer |
None. |
|
month | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
A .
Collection of SirResultV1Name | Description | Type | Additional information |
---|---|---|---|
FacilityId |
The facility id. |
integer |
None. |
Year |
The year of the result. |
integer |
None. |
Month |
The month of the result. |
integer |
None. |
TankResults |
The results for each tank. |
Collection of SirTankResultV1 |
None. |
Files |
The files associated with the SIR Result. |
Collection of EFileV1 |
None. |
Response Formats
application/json, text/json
Sample:
[ { "FacilityId": 1, "Year": 2, "Month": 3, "TankResults": [ { "TankId": 1, "ResultCode": "sample string 2" }, { "TankId": 1, "ResultCode": "sample string 2" } ], "Files": [ { "FacilityId": 1, "EFileApplicationReferenceId": 2, "FileName": "sample string 3", "DateOfFile": "2025-05-13T09:08:21.1239328+00:00", "Bytes": "QEA=", "Description": "sample string 4", "Tags": [ "sample string 1", "sample string 2" ], "SkipDuplicateFileName": true }, { "FacilityId": 1, "EFileApplicationReferenceId": 2, "FileName": "sample string 3", "DateOfFile": "2025-05-13T09:08:21.1239328+00:00", "Bytes": "QEA=", "Description": "sample string 4", "Tags": [ "sample string 1", "sample string 2" ], "SkipDuplicateFileName": true } ] }, { "FacilityId": 1, "Year": 2, "Month": 3, "TankResults": [ { "TankId": 1, "ResultCode": "sample string 2" }, { "TankId": 1, "ResultCode": "sample string 2" } ], "Files": [ { "FacilityId": 1, "EFileApplicationReferenceId": 2, "FileName": "sample string 3", "DateOfFile": "2025-05-13T09:08:21.1239328+00:00", "Bytes": "QEA=", "Description": "sample string 4", "Tags": [ "sample string 1", "sample string 2" ], "SkipDuplicateFileName": true }, { "FacilityId": 1, "EFileApplicationReferenceId": 2, "FileName": "sample string 3", "DateOfFile": "2025-05-13T09:08:21.1239328+00:00", "Bytes": "QEA=", "Description": "sample string 4", "Tags": [ "sample string 1", "sample string 2" ], "SkipDuplicateFileName": true } ] } ]
application/xml, text/xml
Sample:
<ArrayOfSirResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Titan.API.Fuel.Models"> <SirResult> <FacilityId>1</FacilityId> <Files xmlns:d3p1="http://schemas.datacontract.org/2004/07/Titan.API.Core.Models"> <d3p1:EFile> <d3p1:Bytes>QEA=</d3p1:Bytes> <d3p1:DateOfFile>2025-05-13T09:08:21.1239328+00:00</d3p1:DateOfFile> <d3p1:Description>sample string 4</d3p1:Description> <d3p1:EFileApplicationReferenceId>2</d3p1:EFileApplicationReferenceId> <d3p1:FacilityId>1</d3p1:FacilityId> <d3p1:FileName>sample string 3</d3p1:FileName> <d3p1:SkipDuplicateFileName>true</d3p1:SkipDuplicateFileName> <d3p1:Tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </d3p1:Tags> </d3p1:EFile> <d3p1:EFile> <d3p1:Bytes>QEA=</d3p1:Bytes> <d3p1:DateOfFile>2025-05-13T09:08:21.1239328+00:00</d3p1:DateOfFile> <d3p1:Description>sample string 4</d3p1:Description> <d3p1:EFileApplicationReferenceId>2</d3p1:EFileApplicationReferenceId> <d3p1:FacilityId>1</d3p1:FacilityId> <d3p1:FileName>sample string 3</d3p1:FileName> <d3p1:SkipDuplicateFileName>true</d3p1:SkipDuplicateFileName> <d3p1:Tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </d3p1:Tags> </d3p1:EFile> </Files> <Month>3</Month> <TankResults> <SirTankResult> <ResultCode>sample string 2</ResultCode> <TankId>1</TankId> </SirTankResult> <SirTankResult> <ResultCode>sample string 2</ResultCode> <TankId>1</TankId> </SirTankResult> </TankResults> <Year>2</Year> </SirResult> <SirResult> <FacilityId>1</FacilityId> <Files xmlns:d3p1="http://schemas.datacontract.org/2004/07/Titan.API.Core.Models"> <d3p1:EFile> <d3p1:Bytes>QEA=</d3p1:Bytes> <d3p1:DateOfFile>2025-05-13T09:08:21.1239328+00:00</d3p1:DateOfFile> <d3p1:Description>sample string 4</d3p1:Description> <d3p1:EFileApplicationReferenceId>2</d3p1:EFileApplicationReferenceId> <d3p1:FacilityId>1</d3p1:FacilityId> <d3p1:FileName>sample string 3</d3p1:FileName> <d3p1:SkipDuplicateFileName>true</d3p1:SkipDuplicateFileName> <d3p1:Tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </d3p1:Tags> </d3p1:EFile> <d3p1:EFile> <d3p1:Bytes>QEA=</d3p1:Bytes> <d3p1:DateOfFile>2025-05-13T09:08:21.1239328+00:00</d3p1:DateOfFile> <d3p1:Description>sample string 4</d3p1:Description> <d3p1:EFileApplicationReferenceId>2</d3p1:EFileApplicationReferenceId> <d3p1:FacilityId>1</d3p1:FacilityId> <d3p1:FileName>sample string 3</d3p1:FileName> <d3p1:SkipDuplicateFileName>true</d3p1:SkipDuplicateFileName> <d3p1:Tags xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:string>sample string 1</d5p1:string> <d5p1:string>sample string 2</d5p1:string> </d3p1:Tags> </d3p1:EFile> </Files> <Month>3</Month> <TankResults> <SirTankResult> <ResultCode>sample string 2</ResultCode> <TankId>1</TankId> </SirTankResult> <SirTankResult> <ResultCode>sample string 2</ResultCode> <TankId>1</TankId> </SirTankResult> </TankResults> <Year>2</Year> </SirResult> </ArrayOfSirResult>