GET v1/Clients/{clientId}/Tanks?facilityId={facilityId}

Gets all active tanks for the client that match the query, if provided.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

Client identifier.

 globally unique identifier

Required
facilityId

integer

None.

Body Parameters

None.

Response Information

Resource Description

A .

Collection of TankV1
NameDescriptionTypeAdditional information
ClientId

The client id.

 globally unique identifier

None.
FacilityId

The facility id.

 integer

None.
Id

The tank id.

 integer

None.
TankNumber

The tank registration number.

 string

None.
AtgTankNumber

The tank number as reported by the ATG.

 string

None.
LocationType

The tank location type. Valid values include: "UST", "AST", "ASTUGP", "USTU", "ASTAGP". - UST = Underground Storage Tank - AST = Above Ground Storage Tank - ASTUGP = Above Ground Storage Tank with Underground Piping - USTU = Underground Storage Tank - Unregulated - ASTAGP = Above Ground Storage Tank with Above Ground Piping

 string

None.
TankStatusReferenceId

The tank status. Valid values include can be retrieved from v1/Clients/{clientId}/References?type=TankStatus.

 integer

None.
TankStatusReferenceDescription

The tank status description.

 string

None.
SubstanceProductReferenceId

The substance/product the tank holds. Valid values include can be retrieved from v1/Clients/{clientId}/References?type=SubstanceProduct.

 integer

None.
SubstanceProductReferenceDescription

The substance/product the tank holds.

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "ClientId": "36962395-a6dc-4c22-bb0e-d9ceffd0e484",
    "FacilityId": 124869922,
    "Id": 124869922,
    "TankNumber": "1",
    "AtgTankNumber": "1",
    "LocationType": "UST",
    "TankStatusReferenceId": 124869922,
    "TankStatusReferenceDescription": null,
    "SubstanceProductReferenceId": 124869922,
    "SubstanceProductReferenceDescription": null
  },
  {
    "ClientId": "db484e3a-a724-4fcd-80f9-cbd4a3f46a9b",
    "FacilityId": 124869922,
    "Id": 124869922,
    "TankNumber": "2",
    "AtgTankNumber": "2",
    "LocationType": "UST",
    "TankStatusReferenceId": 124869922,
    "TankStatusReferenceDescription": null,
    "SubstanceProductReferenceId": 124869922,
    "SubstanceProductReferenceDescription": null
  }
]

application/xml, text/xml

Sample: 
<ArrayOfTank xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Titan.API.Fuel.Models">
  <Tank>
    <AtgTankNumber>1</AtgTankNumber>
    <ClientId>36962395-a6dc-4c22-bb0e-d9ceffd0e484</ClientId>
    <FacilityId>124869922</FacilityId>
    <Id>124869922</Id>
    <LocationType>UST</LocationType>
    <SubstanceProductReferenceDescription i:nil="true" />
    <SubstanceProductReferenceId>124869922</SubstanceProductReferenceId>
    <TankNumber>1</TankNumber>
    <TankStatusReferenceDescription i:nil="true" />
    <TankStatusReferenceId>124869922</TankStatusReferenceId>
  </Tank>
  <Tank>
    <AtgTankNumber>2</AtgTankNumber>
    <ClientId>db484e3a-a724-4fcd-80f9-cbd4a3f46a9b</ClientId>
    <FacilityId>124869922</FacilityId>
    <Id>124869922</Id>
    <LocationType>UST</LocationType>
    <SubstanceProductReferenceDescription i:nil="true" />
    <SubstanceProductReferenceId>124869922</SubstanceProductReferenceId>
    <TankNumber>2</TankNumber>
    <TankStatusReferenceDescription i:nil="true" />
    <TankStatusReferenceId>124869922</TankStatusReferenceId>
  </Tank>
</ArrayOfTank>