API Document

#TAO Microservices API ## HTTP://thematique-eod-int.rte-france.com:8765/api/v1 ## TAO Microservices public and internal APIs. ### About errors For all exposed resources, response with HTTP status `500` may occurs to mirror internal server errors or `502` for third party error. [**Contact the developer**](mailto:cdsi.rte.tao_int@sqli.com) **Version** 1.0.0 [**Terms of Service**]() # Security Definitions ### MybasicAuth <table> <tr> <th>type</th> <th colspan="2">basic</th> </tr> </table> # APIs ## /ordres/spc/pm ### POST <a id="integratePMSpecific">Programme de marche lié à un Ordre Spécifique.</a> #### Request **Content-Type: ** application/xml ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>no</td> <td></td> <td> - </td> <td> <a href="#/definitions/MultipleScheduleMarketDocument">MultipleScheduleMarketDocument</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | OK | <a href="#/definitions/MultipleScheduleMarketDocument">MultipleScheduleMarketDocument</a>| ## /ordres/std ### GET <a id="consultStandardOrderXML">Consultation d'Ordres Standards.</a> #### Request ##### Parameters #### Response **Content-Type: ** application/xml | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | OK | <a href="#/definitions/AcknowledgementMarketDocument">AcknowledgementMarketDocument</a>| ## /ordres/std/pm ### POST <a id="integratePMStandard">Programme de marche lié à un Ordre Standard.</a> #### Request **Content-Type: ** application/xml ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>no</td> <td></td> <td> - </td> <td> <a href="#/definitions/MultipleScheduleMarketDocument">MultipleScheduleMarketDocument</a> </td> </tr> </table> #### Response **Content-Type: ** application/xml | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | OK | <a href="#/definitions/MultipleScheduleMarketDocument">MultipleScheduleMarketDocument</a>| ## /ordres/std/response ### POST <a id="replyToStandardOrderFromWeb">Réponse à un Ordre Standard.</a> #### Request **Content-Type: ** application/json ##### Parameters <table border="1"> <tr> <th>Name</th> <th>Located in</th> <th>Required</th> <th>Description</th> <th>Default</th> <th>Schema</th> </tr> <tr> <th>body</th> <td>body</td> <td>no</td> <td></td> <td> - </td> <td> <a href="#/definitions/OrderGroupDTO">OrderGroupDTO</a> </td> </tr> </table> #### Response **Content-Type: ** application/json | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 200 | OK | <a href="#/definitions/AcknowledgementMarketDocument">AcknowledgementMarketDocument</a>| # Definitions ## <a name="/definitions/AcknowledgementMarketDocument">AcknowledgementMarketDocument</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>mrid</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>createdDateTime</td> <td> string (date-time) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>senderMarketParticipantMRID</td> <td> <a href="#/definitions/PartyIDString">PartyIDString</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>senderMarketParticipantMarketRoleType</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>receiverMarketParticipantMRID</td> <td> <a href="#/definitions/PartyIDString">PartyIDString</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>receiverMarketParticipantMarketRoleType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>receivedMarketDocumentMRID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>receivedMarketDocumentRevisionNumber</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>receivedMarketDocumentType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>receivedMarketDocumentProcessProcessType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>receivedMarketDocumentTitle</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>receivedMarketDocumentCreatedDateTime</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>rejectedTimeSeries</td> <td> array[<a href="#/definitions/TimeSeries">TimeSeries</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>reason</td> <td> array[<a href="#/definitions/Reason">Reason</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>inErrorPeriod</td> <td> array[<a href="#/definitions/TimePeriod">TimePeriod</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/ActivationMarketDocument">ActivationMarketDocument</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>mrid</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>revisionNumber</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>type</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>processProcessType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>senderMarketParticipantMRID</td> <td> <a href="#/definitions/PartyIDString">PartyIDString</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>senderMarketParticipantMarketRoleType</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>receiverMarketParticipantMRID</td> <td> <a href="#/definitions/PartyIDString">PartyIDString</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>receiverMarketParticipantMarketRoleType</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>createdDateTime</td> <td> string (date-time) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>activationTimePeriodTimeInterval</td> <td> <a href="#/definitions/ESMPDateTimeInterval">ESMPDateTimeInterval</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>domainMRID</td> <td> <a href="#/definitions/AreaIDString">AreaIDString</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>subjectMarketParticipantMRID</td> <td> <a href="#/definitions/PartyIDString">PartyIDString</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>subjectMarketParticipantMarketRoleType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>orderMarketDocumentMRID</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>orderMarketDocumentRevisionNumber</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>timeSeries</td> <td> array[<a href="#/definitions/TimeSeries">TimeSeries</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/AreaIDString">AreaIDString</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>value</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>codingScheme</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/CentreExploitationDTO">CentreExploitationDTO</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>nom</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>alertCtrso</td> <td> boolean </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>lastAlarmUpdate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>lastCtrsoJ1Update</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>lastCtrsoIJUpdate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>ctrsosValidationDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/CtrsoDTO">CtrsoDTO</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>id</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>edaNom</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>ctrsoStatus</td> <td> <a href="#/definitions/CtrsoStatusDTO">CtrsoStatusDTO</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dateDebut</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dateFin</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>dateEnregistrement</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>commentaire</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>validee</td> <td> boolean </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/CtrsoStatusDTO">CtrsoStatusDTO</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>id</td> <td> integer (int64) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>libelle</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>couleur</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/Duration">Duration</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>months</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>hours</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>minutes</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>seconds</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>xmlschemaType</td> <td> <a href="#/definitions/QName">QName</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>sign</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>years</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>days</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/ESMPDateTimeInterval">ESMPDateTimeInterval</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>start</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>end</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/EdaDTO">EdaDTO</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>functionalId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>acteurAjustement</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>type</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>isWatched</td> <td> boolean </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>ctrso</td> <td> array[<a href="#/definitions/CtrsoDTO">CtrsoDTO</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>centreExploitation</td> <td> <a href="#/definitions/CentreExploitationDTO">CentreExploitationDTO</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>ro</td> <td> <a href="#/definitions/RoDTO">RoDTO</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>grds</td> <td> array[<a href="#/definitions/GrdDTO">GrdDTO</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/GrdDTO">GrdDTO</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>nom</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>functionalId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/MarketAgreement">MarketAgreement</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>type</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>mrid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/MarketDocument">MarketDocument</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>mrid</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>revisionNumber</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/MultipleScheduleMarketDocument">MultipleScheduleMarketDocument</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>mrid</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>revisionNumber</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>type</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>processProcessType</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>senderMarketParticipantMRID</td> <td> <a href="#/definitions/PartyIDString">PartyIDString</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>senderMarketParticipantMarketRoleType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>receiverMarketParticipantMRID</td> <td> <a href="#/definitions/PartyIDString">PartyIDString</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>receiverMarketParticipantMarketRoleType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>createdDateTime</td> <td> string (date-time) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>schedulePeriodTimeInterval</td> <td> <a href="#/definitions/ESMPDateTimeInterval">ESMPDateTimeInterval</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>domainMRID</td> <td> <a href="#/definitions/AreaIDString">AreaIDString</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>relatedMarketDocument</td> <td> array[<a href="#/definitions/MarketDocument">MarketDocument</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>subjectMarketParticipantMRID</td> <td> <a href="#/definitions/PartyIDString">PartyIDString</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>subjectMarketParticipantMarketRoleType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>resourceScheduleTimeSeries</td> <td> array[<a href="#/definitions/ResourceScheduleSeries">ResourceScheduleSeries</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>reason</td> <td> array[<a href="#/definitions/Reason">Reason</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/OrderDTO">OrderDTO</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>mrid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>orderGroupMrid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>resourceProviderMarket</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>resourceProviderMarketCodingScheme</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>businessType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>acquiringDomain</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>acquiringDomainCodingScheme</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>connectingDomain</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>connectingDomainCodingScheme</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>measurementUnit</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>flowDirection</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>marketObjectStatus</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>registeredResourceCodingScheme</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>startDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>endDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>resolution</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>status</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>points</td> <td> array[number] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>rejectionCause</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>availabilityDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>consultationLimitDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>consultationDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>validationLimitDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>validationDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pmLimitDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pmDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pmCause</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pmCauseText</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>edp</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>eda</td> <td> <a href="#/definitions/EdaDTO">EdaDTO</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/OrderGroupDTO">OrderGroupDTO</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>mrid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>revisionNumber</td> <td> integer (int32) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>type</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>processType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>senderMarket</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>senderMarketCodingScheme</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>senderMarketRole</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>receiverMarket</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>receiverMarketCodingScheme</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>receiverMarketRole</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>creationDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>startDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>endDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>orders</td> <td> array[<a href="#/definitions/OrderDTO">OrderDTO</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>ro</td> <td> <a href="#/definitions/RoDTO">RoDTO</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/PartyIDString">PartyIDString</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>value</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>codingScheme</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/Point">Point</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>position</td> <td> integer (int32) </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>quantity</td> <td> number </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>reason</td> <td> array[<a href="#/definitions/Reason">Reason</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/QName">QName</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>namespaceURI</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>localPart</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>prefix</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/Reason">Reason</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>code</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>text</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/ResourceIDString">ResourceIDString</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>value</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>codingScheme</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/ResourceMarketParticipant">ResourceMarketParticipant</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>mrid</td> <td> <a href="#/definitions/PartyIDString">PartyIDString</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>marketRoleType</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/ResourceScheduleSeries">ResourceScheduleSeries</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>mrid</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>version</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>businessType</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>connectingDomainMRID</td> <td> <a href="#/definitions/AreaIDString">AreaIDString</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>registeredResourceMRID</td> <td> <a href="#/definitions/ResourceIDString">ResourceIDString</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>acquiringDomainMRID</td> <td> <a href="#/definitions/AreaIDString">AreaIDString</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>marketObjectStatusStatus</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>objectAggregation</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>marketParticipant</td> <td> array[<a href="#/definitions/ResourceMarketParticipant">ResourceMarketParticipant</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>marketAgreement</td> <td> array[<a href="#/definitions/MarketAgreement">MarketAgreement</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>gateDateAndOrTimeDateTime</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>series</td> <td> array[<a href="#/definitions/Series">Series</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>reason</td> <td> array[<a href="#/definitions/Reason">Reason</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/RoDTO">RoDTO</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>functionalId</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>name</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>emailContacts</td> <td> array[string] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>smsContacts</td> <td> array[string] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/Series">Series</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>mrid</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>businessType</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>flowDirectionDirection</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>product</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>measurementUnitName</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>curveType</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>marketParticipant</td> <td> array[<a href="#/definitions/ResourceMarketParticipant">ResourceMarketParticipant</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>seriesPeriod</td> <td> array[<a href="#/definitions/SeriesPeriod">SeriesPeriod</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>reason</td> <td> array[<a href="#/definitions/Reason">Reason</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/SeriesPeriod">SeriesPeriod</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>timeInterval</td> <td> <a href="#/definitions/ESMPDateTimeInterval">ESMPDateTimeInterval</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>resolution</td> <td> <a href="#/definitions/Duration">Duration</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>point</td> <td> array[<a href="#/definitions/Point">Point</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/SpecificOrderDTO">SpecificOrderDTO</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>mrid</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>status</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>validationDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pmLimitDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pmDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pmCause</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pmCauseText</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>edp</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>startDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>endDate</td> <td> string (date-time) </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>eda</td> <td> <a href="#/definitions/EdaDTO">EdaDTO</a> </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>pm</td> <td> boolean </td> <td>optional</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/TimePeriod">TimePeriod</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>timeInterval</td> <td> <a href="#/definitions/ESMPDateTimeInterval">ESMPDateTimeInterval</a> </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>reason</td> <td> array[<a href="#/definitions/Reason">Reason</a>] </td> <td>required</td> <td>-</td> <td></td> </tr> </table> ## <a name="/definitions/TimeSeries">TimeSeries</a> <table border="1"> <tr> <th>name</th> <th>type</th> <th>required</th> <th>description</th> <th>example</th> </tr> <tr> <td>mrid</td> <td> string </td> <td>required</td> <td>-</td> <td></td> </tr> <tr> <td>version</td> <td> string </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>inErrorPeriod</td> <td> array[<a href="#/definitions/TimePeriod">TimePeriod</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> <tr> <td>reason</td> <td> array[<a href="#/definitions/Reason">Reason</a>] </td> <td>optional</td> <td>-</td> <td></td> </tr> </table>