{
  "opencollection": "1.0.0",
  "info": {
    "name": "Ostrom Auth Contracts API",
    "version": "2023-11-01"
  },
  "items": [
    {
      "info": {
        "name": "Contracts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve user contracts information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://sandbox.ostrom-api.io/contracts",
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://auth.sandbox.ostrom-api.io/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Allowed role: `USER`"
        },
        {
          "info": {
            "name": "Retrieve user contract smart meter consumption",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://sandbox.ostrom-api.io/contracts/:contractId/energy-consumption",
            "params": [
              {
                "name": "contractId",
                "value": "",
                "type": "path",
                "description": "ID of the contract"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "start date ISO format on UTC timezone. e.g. 2023-11-01T00:00:00.000Z"
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "end date ISO format on UTC timezone. e.g. 2023-11-02T00:00:00.000Z"
              },
              {
                "name": "resolution",
                "value": "",
                "type": "query",
                "description": "The unit of time the data will be aggregated"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://auth.sandbox.ostrom-api.io/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Allowed role: `USER`"
        },
        {
          "info": {
            "name": "Retrieve user contracts information by external user id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://sandbox.ostrom-api.io/users/:externalUserId/contracts",
            "params": [
              {
                "name": "externalUserId",
                "value": "",
                "type": "path",
                "description": "Partner user unique identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://auth.sandbox.ostrom-api.io/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Allowed role: `PARTNER`"
        },
        {
          "info": {
            "name": "Retrieve user contract information by external user id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://sandbox.ostrom-api.io/users/:externalUserId/contracts/:contractId",
            "params": [
              {
                "name": "externalUserId",
                "value": "",
                "type": "path",
                "description": "Partner user unique identifier"
              },
              {
                "name": "contractId",
                "value": "",
                "type": "path",
                "description": "ID of the contract"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://auth.sandbox.ostrom-api.io/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Allowed role: `PARTNER`"
        },
        {
          "info": {
            "name": "Retrieve user contract smart meter consumption by external user id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://sandbox.ostrom-api.io/users/:externalUserId/contracts/:contractId/energy-consumption",
            "params": [
              {
                "name": "externalUserId",
                "value": "",
                "type": "path",
                "description": "Partner user unique identifier"
              },
              {
                "name": "contractId",
                "value": "",
                "type": "path",
                "description": "ID of the contract"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "start date ISO format on UTC timezone. e.g. 2023-11-01T00:00:00.000Z"
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "end date ISO format on UTC timezone. e.g. 2023-11-02T00:00:00.000Z"
              },
              {
                "name": "resolution",
                "value": "",
                "type": "query",
                "description": "The unit of time the data will be aggregated"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://auth.sandbox.ostrom-api.io/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Allowed role: `PARTNER`"
        }
      ]
    }
  ],
  "bundled": true
}