openapi: 3.1.0 info: title: Api version: "0.1" description: API for collecting user consent and ordering consimption data. paths: /ask: post: tags: - asks operationId: ask parameters: - name: switchgrid-test-env in: header schema: anyOf: - type: string enum: - "true" - "false" - type: "null" required: false security: - bearerAuth: [] responses: "200": description: Success content: application/json: schema: type: object properties: id: $ref: "#/components/schemas/Prm" createdAt: type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] status: anyOf: - type: string enum: - CREATED title: CREATED - type: string enum: - PENDING_USER_ACTION title: PENDING_USER_ACTION - type: string enum: - ACCEPTED title: ACCEPTED - type: string enum: - NOT_VALID title: NOT_VALID acceptedAt: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" consentCollectionDetails: anyOf: - anyOf: - type: object properties: service: type: string enum: - DOCUSEAL userUrl: $ref: "#/components/schemas/Url" required: - service - userUrl additionalProperties: false - type: object properties: service: type: string enum: - WEB_HOSTED userUrl: $ref: "#/components/schemas/Url1" required: - service - userUrl additionalProperties: false - type: "null" scopes: type: array items: anyOf: - anyOf: - type: object properties: service: type: string enum: - ENEDIS_RAW_API id: type: string enum: - DETAILS_CONTRACTUELS required: - service - id additionalProperties: false - type: object properties: service: type: string enum: - ENEDIS_RAW_API id: type: string enum: - CONSUMPTION_DATA args: type: object properties: types: type: array items: type: string enum: - CDC - PMAX - IDX - ENERGIE directions: type: array items: type: string enum: - SOUTIRAGE - INJECTION required: - types - directions additionalProperties: false required: - service - id - args additionalProperties: false - anyOf: - type: object properties: id: type: string enum: - ELECTRICITY_TIMESERIES args: type: object properties: types: type: array items: type: string enum: - LOADCURVE directions: type: array items: type: string enum: - CONSUMPTION - INJECTION required: - types - directions additionalProperties: false required: - id - args additionalProperties: false - type: object properties: id: type: string enum: - GAS_TIMESERIES args: type: object properties: types: type: array items: type: string enum: - BILLING - DAILY directions: type: array items: type: string enum: - CONSUMPTION - INJECTION required: - types - directions additionalProperties: false required: - id - args additionalProperties: false - type: object properties: id: type: string enum: - GAS_CONTRACT_DETAILS required: - id additionalProperties: false purposes: type: array items: anyOf: - type: string enum: - SOLAR_INSTALLATION_SIZING title: Sizing of a solar installation - type: string enum: - DEMAND_RESPONSE title: Demand response - type: string enum: - ENERGY_PERFORMANCE_STUDY title: Energy performance study - type: string enum: - ENERGY_BROKERAGE title: Energy brokerage - type: string enum: - VEHICLE_CHARGE_DETECTION title: Detection of a vehicle charge testEnvironment: type: boolean thirdPartyRecipients: type: array items: $ref: "#/components/schemas/Prm" contracts: type: array items: type: object properties: deliveryPointId: type: string seq: anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN status: type: string enum: - PENDING - NOT_FOUND - VALID - NOT_VALID - PENDING_PROOF_VERIFICATION - PROOF_REJECTED proofId: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" statusText: anyOf: - type: object properties: en: $ref: "#/components/schemas/Prm" fr: $ref: "#/components/schemas/Prm" required: - en - fr additionalProperties: false - type: "null" required: - deliveryPointId - seq - status additionalProperties: false required: - id - createdAt - status - acceptedAt - consentCollectionDetails - scopes - purposes - testEnvironment - thirdPartyRecipients - contracts additionalProperties: false "400": description: BadRequest "401": description: Error content: application/json: schema: type: object properties: error: $ref: "#/components/schemas/Prm" required: - error additionalProperties: false summary: Create an Ask requestBody: content: application/json: schema: type: object properties: contracts: type: array items: anyOf: - type: string - type: object properties: _energyType: type: string enum: - electricity deliveryPointId: anyOf: - $ref: "#/components/schemas/Prm" - $ref: "#/components/schemas/Prm" - $ref: "#/components/schemas/TestRtpl" examples: - "00059461297239" holder: anyOf: - type: object properties: _tag: type: string enum: - LegalEntity name: type: string title: Name description: The name under which the the legal entity in registered. otherNames: anyOf: - type: array items: $ref: "#/components/schemas/Prm" allOf: - maxItems: 2 - type: "null" description: Other names of the legal entity. Max 2 names. Could be a brand or former names of that legal entity. required: - _tag - name additionalProperties: false title: Legal Entity description: A legal entity. - type: object properties: _tag: type: string enum: - NaturalPerson fullName: type: string title: Full Name description: The full name of the natural person. examples: - Jean Dupont required: - _tag - fullName additionalProperties: false title: Natural Person description: A natural person. _Personne morale_ in French. description: The legal person or legal entity that holds the contract. address: type: object properties: appartementBatiment: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" lieuDit: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" rueEtNumero: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" codePostal: $ref: "#/components/schemas/Prm" commune: $ref: "#/components/schemas/Prm" required: - codePostal - commune additionalProperties: false description: The address of the contract holder. required: - _energyType - deliveryPointId - holder - address additionalProperties: false title: French Electricity Contract description: A French electricity contract. - type: object properties: _energyType: type: string enum: - gas deliveryPointId: $ref: "#/components/schemas/Pce" holder: anyOf: - type: object properties: _tag: type: string enum: - LegalEntity name: type: string title: Name description: The name under which the the legal entity in registered. otherNames: anyOf: - type: array items: $ref: "#/components/schemas/Prm" allOf: - maxItems: 2 - type: "null" description: Other names of the legal entity. Max 2 names. Could be a brand or former names of that legal entity. required: - _tag - name additionalProperties: false title: Legal Entity description: A legal entity. - type: object properties: _tag: type: string enum: - NaturalPerson fullName: type: string title: Full Name description: The full name of the natural person. examples: - Jean Dupont required: - _tag - fullName additionalProperties: false title: Natural Person description: A natural person. _Personne morale_ in French. description: The legal person or legal entity that holds the contract. address: type: object properties: appartementBatiment: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" lieuDit: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" rueEtNumero: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" codePostal: $ref: "#/components/schemas/Prm" commune: $ref: "#/components/schemas/Prm" required: - codePostal - commune additionalProperties: false description: The address of the contract holder. required: - _energyType - deliveryPointId - holder - address additionalProperties: false title: French Gas Contract description: A French gas contract. signer: anyOf: - type: object properties: genre: anyOf: - anyOf: - type: string enum: - M - F - type: "null" - type: "null" lastName: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" firstName: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" organizationName: anyOf: - anyOf: - type: string allOf: - minLength: 1 - type: "null" - type: "null" phone: anyOf: - anyOf: - $ref: "#/components/schemas/Prm" - type: "null" - type: "null" email: anyOf: - anyOf: - $ref: "#/components/schemas/Prm" - type: "null" - type: "null" additionalProperties: false description: >- The person signing the Consent request. For WEB_CONSENT, all fields are optional (the user will be able to fill their names and organization). For DOCUSEAL, fields firstName & lastName are required. - type: "null" options: anyOf: - type: object properties: skipAddressCheck: anyOf: - type: boolean - type: "null" additionalProperties: false - type: "null" scopes: anyOf: - type: array items: anyOf: - anyOf: - type: object properties: service: type: string enum: - ENEDIS_RAW_API id: type: string enum: - DETAILS_CONTRACTUELS required: - service - id additionalProperties: false - type: object properties: service: type: string enum: - ENEDIS_RAW_API id: type: string enum: - CONSUMPTION_DATA args: type: object properties: types: type: array items: type: string enum: - CDC - PMAX - IDX - ENERGIE directions: type: array items: type: string enum: - SOUTIRAGE - INJECTION required: - types - directions additionalProperties: false required: - service - id - args additionalProperties: false - anyOf: - type: object properties: id: type: string enum: - ELECTRICITY_TIMESERIES args: type: object properties: types: type: array items: type: string enum: - LOADCURVE directions: type: array items: type: string enum: - CONSUMPTION - INJECTION required: - types - directions additionalProperties: false required: - id - args additionalProperties: false - type: object properties: id: type: string enum: - GAS_TIMESERIES args: type: object properties: types: type: array items: type: string enum: - BILLING - DAILY directions: type: array items: type: string enum: - CONSUMPTION - INJECTION required: - types - directions additionalProperties: false required: - id - args additionalProperties: false - type: object properties: id: type: string enum: - GAS_CONTRACT_DETAILS required: - id additionalProperties: false - type: "null" purposes: anyOf: - type: array items: anyOf: - anyOf: - type: string enum: - SOLAR_INSTALLATION_SIZING title: Sizing of a solar installation - type: string enum: - DEMAND_RESPONSE title: Demand response - type: string enum: - ENERGY_PERFORMANCE_STUDY title: Energy performance study - type: string enum: - ENERGY_BROKERAGE title: Energy brokerage - type: string enum: - VEHICLE_CHARGE_DETECTION title: Detection of a vehicle charge - type: object properties: id: anyOf: - type: string enum: - SOLAR_INSTALLATION_SIZING title: Sizing of a solar installation - type: string enum: - DEMAND_RESPONSE title: Demand response - type: string enum: - ENERGY_PERFORMANCE_STUDY title: Energy performance study - type: string enum: - ENERGY_BROKERAGE title: Energy brokerage - type: string enum: - VEHICLE_CHARGE_DETECTION title: Detection of a vehicle charge required: - id additionalProperties: false - type: "null" consentDuration: anyOf: - anyOf: - type: string enum: - 1 day title: 1 day - type: string enum: - 2 days title: 2 days - type: string enum: - 3 days title: 3 days - type: string enum: - 4 days title: 4 days - type: string enum: - 5 days title: 5 days - type: string enum: - 6 days title: 6 days - type: string enum: - 1 week title: 1 week - type: string enum: - 2 weeks title: 2 weeks - type: string enum: - 3 weeks title: 3 weeks - type: string enum: - 4 weeks title: 4 weeks - type: string enum: - 1 month title: 1 month - type: string enum: - 2 months title: 2 months - type: string enum: - 3 months title: 3 months - type: string enum: - 4 months title: 4 months - type: string enum: - 5 months title: 5 months - type: string enum: - 6 months title: 6 months - type: string enum: - 1 year title: 1 year - type: string enum: - 2 years title: 2 years - type: string enum: - 3 years title: 3 years - type: string enum: - 4 years title: 4 years - type: string enum: - 5 years title: 5 years - type: string enum: - 6 years title: 6 years - type: string enum: - 7 years title: 7 years - type: string enum: - 8 years title: 8 years - type: string enum: - 9 years title: 9 years - type: string enum: - 10 years title: 10 years - type: string enum: - 11 years title: 11 years - type: string enum: - 12 years title: 12 years - type: string enum: - 13 years title: 13 years - type: string enum: - 14 years title: 14 years - type: string enum: - 15 years title: 15 years - type: string enum: - 16 years title: 16 years - type: string enum: - 17 years title: 17 years - type: string enum: - 18 years title: 18 years - type: string enum: - 19 years title: 19 years - type: string enum: - 20 years title: 20 years - type: "null" thirdPartyRecipients: anyOf: - type: array items: $ref: "#/components/schemas/Prm" description: Optional list of slugs identifying third parties who will get access to the data after consent is given. - type: "null" orgSlug: anyOf: - type: string description: Optional slug of the organization that will be used to create the ask. If using a serviceAccount (API key) this is not needed. If logged in as a user that has access to more than one organization, this is needed for disambiguation. - type: "null" required: - contracts additionalProperties: false examples: - contracts: - 606b5149-1ef0-414a-8019-a050f64cc0ac - contracts: - 606b5149-1ef0-414a-8019-a050f64cc0ac consentDuration: 1 year signer: email: signer-tBmoy@domain.com firstName: firstName lastName: lastName purposes: - SOLAR_INSTALLATION_SIZING required: true get: tags: - asks operationId: getAsks parameters: - name: switchgrid-test-env in: header schema: anyOf: - type: string enum: - "true" - "false" - type: "null" required: false - name: prm in: query schema: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" required: false - name: status in: query schema: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" required: false - name: skip in: query schema: anyOf: - type: string - type: "null" required: false - name: limit in: query schema: anyOf: - type: string - type: "null" required: false - name: orderBy in: query schema: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" required: false security: - bearerAuth: [] responses: "200": description: Success content: application/json: schema: type: object properties: skip: anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN limit: anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN totalItemsCount: anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN returnedItemsCount: anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN items: type: array items: type: object properties: id: $ref: "#/components/schemas/Prm" createdAt: type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] status: anyOf: - type: string enum: - CREATED title: CREATED - type: string enum: - PENDING_USER_ACTION title: PENDING_USER_ACTION - type: string enum: - ACCEPTED title: ACCEPTED - type: string enum: - NOT_VALID title: NOT_VALID acceptedAt: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" consentCollectionDetails: anyOf: - anyOf: - type: object properties: service: type: string enum: - DOCUSEAL userUrl: $ref: "#/components/schemas/Url" required: - service - userUrl additionalProperties: false - type: object properties: service: type: string enum: - WEB_HOSTED userUrl: $ref: "#/components/schemas/Url1" required: - service - userUrl additionalProperties: false - type: "null" scopes: type: array items: anyOf: - anyOf: - type: object properties: service: type: string enum: - ENEDIS_RAW_API id: type: string enum: - DETAILS_CONTRACTUELS required: - service - id additionalProperties: false - type: object properties: service: type: string enum: - ENEDIS_RAW_API id: type: string enum: - CONSUMPTION_DATA args: type: object properties: types: type: array items: type: string enum: - CDC - PMAX - IDX - ENERGIE directions: type: array items: type: string enum: - SOUTIRAGE - INJECTION required: - types - directions additionalProperties: false required: - service - id - args additionalProperties: false - anyOf: - type: object properties: id: type: string enum: - ELECTRICITY_TIMESERIES args: type: object properties: types: type: array items: type: string enum: - LOADCURVE directions: type: array items: type: string enum: - CONSUMPTION - INJECTION required: - types - directions additionalProperties: false required: - id - args additionalProperties: false - type: object properties: id: type: string enum: - GAS_TIMESERIES args: type: object properties: types: type: array items: type: string enum: - BILLING - DAILY directions: type: array items: type: string enum: - CONSUMPTION - INJECTION required: - types - directions additionalProperties: false required: - id - args additionalProperties: false - type: object properties: id: type: string enum: - GAS_CONTRACT_DETAILS required: - id additionalProperties: false purposes: type: array items: anyOf: - type: string enum: - SOLAR_INSTALLATION_SIZING title: Sizing of a solar installation - type: string enum: - DEMAND_RESPONSE title: Demand response - type: string enum: - ENERGY_PERFORMANCE_STUDY title: Energy performance study - type: string enum: - ENERGY_BROKERAGE title: Energy brokerage - type: string enum: - VEHICLE_CHARGE_DETECTION title: Detection of a vehicle charge testEnvironment: type: boolean thirdPartyRecipients: type: array items: $ref: "#/components/schemas/Prm" contracts: type: array items: type: object properties: deliveryPointId: type: string seq: anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN status: type: string enum: - PENDING - NOT_FOUND - VALID - NOT_VALID - PENDING_PROOF_VERIFICATION - PROOF_REJECTED proofId: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" statusText: anyOf: - type: object properties: en: $ref: "#/components/schemas/Prm" fr: $ref: "#/components/schemas/Prm" required: - en - fr additionalProperties: false - type: "null" required: - deliveryPointId - seq - status additionalProperties: false required: - id - createdAt - status - acceptedAt - consentCollectionDetails - scopes - purposes - testEnvironment - thirdPartyRecipients - contracts additionalProperties: false required: - skip - limit - totalItemsCount - returnedItemsCount - items additionalProperties: false "400": description: BadRequest "401": description: Error content: application/json: schema: type: object properties: error: $ref: "#/components/schemas/Prm" required: - error additionalProperties: false summary: List Asks /ask/{askId}: get: tags: - asks operationId: getAsk parameters: - name: askId in: path schema: $ref: "#/components/schemas/Prm" required: true security: - bearerAuth: [] responses: "200": description: Success content: application/json: schema: type: object properties: id: $ref: "#/components/schemas/Prm" createdAt: type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] status: anyOf: - type: string enum: - CREATED title: CREATED - type: string enum: - PENDING_USER_ACTION title: PENDING_USER_ACTION - type: string enum: - ACCEPTED title: ACCEPTED - type: string enum: - NOT_VALID title: NOT_VALID acceptedAt: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" consentCollectionDetails: anyOf: - anyOf: - type: object properties: service: type: string enum: - DOCUSEAL userUrl: $ref: "#/components/schemas/Url" required: - service - userUrl additionalProperties: false - type: object properties: service: type: string enum: - WEB_HOSTED userUrl: $ref: "#/components/schemas/Url1" required: - service - userUrl additionalProperties: false - type: "null" scopes: type: array items: anyOf: - anyOf: - type: object properties: service: type: string enum: - ENEDIS_RAW_API id: type: string enum: - DETAILS_CONTRACTUELS required: - service - id additionalProperties: false - type: object properties: service: type: string enum: - ENEDIS_RAW_API id: type: string enum: - CONSUMPTION_DATA args: type: object properties: types: type: array items: type: string enum: - CDC - PMAX - IDX - ENERGIE directions: type: array items: type: string enum: - SOUTIRAGE - INJECTION required: - types - directions additionalProperties: false required: - service - id - args additionalProperties: false - anyOf: - type: object properties: id: type: string enum: - ELECTRICITY_TIMESERIES args: type: object properties: types: type: array items: type: string enum: - LOADCURVE directions: type: array items: type: string enum: - CONSUMPTION - INJECTION required: - types - directions additionalProperties: false required: - id - args additionalProperties: false - type: object properties: id: type: string enum: - GAS_TIMESERIES args: type: object properties: types: type: array items: type: string enum: - BILLING - DAILY directions: type: array items: type: string enum: - CONSUMPTION - INJECTION required: - types - directions additionalProperties: false required: - id - args additionalProperties: false - type: object properties: id: type: string enum: - GAS_CONTRACT_DETAILS required: - id additionalProperties: false purposes: type: array items: anyOf: - type: string enum: - SOLAR_INSTALLATION_SIZING title: Sizing of a solar installation - type: string enum: - DEMAND_RESPONSE title: Demand response - type: string enum: - ENERGY_PERFORMANCE_STUDY title: Energy performance study - type: string enum: - ENERGY_BROKERAGE title: Energy brokerage - type: string enum: - VEHICLE_CHARGE_DETECTION title: Detection of a vehicle charge testEnvironment: type: boolean thirdPartyRecipients: type: array items: $ref: "#/components/schemas/Prm" contracts: type: array items: type: object properties: deliveryPointId: type: string seq: anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN status: type: string enum: - PENDING - NOT_FOUND - VALID - NOT_VALID - PENDING_PROOF_VERIFICATION - PROOF_REJECTED proofId: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" statusText: anyOf: - type: object properties: en: $ref: "#/components/schemas/Prm" fr: $ref: "#/components/schemas/Prm" required: - en - fr additionalProperties: false - type: "null" required: - deliveryPointId - seq - status additionalProperties: false required: - id - createdAt - status - acceptedAt - consentCollectionDetails - scopes - purposes - testEnvironment - thirdPartyRecipients - contracts additionalProperties: false "400": description: BadRequest "401": description: Error content: application/json: schema: type: object properties: error: $ref: "#/components/schemas/Prm" required: - error additionalProperties: false summary: Get an Ask /ask/{askId}/proof: get: tags: - asks operationId: getAskProof parameters: - name: askId in: path schema: $ref: "#/components/schemas/Prm" required: true security: - bearerAuth: [] responses: "200": description: Success content: application/pdf: schema: $ref: "#/components/schemas/Prm" "400": description: BadRequest "401": description: Error content: application/json: schema: type: object properties: error: $ref: "#/components/schemas/Prm" required: - error additionalProperties: false summary: Get an Ask proof as PDF, when it's accepted /integration/grdf-adict/donnees-techniques: post: tags: - "[BETA] integration/grdf-adict" operationId: grdf-adict/donnees-techniques parameters: [] security: [] responses: "200": description: Success content: application/json: schema: type: object properties: pce: type: object properties: id_pce: $ref: "#/components/schemas/Pce" required: - id_pce additionalProperties: false situation_compteur: type: object properties: numero_rue: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" nom_rue: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" complement_adresse: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" code_postal: $ref: "#/components/schemas/Prm" commune: $ref: "#/components/schemas/Prm" required: - numero_rue - nom_rue - complement_adresse - code_postal - commune additionalProperties: false caracteristiques_compteur: type: object properties: frequence: $ref: "#/components/schemas/Prm" client_sensible_mig: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" code_calibre: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" code_debit: $ref: "#/components/schemas/Prm" code_debit_normalise: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" pression_livraison: $ref: "#/components/schemas/Prm" matricule_compteur: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" required: - frequence - client_sensible_mig - code_calibre - code_debit - code_debit_normalise - pression_livraison - matricule_compteur additionalProperties: false pitd: type: object properties: identifiant_pitd: $ref: "#/components/schemas/Prm" libelle_pitd: $ref: "#/components/schemas/Prm" required: - identifiant_pitd - libelle_pitd additionalProperties: false regime_propriete: type: object properties: regime_propriete_compteur: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" regime_propriete_convertisseur: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" regime_propriete_poste: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" regime_propriete_enregistreur: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" required: - regime_propriete_compteur - regime_propriete_convertisseur - regime_propriete_poste - regime_propriete_enregistreur additionalProperties: false required: - pce - situation_compteur - caracteristiques_compteur - pitd - regime_propriete additionalProperties: false "400": description: BadRequest description: from GRDF. Technical and contractual data for the delivery point summary: Données Techniques requestBody: content: application/json: schema: type: object properties: pce: $ref: "#/components/schemas/Pce1" required: - pce additionalProperties: false required: true /integration/grdf-adict/donnees-informatives: post: tags: - "[BETA] integration/grdf-adict" operationId: grdf-adict/donnees-informatives parameters: [] security: [] responses: "200": description: Success content: application/json: schema: type: object properties: pce: type: object properties: id_pce: $ref: "#/components/schemas/Pce" required: - id_pce additionalProperties: false periode: type: object properties: valeur: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" date_debut: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" date_fin: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" required: - valeur - date_debut - date_fin additionalProperties: false consommations: type: array items: type: object properties: consommation: anyOf: - type: object properties: date_debut_consommation: type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] date_fin_consommation: type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] flag_retour_zero: type: "null" volume_brut: type: "null" coeff_calcul: type: object properties: coeff_pta: type: "null" valeur_pcs: type: "null" coeff_conversion: type: "null" required: - coeff_pta - valeur_pcs - coeff_conversion additionalProperties: false volume_converti: type: "null" energie: type: "null" type_qualif_conso: type: string enum: - Absence de Données sens_flux_gaz: type: "null" statut_conso: type: "null" journee_gaziere: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" type_conso: type: "null" required: - date_debut_consommation - date_fin_consommation - flag_retour_zero - volume_brut - coeff_calcul - volume_converti - energie - type_qualif_conso - sens_flux_gaz - statut_conso - journee_gaziere - type_conso additionalProperties: false - type: object properties: date_debut_consommation: type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] date_fin_consommation: type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] flag_retour_zero: anyOf: - type: boolean - type: "null" volume_brut: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" coeff_calcul: type: object properties: coeff_pta: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" valeur_pcs: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" coeff_conversion: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" required: - coeff_pta - valeur_pcs - coeff_conversion additionalProperties: false volume_converti: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" energie: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" type_qualif_conso: $ref: "#/components/schemas/Prm" sens_flux_gaz: $ref: "#/components/schemas/Prm" statut_conso: $ref: "#/components/schemas/Prm" journee_gaziere: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" type_conso: $ref: "#/components/schemas/Prm" required: - date_debut_consommation - date_fin_consommation - flag_retour_zero - volume_brut - coeff_calcul - volume_converti - energie - type_qualif_conso - sens_flux_gaz - statut_conso - journee_gaziere - type_conso additionalProperties: false releve_debut: type: object properties: date_releve: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" index_brut_debut: type: object properties: valeur_index: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" horodate_Index: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" required: - valeur_index - horodate_Index additionalProperties: false index_converti_debut: type: object properties: valeur_index: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" horodate_Index: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" required: - valeur_index - horodate_Index additionalProperties: false required: - date_releve - index_brut_debut - index_converti_debut additionalProperties: false releve_fin: type: object properties: date_releve: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" index_brut_fin: type: object properties: valeur_index: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" horodate_Index: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" required: - valeur_index - horodate_Index additionalProperties: false index_converti_fin: type: object properties: valeur_index: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" horodate_Index: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" required: - valeur_index - horodate_Index additionalProperties: false required: - date_releve - index_brut_fin - index_converti_fin additionalProperties: false required: - consommation - releve_debut - releve_fin additionalProperties: false required: - pce - periode - consommations additionalProperties: false "400": description: BadRequest description: from GRDF. This is the most accurate data available from them. summary: Daily data - Données informatives requestBody: content: application/json: schema: type: object properties: pce: $ref: "#/components/schemas/Pce1" required: - pce additionalProperties: false required: true /integration/grdf-adict/donnees-publiees: post: tags: - "[BETA] integration/grdf-adict" operationId: grdf-adict/donnees-publiees parameters: [] security: [] responses: "200": description: Success content: application/json: schema: type: object properties: pce: type: object properties: id_pce: $ref: "#/components/schemas/Pce" required: - id_pce additionalProperties: false periode: type: object properties: valeur: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" date_debut: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" date_fin: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" required: - valeur - date_debut - date_fin additionalProperties: false consommations: type: array items: type: object properties: consommation: anyOf: - type: object properties: date_debut_consommation: type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] date_fin_consommation: type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] flag_retour_zero: type: "null" volume_brut: type: "null" coeff_calcul: type: object properties: coeff_pta: type: "null" valeur_pcs: type: "null" coeff_conversion: type: "null" required: - coeff_pta - valeur_pcs - coeff_conversion additionalProperties: false volume_converti: type: "null" energie: type: "null" type_qualif_conso: type: string enum: - Absence de Données sens_flux_gaz: type: "null" statut_conso: type: "null" journee_gaziere: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" type_conso: type: "null" required: - date_debut_consommation - date_fin_consommation - flag_retour_zero - volume_brut - coeff_calcul - volume_converti - energie - type_qualif_conso - sens_flux_gaz - statut_conso - journee_gaziere - type_conso additionalProperties: false - type: object properties: date_debut_consommation: type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] date_fin_consommation: type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] flag_retour_zero: anyOf: - type: boolean - type: "null" volume_brut: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" coeff_calcul: type: object properties: coeff_pta: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" valeur_pcs: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" coeff_conversion: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" required: - coeff_pta - valeur_pcs - coeff_conversion additionalProperties: false volume_converti: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" energie: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" type_qualif_conso: $ref: "#/components/schemas/Prm" sens_flux_gaz: $ref: "#/components/schemas/Prm" statut_conso: $ref: "#/components/schemas/Prm" journee_gaziere: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" type_conso: $ref: "#/components/schemas/Prm" required: - date_debut_consommation - date_fin_consommation - flag_retour_zero - volume_brut - coeff_calcul - volume_converti - energie - type_qualif_conso - sens_flux_gaz - statut_conso - journee_gaziere - type_conso additionalProperties: false releve_debut: type: object properties: date_releve: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" index_brut_debut: type: object properties: valeur_index: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" horodate_Index: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" required: - valeur_index - horodate_Index additionalProperties: false index_converti_debut: type: object properties: valeur_index: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" horodate_Index: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" required: - valeur_index - horodate_Index additionalProperties: false required: - date_releve - index_brut_debut - index_converti_debut additionalProperties: false releve_fin: type: object properties: date_releve: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" index_brut_fin: type: object properties: valeur_index: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" horodate_Index: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" required: - valeur_index - horodate_Index additionalProperties: false index_converti_fin: type: object properties: valeur_index: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - type: "null" horodate_Index: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" required: - valeur_index - horodate_Index additionalProperties: false required: - date_releve - index_brut_fin - index_converti_fin additionalProperties: false required: - consommation - releve_debut - releve_fin additionalProperties: false required: - pce - periode - consommations additionalProperties: false "400": description: BadRequest description: from GRDF. This is the data used for invoicing. summary: Invoicing data - Données Publiées requestBody: content: application/json: schema: type: object properties: pce: $ref: "#/components/schemas/Pce1" required: - pce additionalProperties: false required: true /integration/esr/contract: post: tags: - "[BETA] integration/esr" operationId: esr/contract parameters: [] security: [] responses: "200": description: Success content: application/json: schema: type: object properties: rtpl: anyOf: - $ref: "#/components/schemas/TestRtpl" - $ref: "#/components/schemas/Prm" usagePoint: type: object properties: usagePointId: anyOf: - $ref: "#/components/schemas/TestRtpl" - $ref: "#/components/schemas/Prm" usagePointStatus: $ref: "#/components/schemas/Prm" meterType: $ref: "#/components/schemas/Prm" required: - usagePointId - usagePointStatus - meterType additionalProperties: false contract: type: object properties: segment: $ref: "#/components/schemas/Prm" subscribedPower: $ref: "#/components/schemas/Prm" lastActivationDate: $ref: "#/components/schemas/Prm" distributionTariff: $ref: "#/components/schemas/Prm" offpeakHours: $ref: "#/components/schemas/Prm" contractType: $ref: "#/components/schemas/Prm" contratStatus: $ref: "#/components/schemas/Prm" lastDistributionTariffChangeDate: $ref: "#/components/schemas/Prm" required: - segment - subscribedPower - lastActivationDate - distributionTariff - offpeakHours - contractType - contratStatus - lastDistributionTariffChangeDate additionalProperties: false required: - rtpl - usagePoint - contract additionalProperties: false "400": description: BadRequest description: Technical and contractual data for the delivery point summary: Contract data requestBody: content: application/json: schema: type: object properties: rtpl: anyOf: - $ref: "#/components/schemas/TestRtpl" - $ref: "#/components/schemas/Prm" required: - rtpl additionalProperties: false required: true /integration/esr/meter-readings: post: tags: - "[BETA] integration/esr" operationId: esr/meter-readings parameters: [] security: [] responses: "200": description: Success content: application/json: schema: type: object properties: rtpl: anyOf: - $ref: "#/components/schemas/TestRtpl" - $ref: "#/components/schemas/Prm" start: $ref: "#/components/schemas/Prm" end: $ref: "#/components/schemas/Prm" count: type: integer data: type: array items: type: object properties: timestamp: type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] timestampStorage: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" value: anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN measureType: $ref: "#/components/schemas/Prm" libelle: $ref: "#/components/schemas/Prm" required: - timestamp - timestampStorage - value - measureType - libelle additionalProperties: false required: - rtpl - start - end - count - data additionalProperties: false "400": description: BadRequest description: Daily index readings corresponding to the parameters summary: Daily data - Meter readings requestBody: content: application/json: schema: type: object properties: rtpl: anyOf: - $ref: "#/components/schemas/TestRtpl" - $ref: "#/components/schemas/Prm" type: type: string enum: - distributeur - fournisseur since: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" until: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" required: - rtpl - type additionalProperties: false required: true /integration/esr/average-powers: post: tags: - "[BETA] integration/esr" operationId: esr/average-powers parameters: [] security: [] responses: "200": description: Success content: application/json: schema: type: object properties: rtpl: anyOf: - $ref: "#/components/schemas/TestRtpl" - $ref: "#/components/schemas/Prm" start: type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] end: type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] count: type: integer data: type: array items: type: object properties: timestamp: type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] timestampStorage: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" value: anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN pas: type: string libelle: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" required: - timestamp - timestampStorage - value - pas - libelle additionalProperties: false required: - rtpl - start - end - count - data additionalProperties: false "400": description: BadRequest description: Points on the loadcurve corresponding to the parameters summary: Loadcurve requestBody: content: application/json: schema: type: object properties: rtpl: anyOf: - $ref: "#/components/schemas/TestRtpl" - $ref: "#/components/schemas/Prm" since: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" until: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" type: type: string enum: - soutirage - injection required: - rtpl - type additionalProperties: false required: true /integration/esr/maximum-powers: post: tags: - "[BETA] integration/esr" operationId: esr/maximum-powers parameters: [] security: [] responses: "200": description: Success content: application/json: schema: type: object properties: rtpl: anyOf: - $ref: "#/components/schemas/TestRtpl" - $ref: "#/components/schemas/Prm" start: $ref: "#/components/schemas/Prm" end: $ref: "#/components/schemas/Prm" count: type: integer data: type: array items: type: object properties: timestamp: type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] timestampStorage: anyOf: - type: string examples: - 2024-12-10T00:00:00 - 2024-12-10T12:00:00Z - 2024-12-10T00:00:00+01:00 - 2024-12-10 - 2024-12-10T00:00:00[Europe/Paris] - 2024-12-10T00:00:00[CET] - type: "null" value: anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN pas: type: "null" libelle: type: "null" required: - timestamp - timestampStorage - value - pas - libelle additionalProperties: false required: - rtpl - start - end - count - data additionalProperties: false "400": description: BadRequest description: Maximum daily power points corresponding to the parameters summary: Daily data - maximum powers requestBody: content: application/json: schema: type: object properties: rtpl: anyOf: - $ref: "#/components/schemas/TestRtpl" - $ref: "#/components/schemas/Prm" since: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" until: anyOf: - $ref: "#/components/schemas/Prm" - type: "null" required: - rtpl additionalProperties: false required: true components: schemas: Prm: type: string TestRtpl: type: string allOf: - pattern: (ESR)\d{5}C[1-6]\d{4}$ title: TestRtpl description: "a test code: the id of the integration followed by 5 numbers, then C1-C4, then 4 numbers" Pce: anyOf: - anyOf: - anyOf: - type: number - type: string enum: - NaN - type: string enum: - Infinity - type: string enum: - -Infinity - type: string enum: - Infinity - -Infinity - NaN - $ref: "#/components/schemas/Prm" Url: type: string description: The URL to the document that the user needs to sign. examples: - https://docuseal.co/s/x1uPBSwot114QM Url1: type: string description: The URL of the page to embed, or redirect the user to. examples: - https://c/ask/f965e8f1-9bf3-4dbd-8871-96bf236e9ce3 Pce1: type: string allOf: - pattern: ^([0-9]{14}|GI[0-9]{6})$ title: Pce description: a Pce number, 14 digits long, or 'GI' followed by 6 digits securitySchemes: bearerAuth: type: http scheme: bearer security: [] tags: - name: asks description: Operations related to asks - name: "[BETA] integration/grdf-adict" description: Operations related to GRDF Adict integration - name: "[BETA] integration/esr" description: Operations related to Strasbourg Électricité Réseaux integration servers: - url: https://scw.switchgrid.tech/v0_1