Ims Upload Manual Ep
POST/v1/tank_readings/upload
IMS Upload Endpoint
Manages the upload of inventory management system (IMS) readings for tanks at specific stores, detailing both the request parameters for submitting readings and the expected response structure. The request includes information on the store, tank identifier, reading timestamp, and measured values. The response indicates the success or failure of each reading's upload, including counts of successful uploads and details on any errors encountered.
Request
store: str
Name of the store the reading is for.
tank: str | int
Tank identifier of the tank the reading is for.
timezone: Optional[TimezoneEnum] = None
Timezone of the store.
date: datetime
Timestamp of the reading, converted to UTC.
inches: Optional[int] = None
Inches measured in the reading.
volume: Optional[float] = None
Volume measured in the reading.
Response Structure
status: bool
Boolean that indicates if errors are present (false if no errors, true if errors occurred).
message: str
Number of uploaded readings, indicating how many readings were successfully uploaded.
ids: list[str]
List of the identifiers for the readings that were successfully uploaded.
unable to upload: list[str]
List of the identifiers for the readings that encountered errors during the upload process.
Responses
- 200
- 422
Successful Response
Validation Error
- application/json
- Example (from schema)
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}