POST v2/Clients/{clientId}/SirResults

Post a SIR Result.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Client identifier.	globally unique identifier	Required

Body Parameters

The SIR Result.

SirResultV2

Name	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.
TankResults	The results for each tank.	Collection of SirTankResultV2	None.
Files	The files associated with the SIR Result.	Collection of EFileV1	None.

Request Formats

application/json, text/json

Sample:

{
  "FacilityId": 1,
  "FirstDateOfPeriod": "2025-05-13T09:11:28.4382894+00:00",
  "LastDateOfPeriod": "2025-05-13T09:11:28.4382894+00:00",
  "TankResults": [
    {
      "TankId": 1,
      "ResultCode": "sample string 2",
      "InventoryControlFail": true
    },
    {
      "TankId": 1,
      "ResultCode": "sample string 2",
      "InventoryControlFail": true
    }
  ],
  "Files": [
    {
      "FacilityId": 1,
      "EFileApplicationReferenceId": 2,
      "FileName": "sample string 3",
      "DateOfFile": "2025-05-13T09:11:28.4388202+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:11:28.4388202+00:00",
      "Bytes": "QEA=",
      "Description": "sample string 4",
      "Tags": [
        "sample string 1",
        "sample string 2"
      ],
      "SkipDuplicateFileName": true
    }
  ]
}

application/xml, text/xml

Sample:

<SirResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Titan.API.Fuel.Models">
  <FacilityId>1</FacilityId>
  <Files xmlns:d2p1="http://schemas.datacontract.org/2004/07/Titan.API.Core.Models">
    <d2p1:EFile>
      <d2p1:Bytes>QEA=</d2p1:Bytes>
      <d2p1:DateOfFile>2025-05-13T09:11:28.4388202+00:00</d2p1:DateOfFile>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:EFileApplicationReferenceId>2</d2p1:EFileApplicationReferenceId>
      <d2p1:FacilityId>1</d2p1:FacilityId>
      <d2p1:FileName>sample string 3</d2p1:FileName>
      <d2p1:SkipDuplicateFileName>true</d2p1:SkipDuplicateFileName>
      <d2p1:Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Tags>
    </d2p1:EFile>
    <d2p1:EFile>
      <d2p1:Bytes>QEA=</d2p1:Bytes>
      <d2p1:DateOfFile>2025-05-13T09:11:28.4388202+00:00</d2p1:DateOfFile>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:EFileApplicationReferenceId>2</d2p1:EFileApplicationReferenceId>
      <d2p1:FacilityId>1</d2p1:FacilityId>
      <d2p1:FileName>sample string 3</d2p1:FileName>
      <d2p1:SkipDuplicateFileName>true</d2p1:SkipDuplicateFileName>
      <d2p1:Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Tags>
    </d2p1:EFile>
  </Files>
  <FirstDateOfPeriod>2025-05-13T09:11:28.4382894+00:00</FirstDateOfPeriod>
  <LastDateOfPeriod>2025-05-13T09:11:28.4382894+00:00</LastDateOfPeriod>
  <TankResults>
    <SirTankResult>
      <InventoryControlFail>true</InventoryControlFail>
      <ResultCode>sample string 2</ResultCode>
      <TankId>1</TankId>
    </SirTankResult>
    <SirTankResult>
      <InventoryControlFail>true</InventoryControlFail>
      <ResultCode>sample string 2</ResultCode>
      <TankId>1</TankId>
    </SirTankResult>
  </TankResults>
</SirResult>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The ID of the added or updated .

boolean

Response Formats

application/json, text/json

Sample:

true

application/xml, text/xml

Sample:

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>