GET v2/Clients/{clientId}/CitldsResults?facilityId={facilityId}&tankId={tankId}&firstDateOfPeriod={firstDateOfPeriod}&lastDateOfPeriod={lastDateOfPeriod}
Gets all CITLDS Results for the client that match the query, if provided. Will not include file bytes. If you need file bytes, use v2/Clients/{clientId}/CitldsResults/Files
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientId |
Client identifier. |
globally unique identifier |
Required |
facilityId | integer |
None. |
|
tankId | integer |
None. |
|
firstDateOfPeriod | date |
None. |
|
lastDateOfPeriod | date |
None. |
Body Parameters
None.
Response Information
Resource Description
A .
Collection of CitldsResultV2Name | Description | Type | Additional information |
---|---|---|---|
FacilityId |
The facility id. |
integer |
None. |
FirstDateOfPeriod |
The FirstDateOfPeriod of the result. |
date |
None. |
LastDateOfPeriod |
The LastDateOfPeriod of the result. |
date |
None. |
Results |
The results for each tank. |
Collection of CitldsTankResultV2 |
None. |
Files |
The files associated with the SIR Result. |
Collection of EFileV1 |
None. |
Response Formats
application/json, text/json
Sample:
[ { "FacilityId": 1, "FirstDateOfPeriod": "2025-05-13T08:01:15.7677891+00:00", "LastDateOfPeriod": "2025-05-13T08:01:15.7677891+00:00", "Results": [ { "TankId": 1, "TankResultCode": "sample string 2", "LineResultCode": "sample string 3", "InventoryControlFail": true }, { "TankId": 1, "TankResultCode": "sample string 2", "LineResultCode": "sample string 3", "InventoryControlFail": true } ], "Files": [ { "FacilityId": 1, "EFileApplicationReferenceId": 2, "FileName": "sample string 3", "DateOfFile": "2025-05-13T08:01:15.7683038+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-13T08:01:15.7683038+00:00", "Bytes": "QEA=", "Description": "sample string 4", "Tags": [ "sample string 1", "sample string 2" ], "SkipDuplicateFileName": true } ] }, { "FacilityId": 1, "FirstDateOfPeriod": "2025-05-13T08:01:15.7677891+00:00", "LastDateOfPeriod": "2025-05-13T08:01:15.7677891+00:00", "Results": [ { "TankId": 1, "TankResultCode": "sample string 2", "LineResultCode": "sample string 3", "InventoryControlFail": true }, { "TankId": 1, "TankResultCode": "sample string 2", "LineResultCode": "sample string 3", "InventoryControlFail": true } ], "Files": [ { "FacilityId": 1, "EFileApplicationReferenceId": 2, "FileName": "sample string 3", "DateOfFile": "2025-05-13T08:01:15.7683038+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-13T08:01:15.7683038+00:00", "Bytes": "QEA=", "Description": "sample string 4", "Tags": [ "sample string 1", "sample string 2" ], "SkipDuplicateFileName": true } ] } ]
application/xml, text/xml
Sample:
<ArrayOfCitldsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Titan.API.Fuel.Models"> <CitldsResult> <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-13T08:01:15.7683038+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-13T08:01:15.7683038+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> <FirstDateOfPeriod>2025-05-13T08:01:15.7677891+00:00</FirstDateOfPeriod> <LastDateOfPeriod>2025-05-13T08:01:15.7677891+00:00</LastDateOfPeriod> <Results> <CITLDSTankResult> <InventoryControlFail>true</InventoryControlFail> <LineResultCode>sample string 3</LineResultCode> <TankId>1</TankId> <TankResultCode>sample string 2</TankResultCode> </CITLDSTankResult> <CITLDSTankResult> <InventoryControlFail>true</InventoryControlFail> <LineResultCode>sample string 3</LineResultCode> <TankId>1</TankId> <TankResultCode>sample string 2</TankResultCode> </CITLDSTankResult> </Results> </CitldsResult> <CitldsResult> <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-13T08:01:15.7683038+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-13T08:01:15.7683038+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> <FirstDateOfPeriod>2025-05-13T08:01:15.7677891+00:00</FirstDateOfPeriod> <LastDateOfPeriod>2025-05-13T08:01:15.7677891+00:00</LastDateOfPeriod> <Results> <CITLDSTankResult> <InventoryControlFail>true</InventoryControlFail> <LineResultCode>sample string 3</LineResultCode> <TankId>1</TankId> <TankResultCode>sample string 2</TankResultCode> </CITLDSTankResult> <CITLDSTankResult> <InventoryControlFail>true</InventoryControlFail> <LineResultCode>sample string 3</LineResultCode> <TankId>1</TankId> <TankResultCode>sample string 2</TankResultCode> </CITLDSTankResult> </Results> </CitldsResult> </ArrayOfCitldsResult>