{"swagger":"2.0","info":{"description":"The Shipper REST API provides an easy way to get important booking information. More features will follow. ","version":"2.0.0","title":"PRISMA SHIPPER REST API","contact":{"name":"helpdesk@prisma-capacity.eu"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"basePath":"/api/v2","tags":[{"name":"Auction booking"},{"name":"Auction calendar"},{"name":"Auction"},{"name":"Balancing group"},{"name":"Bid"},{"name":"Secondary booking"},{"name":"FCFS booking"},{"name":"Market area"},{"name":"Network point"},{"name":"Portfolio code"},{"name":"Transport FCFS v2"},{"name":"TSO"}],"paths":{"/auction-booking":{"get":{"tags":["Auction booking"],"summary":"Returns successful auction bookings of your company (Reconciliation API)","description":"","operationId":"getAuctionBookings","produces":["application/json"],"parameters":[{"name":"auctionId","in":"query","description":"Id of auction which bookings need to be fetched","required":false,"type":"integer","format":"int64"},{"name":"bookedAt","in":"query","description":"Date of booking (Example = '2017-06-14')","required":false,"type":"string"},{"name":"bookedSince","in":"query","description":"Date and time in UTC prior to booking date (Example = '2017-06-14T06:30:00.000Z')","required":false,"type":"string","format":"date-time"},{"name":"bookedBefore","in":"query","description":"Date and time in UTC after booking date (Example = '2017-06-14T06:30:00.000Z')","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"Successful retrieval of auction booking","schema":{"type":"array","items":{"$ref":"#/definitions/AuctionBookingDto"}}},"401":{"description":"No valid token added to authorization header"}},"security":[{"jwt":[]}]}},"/auction-booking/getAuctionBookingsSupportingMultipleConversions":{"get":{"tags":["Auction booking"],"summary":"Returns successful auction bookings of your company supporting multiple conversions (Reconciliation API)","description":"","operationId":"getAuctionBookingsSupportingMultipleConversions","produces":["application/json"],"parameters":[{"name":"auctionId","in":"query","description":"Id of auction which bookings need to be fetched","required":false,"type":"integer","format":"int64"},{"name":"bookedAt","in":"query","description":"Date of booking (Example = '2017-06-14')","required":false,"type":"string"},{"name":"bookedSince","in":"query","description":"Date and time in UTC prior to booking date (Example = '2017-06-14T06:30:00.000Z')","required":false,"type":"string","format":"date-time"},{"name":"bookedBefore","in":"query","description":"Date and time in UTC after booking date (Example = '2017-06-14T06:30:00.000Z')","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"Successful retrieval of auction booking","schema":{"type":"array","items":{"$ref":"#/definitions/AuctionBookingDto"}}},"401":{"description":"No valid token added to authorization header"}},"security":[{"jwt":[]}]}},"/auction-calendar":{"get":{"tags":["Auction calendar"],"summary":"Retrieve a list of auction calendars. (Analyst API)","description":"","operationId":"getAuctionCalendars","produces":["application/json"],"parameters":[{"name":"periodType","in":"query","description":"Period type","required":false,"type":"string","enum":["YEAR","REST_OF_YEAR","QUARTER","MONTH","DAY","WITHINDAY","MULTIHOUR","HOUR"]}],"responses":{"200":{"description":"Successful retrieval of auction calendars.","schema":{"type":"array","items":{"$ref":"#/definitions/AuctionCalendarDto"},"uniqueItems":true}},"400":{"description":"No auction calendar was found."}},"security":[{"jwt":[]}]}},"/auction/{id}":{"get":{"tags":["Auction"],"summary":"Retrieve an auction by id. (Analyst API)","description":"","operationId":"getAuction","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Id of the auction","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Successful retrieval of the auction.","schema":{"$ref":"#/definitions/AuctionDetailDto"}},"400":{"description":"No auction found for given id."},"403":{"description":"You can't view the auction details as the state is not supported!"}},"security":[{"jwt":[]}]}},"/auction":{"get":{"tags":["Auction"],"summary":"Retrieve a list of auctions. (Analyst API)","description":"","operationId":"getAuctions","produces":["application/json"],"parameters":[{"name":"networkPointId","in":"query","description":"Network Point Reference Id","required":false,"type":"integer","format":"int64"},{"name":"periodType","in":"query","description":"Period type","required":false,"type":"string","enum":["YEAR","REST_OF_YEAR","QUARTER","MONTH","DAY","WITHINDAY","MULTIHOUR","HOUR"]},{"name":"contractRuntimeStart","in":"query","description":"Date and time in UTC before start of runtime (Example = '2019-06-14T04:00:00.000Z')","required":false,"type":"string","format":"date-time"},{"name":"contractRuntimeEnd","in":"query","description":"Date and time in UTC after end of runtime (Example = '2019-06-14T04:00:00.000Z')","required":false,"type":"string","format":"date-time"},{"name":"auctionedSince","in":"query","description":"Date and time in UTC before the auction opened (Example = '2019-06-14T04:00:00.000Z')","required":false,"type":"string","format":"date-time"},{"name":"auctionedBefore","in":"query","description":"Date and time in UTC after the auction opened (Example = '2019-06-14T04:00:00.000Z')","required":false,"type":"string","format":"date-time"},{"name":"state","in":"query","description":"Specify the auction state","required":false,"type":"string","enum":["PUBLISHED","OPEN","CLOSED","FINISHED","CANCELLED","TERMINATED","UNSUCCESSFUL"]},{"name":"offset","in":"query","description":"Pagination offset (>= 0)","required":false,"type":"integer","default":0,"format":"int32"},{"name":"limit","in":"query","description":"Pagination limit","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Successful retrieval of auctions.","schema":{"type":"array","items":{"$ref":"#/definitions/AuctionDto"},"uniqueItems":true}},"400":{"description":"No auctions were found."},"429":{"description":"Rate limit exceeded."}},"security":[{"jwt":[]}]}},"/balancing-group":{"get":{"tags":["Balancing group"],"summary":"Returns a list of balancing groups (Trader API)","description":"","operationId":"getBalancingGroups","produces":["application/json"],"parameters":[{"name":"auctionId","in":"query","description":"id of the auction for which selectable balancing groups should be fetched","required":false,"type":"integer","format":"int64"},{"name":"direction","in":"query","description":"direction for which the balancing groups should be fetched.","required":false,"type":"string","enum":["ENTRY","EXIT"]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/BalancingGroupDto"}}},"400":{"description":"wrong direction"},"404":{"description":"auction not found"}},"security":[{"jwt":[]}]}},"/bid/live":{"get":{"tags":["Bid"],"summary":"Returns all live bids from short and long term auctions of the logged in customer (Trader API)","description":"","operationId":"getLiveBids","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/MultipleConversionBidDto"}}},"401":{"description":"no valid token added to authorization header"}},"security":[{"jwt":[]}]}},"/bid":{"get":{"tags":["Bid"],"summary":"Returns bids of an auction (Trader API)","description":"","operationId":"getBidsOfAuction","produces":["application/json"],"parameters":[{"name":"auctionId","in":"query","description":"Id of the auction","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/BidDto"}}},"404":{"description":"bid not found"},"401":{"description":"no valid token added to authorization header"}},"security":[{"jwt":[]}]},"post":{"tags":["Bid"],"summary":"Bids on an short-term auction or bids on the first round of a long-term auction (Trader API)","description":"","operationId":"submitBid_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/BidDto"}}],"responses":{"201":{"description":"successful operation","schema":{"$ref":"#/definitions/BidDto"}},"400":{"description":"validation error"},"404":{"description":"Auction, User, BalancingGroup or PortfolioCode not found"},"401":{"description":"no valid token added to authorization header"}},"security":[{"jwt":[]}]}},"/bid/{id}":{"get":{"tags":["Bid"],"summary":"Returns a bid (Trader API)","description":"","operationId":"getBid","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Id of the bid","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BidDto"}},"404":{"description":"bid not found"},"401":{"description":"no valid token added to authorization header"}},"security":[{"jwt":[]}]},"put":{"tags":["Bid"],"summary":"Updates a bid. This can also be used to update the quantity of your bid for later auction rounds. (Trader API)","description":"","operationId":"updateBid","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Id of the bid","required":true,"type":"integer","format":"int64"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/BidDto"}}],"responses":{"400":{"description":"validation error"},"404":{"description":"Bid, Auction, User, BalancingGroup or PortfolioCode not found"},"401":{"description":"no valid token added to authorization header"}},"security":[{"jwt":[]}]},"delete":{"tags":["Bid"],"summary":"Deletes a bid (Trader API)","description":"","operationId":"deleteBid","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"}],"responses":{"204":{"description":"successful operation"},"404":{"description":"bid not found"},"401":{"description":"no valid token added to authorization header"}},"security":[{"jwt":[]}]}},"/bid/getBidsSupportingMultipleConversions/{id}":{"get":{"tags":["Bid"],"summary":"Returns a bid (Trader API)","description":"","operationId":"getBidSupportingMultipleConversions","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Id of the bid","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MultipleConversionBidDto"}},"404":{"description":"bid not found"},"401":{"description":"no valid token added to authorization header"}},"security":[{"jwt":[]}]}},"/bid/getBidsSupportingMultipleConversionsOfAuction":{"get":{"tags":["Bid"],"summary":"Returns bids of an auction (Trader API)","description":"","operationId":"getBidsSupportingMultipleConversionsOfAuction","produces":["application/json"],"parameters":[{"name":"auctionId","in":"query","description":"Id of the auction","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/MultipleConversionBidDto"}}},"404":{"description":"bid not found"},"401":{"description":"no valid token added to authorization header"}},"security":[{"jwt":[]}]}},"/bid/submitBidWithMultipleConversions":{"post":{"tags":["Bid"],"summary":"Bids on an short-term auction or bids on the first round of a long-term auction with multiple conversions possible (Trader API)","description":"","operationId":"submitBid","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MultipleConversionBidDto"}}],"responses":{"201":{"description":"successful operation","schema":{"$ref":"#/definitions/MultipleConversionBidDto"}},"400":{"description":"validation error"},"404":{"description":"Auction, User, BalancingGroup or PortfolioCode not found"},"401":{"description":"no valid token added to authorization header"}},"security":[{"jwt":[]}]}},"/bid/updateBidWithMultipleConversions/{id}":{"put":{"tags":["Bid"],"summary":"Updates a bid. This can also be used to update the quantity of your bid for later auction rounds. (Trader API)","description":"","operationId":"updateBidWithMultipleConversions","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Id of the bid","required":true,"type":"integer","format":"int64"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MultipleConversionBidDto"}}],"responses":{"400":{"description":"validation error"},"404":{"description":"Bid, Auction, User, BalancingGroup or PortfolioCode not found"},"401":{"description":"no valid token added to authorization header"}},"security":[{"jwt":[]}]}},"/confirmed-secondary-trade":{"get":{"tags":["Secondary booking"],"summary":"Returns successful initiated and responded secondary trades of your company (Reconciliation API)","description":"","operationId":"getConfirmedSecondaryTrades","produces":["application/json"],"parameters":[{"name":"proposalId","in":"query","description":"Id of proposal which trades need to be fetched","required":false,"type":"integer","format":"int64"},{"name":"runtimeStart","in":"query","description":"Date and time in UTC before start of runtime (Example = '2017-06-14T06:30:00.000Z')","required":false,"type":"string","format":"date-time"},{"name":"runtimeEnd","in":"query","description":"Date and time in UTC after end of runtime (Example = '2017-06-14T06:30:00.000Z')","required":false,"type":"string","format":"date-time"},{"name":"bookedSince","in":"query","description":"Date and time in UTC prior to booking date (Example = ‘2017-06-14T06:30:00.000Z’)","required":false,"type":"string","format":"date-time"},{"name":"bookedBefore","in":"query","description":"Date and time in UTC after booking date (Example = ‘2017-06-14T06:30:00.000Z’)","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"Successful retrieval of secondary trades","schema":{"type":"array","items":{"$ref":"#/definitions/SecondaryTradeDto"}}},"401":{"description":"No valid token added to authorization header"}},"security":[{"jwt":[]}]}},"/confirmed-secondary-trade/{tradeId}":{"get":{"tags":["Secondary booking"],"summary":"Returns a successful initiated and responded secondary trade of your company (Reconciliation API)","description":"","operationId":"getConfirmedSecondaryTrade","produces":["application/json"],"parameters":[{"name":"tradeId","in":"path","description":"Id of trade which needs to be fetched","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Successful retrieval of secondary trade","schema":{"$ref":"#/definitions/SecondaryTradeDto"}},"401":{"description":"No valid token added to authorization header"}},"security":[{"jwt":[]}]}},"/fcfs-booking":{"get":{"tags":["FCFS booking"],"summary":"Returns successful FCFS bookings of your company (Reconciliation API)","description":"","operationId":"getFcfsBookings","produces":["application/json"],"parameters":[{"name":"dealId","in":"query","description":"dealId of booking which needs to be fetched","required":false,"type":"integer","format":"int64"},{"name":"runtimeStart","in":"query","description":"Date and time in UTC before start of runtime (Example = '2017-06-14T06:30:00.000Z')","required":false,"type":"string","format":"date-time"},{"name":"runtimeEnd","in":"query","description":"Date and time in UTC after end of runtime (Example = '2017-06-14T06:30:00.000Z')","required":false,"type":"string","format":"date-time"},{"name":"bookedSince","in":"query","description":"Date and time in UTC prior to booking date (Example = '2017-06-14T06:30:00.000Z')","required":false,"type":"string","format":"date-time"},{"name":"bookedBefore","in":"query","description":"Date and time in UTC after booking date (Example = '2017-06-14T06:30:00.000Z')","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"Successful retrieval of FCFS booking","schema":{"type":"array","items":{"$ref":"#/definitions/FcfsBookingDto"}}},"401":{"description":"No valid token added to authorization header"}},"security":[{"jwt":[]}]}},"/fcfs-booking/regular/book-capacity":{"post":{"tags":["FCFS booking"],"summary":"Regular FCFS: Book capacity (Reconciliation + FCFS API)","description":"","operationId":"regularFcfsBookCapacity","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/RegularFcfsBookCapacityRequest"}}],"responses":{"204":{"description":"Successful"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions"}},"security":[{"jwt":[]}]}},"/fcfs-booking/regular/fcfs-process-state/{bookingProcessId}":{"get":{"tags":["FCFS booking"],"summary":"Regular FCFS: Check FCFS Process State (Reconciliation + FCFS API)","description":"","operationId":"regularFcfsProcessState","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"bookingProcessId","in":"path","description":"The ID of the booking process","required":true,"type":"string","format":"uuid"},{"name":"shipperUserEmail","in":"query","description":"The email of the shipper user who is performing the request","required":true,"type":"string"}],"responses":{"200":{"description":"Successful","schema":{"$ref":"#/definitions/RegularFcfsBookingProcessStateResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions"}},"security":[{"jwt":[]}]}},"/fcfs-booking/direct/request-offer":{"post":{"tags":["FCFS booking"],"summary":"Direct FCFS: Request an offer for a specific product (Reconciliation + FCFS API)","description":"","operationId":"directFcfsRequestOffer","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DirectFcfsOfferRequest"}}],"responses":{"200":{"description":"Successful","schema":{"$ref":"#/definitions/DirectFcfsOfferResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions"}},"security":[{"jwt":[]}]}},"/fcfs-booking/direct/booking":{"post":{"tags":["FCFS booking"],"summary":"Direct FCFS: Booking request for a specific product  (Reconciliation + FCFS API)","description":"","operationId":"directFcfsBookingRequest","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/DirectFcfsBookingRequest"}}],"responses":{"200":{"description":"Successful","schema":{"$ref":"#/definitions/DirectFcfsBookingResponse"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions"}},"security":[{"jwt":[]}]}},"/fcfs-booking/direct/bookings":{"get":{"tags":["FCFS booking"],"summary":"Get Direct FCFS Bookings (Reconciliation + FCFS API)","description":"","operationId":"directFcfsBookings","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"shipperUserEmail","in":"query","description":"The email of the shipper user who is performing the request","required":true,"type":"string"},{"name":"requestIdentifier","in":"query","description":"The ID of the request identifier","required":false,"type":"string"},{"name":"networkPointId","in":"query","description":"The ID of the network point","required":false,"type":"integer","format":"int64"},{"name":"tsoId","in":"query","description":"The ID of the TSO","required":false,"type":"integer","format":"int64"},{"name":"productType","in":"query","description":"Product type","required":false,"type":"string","enum":["DAILY","WEEKLY_WORKING_DAYS","WEEKLY","WEEKLY_SAT_FRI","WEEKEND","MONTHLY","QUARTERLY","CALENDAR_YEARLY","YEARLY","WID"]},{"name":"requestedFrom","in":"query","description":"Requested from date in UTC (Example = '2024-06-14T06:00:00.000Z')","required":false,"type":"string","format":"date-time"},{"name":"requestedTo","in":"query","description":"Requested to date in UTC (Example = '2024-06-15T06:00:00.000Z')","required":false,"type":"string","format":"date-time"},{"name":"runtimeValidAt","in":"query","description":"Runtime valid at date in UTC (Example = '2024-06-15T06:00:00.000Z')","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"Successful","schema":{"type":"array","items":{"$ref":"#/definitions/DirectFcfsBookingsResponse"}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions"}},"security":[{"jwt":[]}]}},"/fcfs-booking/direct/available-products":{"get":{"tags":["FCFS booking"],"summary":"Get Direct FCFS available products (Reconciliation + FCFS API)","description":"","operationId":"directFcfsAvailableProducts","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"shipperUserEmail","in":"query","description":"The email of the shipper user who is performing the request","required":true,"type":"string"},{"name":"networkPointId","in":"query","description":"The ID of the network point","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Successful","schema":{"type":"array","items":{"$ref":"#/definitions/DirectFcfsAvailableProductsResponse"}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions"}},"security":[{"jwt":[]}]}},"/fcfs-booking/regular/check-availability":{"post":{"tags":["FCFS booking"],"summary":"Regular FCFS: Check availability (Reconciliation + FCFS API)","description":"","operationId":"regularFcfsCheckAvailability","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/RegularFcfsAvailabilityCheckRequest"}}],"responses":{"200":{"description":"Successful: Returns the bookingProcessId","examples":{"":"0c090dc0-0eee-42de-b7b0-7780137bc23b"},"schema":{"type":"string"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions"}},"security":[{"jwt":[]}]}},"/market-area":{"get":{"tags":["Market area"],"summary":"Returns a list of all market areas (Analyst API)","description":"","operationId":"getAllMarketAreas","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"Successful retrieval of market areas","schema":{"type":"array","items":{"$ref":"#/definitions/MarketAreaDto"}}},"400":{"description":"Unable to retrieve market areas."}},"security":[{"jwt":[]}]}},"/network-point":{"get":{"tags":["Network point"],"summary":"Retrieve a list of network points. (Analyst API)","description":"","operationId":"getNetworkPoints","produces":["application/json"],"parameters":[{"name":"marketAreaIds","in":"query","description":"Id(s) of the market area(s) to be searched for. When selecting BUNDLE direction, also child network points (ENTRY/EXIT) for the given market area(s) are included. The bundle point itself may not be in the given market area(s)","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"name":"connectionPointType","in":"query","description":"Preferred connection point type. When selecting BUNDLE direction, also child network points (ENTRY/EXIT) for the given type will be included. The bundle point itself may not be of given type.","required":false,"type":"string","enum":["MARKET_TRANSITION_POINT","BORDER_TRANSITION_POINT","RESERVOIR","GRID_ACCESS_POINT","PRODUCTION","BIOGAS_ENTRY","OTHER_NETWORK_POINT"]},{"name":"direction","in":"query","description":"Directions","required":false,"type":"array","items":{"type":"string","enum":["ENTRY","EXIT","BUNDLE"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"Successful retrieval of network points.","schema":{"type":"array","items":{"$ref":"#/definitions/NetworkPointDto"},"uniqueItems":true}},"400":{"description":"No network points were found."}},"security":[{"jwt":[]}]}},"/network-point/{id}":{"get":{"tags":["Network point"],"summary":"Retrieve a network point by id. (Analyst API)","description":"","operationId":"getNetworkPoint","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Id of the network point","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Successful retrieval of network point.","schema":{"$ref":"#/definitions/NetworkPointDetailDto"}},"404":{"description":"No network point found for given id."}},"security":[{"jwt":[]}]}},"/portfolio-code/{id}":{"get":{"tags":["Portfolio code"],"summary":"Returns a portfolio code (Trader API)","description":"","operationId":"getPortfolioCode","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"id of portfolio code","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/PortfolioCodeDto"}},"404":{"description":"portfolio code not found"}},"security":[{"jwt":[]}]}},"/portfolio-code":{"get":{"tags":["Portfolio code"],"summary":"Returns a list of portfolio codes (Trader API)","description":"","operationId":"getPortfolioCodes","produces":["application/json"],"parameters":[{"name":"auctionId","in":"query","description":"id of the auction for which selectable portfolio codes should be fetched","required":false,"type":"integer","format":"int64"},{"name":"direction","in":"query","description":"direction for which the portfolio codes should be fetched.","required":false,"type":"string","enum":["ENTRY","EXIT"]}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/PortfolioCodeDto"}}},"400":{"description":"wrong direction"},"404":{"description":"auction not found"}},"security":[{"jwt":[]}]}},"/transport-fcfs/request-capacity":{"post":{"tags":["Transport FCFS v2"],"summary":"Transport FCFS Shipper: Request capacity for a specific product (Reconciliation + FCFS API)","description":"","operationId":"regularFcfsRequestCapacity","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/RegularFcfsRequestCapacityRequest"}}],"responses":{"204":{"description":"Successful: Returns the bookingId"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions"}},"security":[{"jwt":[]}]}},"/transport-fcfs/state/{bookingId}":{"get":{"tags":["Transport FCFS v2"],"summary":"Transport FCFS Shipper: Get booking state (Reconciliation + FCFS API)","description":"","operationId":"regularFcfsBookingState","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"bookingId","in":"path","description":"Booking Id","required":true,"type":"string","format":"uuid"},{"name":"networkPointId","in":"query","description":"Network Point Id","required":true,"type":"string","format":"uuid"}],"responses":{"204":{"description":"Successful: Returns the booking details"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions"}},"security":[{"jwt":[]}]}},"/transport-fcfs/network-points":{"get":{"tags":["Transport FCFS v2"],"summary":"Transport FCFS Shipper: Get network points (Reconciliation + FCFS API)","description":"","operationId":"regularFcfsNetworkPoints","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"query","in":"query","description":"query","required":true,"type":"string"}],"responses":{"204":{"description":"Successful: Returns the list of network points"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions"}},"security":[{"jwt":[]}]}},"/transport-fcfs/network-point/{networkPointId}":{"get":{"tags":["Transport FCFS v2"],"summary":"Transport FCFS Shipper: Get network point details (Reconciliation + FCFS API)","description":"","operationId":"regularFcfsNetworkPointDetails","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"networkPointId","in":"path","description":"Network Point Id","required":true,"type":"string","format":"uuid","x-example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}],"responses":{"204":{"description":"Successful: Returns the network point details"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions"}},"security":[{"jwt":[]}]}},"/transport-fcfs/bookings":{"get":{"tags":["Transport FCFS v2"],"summary":"Transport FCFS Shipper: Get bookings (Reconciliation + FCFS API)","description":"","operationId":"regularFcfsGetBookings","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"assignedBookingId","in":"query","description":"The assigned booking ID","required":false,"type":"string"},{"name":"networkPointId","in":"query","description":"The ID of the network point","required":false,"type":"string","format":"uuid"},{"name":"operatorId","in":"query","description":"The ID of the operator","required":false,"type":"string","format":"uuid"},{"name":"runtimeType","in":"query","description":"Runtime Type","required":false,"type":"array","items":{"type":"string","enum":["WEEKLY_WORKING_DAYS","WEEKLY","WEEKLY_SAT_FRI","WEEKEND","SEASON","BOM","WITHINDAY","CUSTOM","DAY","MONTH","QUARTER","GAS_YEAR","CALENDAR_YEAR","FULL_WITHINDAY","UNKNOWN"]},"collectionFormat":"multi"},{"name":"requestedFrom","in":"query","description":"Requested from date in UTC (Example = '2024-06-14T06:00:00.000Z')","required":false,"type":"string"},{"name":"requestedTo","in":"query","description":"Requested to date in UTC (Example = '2024-06-15T06:00:00.000Z')","required":false,"type":"string"},{"name":"runtimeValidAt","in":"query","description":"Runtime valid at date in UTC (Example = '2024-06-15T06:00:00.000Z')","required":false,"type":"string"},{"name":"limit","in":"query","required":false,"type":"integer","default":10,"format":"int32"},{"name":"offset","in":"query","required":false,"type":"integer","default":0,"format":"int32"}],"responses":{"204":{"description":"Successful: Returns a list of bookings"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions"}},"security":[{"jwt":[]}]}},"/transport-fcfs/book-capacity":{"post":{"tags":["Transport FCFS v2"],"summary":"Transport FCFS Shipper: Book capacity (Reconciliation + FCFS API)","description":"","operationId":"regularFcfsBookCapacity_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/RegularFcfsBookCapacityShipperRequest"}}],"responses":{"204":{"description":"Successful: Returns the bookingId"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient permissions"}},"security":[{"jwt":[]}]}},"/tso/{id}":{"get":{"tags":["TSO"],"summary":"Retrieve a TSO by id. (Analyst API)","description":"","operationId":"getTso","produces":["application/json"],"parameters":[{"name":"id","in":"path","description":"Id of the TSO","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Successful retrieval of TSO.","schema":{"$ref":"#/definitions/TsoDetailDto"}},"400":{"description":"No TSO found for given id or identification code."}},"security":[{"jwt":[]}]}},"/tso":{"get":{"tags":["TSO"],"summary":"Retrieve a list of TSOs which optionally can be filtered by its identification code which can either be DVGW or EIC. (Analyst API)","description":"","operationId":"getTsos","produces":["application/json"],"parameters":[{"name":"identificationCode","in":"query","description":"TSO EIC or DVGW identification code","required":false,"type":"string"}],"responses":{"200":{"description":"Successful retrieval of TSOs.","schema":{"type":"array","items":{"$ref":"#/definitions/TsoDto"},"uniqueItems":true}},"400":{"description":"No TSOs were found."}},"security":[{"jwt":[]}]}}},"securityDefinitions":{"jwt":{"description":"JSON Web Token (JWT)","type":"apiKey","name":"Authorization","in":"header"}},"definitions":{"AuctionBookingBundleInformationDto":{"type":"object","properties":{"splitFactor":{"$ref":"#/definitions/AuctionBookingSplitFactorDto"},"partialStartingPrice":{"type":"array","items":{"$ref":"#/definitions/ExchangeRatePriceDto"}},"partialSurcharge":{"type":"array","items":{"$ref":"#/definitions/ExchangeRatePriceDto"}},"totalContractShare":{"type":"array","items":{"$ref":"#/definitions/ExchangeRatePriceDto"}}}},"AuctionBookingDto":{"type":"object","properties":{"auctionId":{"type":"integer","format":"int64"},"bookingDate":{"type":"string","format":"date-time"},"dealId":{"type":"string"},"quantity":{"$ref":"#/definitions/QuantityDto"},"capacityCategory":{"type":"string","enum":["FZK","FZK_C","FZK_INC","B_FZK","B_FZK_C","B_FZK_1","BZK","U_BZK","U_KC","DZK","TVK","FIRM","FIRM_ADDITIONAL","INTERRUPTIBLE","INTERRUPTIBLE_LEVEL_1","INTERRUPTIBLE_LEVEL_2","INTERRUPTIBLE_LEVEL_N","BACKHAUL_CAPACITY","BACKHAUL_LEVEL_1","BACKHAUL_LEVEL_2","BACKHAUL_LEVEL_N","DZK_1","DZK_2","DZK_3","DZK_4","DZK_5","INCREMENTAL_OFFER_LEVEL_1","INCREMENTAL_OFFER_LEVEL_2","INCREMENTAL_OFFER_LEVEL_3","INCREMENTAL_OFFER_LEVEL_4","INCREMENTAL_OFFER_LEVEL_5","DZK_SH","IUKCF_1"]},"runtime":{"$ref":"#/definitions/DateInterval"},"periodType":{"type":"string","enum":["YEAR","REST_OF_YEAR","QUARTER","MONTH","DAY","WITHINDAY","MULTIHOUR","HOUR"]},"balancingGroup":{"$ref":"#/definitions/BalancingGroupMinimalDto"},"portfolioCode":{"$ref":"#/definitions/PortfolioCodeMinimalDto"},"marketArea":{"$ref":"#/definitions/MarketAreaDto"},"bundled":{"type":"boolean"},"undiscounted":{"type":"boolean"},"note":{"type":"string"},"networkPoint":{"$ref":"#/definitions/NetworkPointMinimalDto"},"tso":{"$ref":"#/definitions/TsoMinimalDto"},"shipper":{"$ref":"#/definitions/BookingShipperDto"},"bundleInformation":{"$ref":"#/definitions/AuctionBookingBundleInformationDto"},"upgrade":{"$ref":"#/definitions/BookingUpgradeDto"},"priceInformation":{"$ref":"#/definitions/AuctionBookingPriceInformationDto"},"conversion":{"$ref":"#/definitions/ConversionDto"}}},"AuctionBookingPriceInformationDto":{"type":"object","properties":{"auctionStartPrice":{"type":"array","items":{"$ref":"#/definitions/ExchangeRatePriceDto"}},"auctionSurcharge":{"type":"array","items":{"$ref":"#/definitions/ExchangeRatePriceDto"}},"auctionTotalPrice":{"type":"array","items":{"$ref":"#/definitions/ExchangeRatePriceDto"}},"charges":{"$ref":"#/definitions/AuctionChargesDto"}}},"AuctionBookingSplitFactorDto":{"type":"object","properties":{"entry":{"type":"string"},"exit":{"type":"string"},"type":{"type":"string","enum":["NONE","DEFINED","BASED_ON_REGULATED_CAPACITY_TARIFF_RELATION","TSO_RESPONSIBLE_FOR_SPLIT_FACTOR"]}}},"AuctionChargesDto":{"type":"object","properties":{"regulatedCapacityTariff":{"type":"array","items":{"$ref":"#/definitions/ExchangeRatePriceDto"}},"discountedCapacityTariff":{"type":"array","items":{"$ref":"#/definitions/ExchangeRatePriceDto"}},"measuringFee":{"type":"array","items":{"$ref":"#/definitions/ExchangeRatePriceDto"}},"biogasRedistributionLevy":{"type":"array","items":{"$ref":"#/definitions/ExchangeRatePriceDto"}},"neutralityCharge":{"type":"array","items":{"$ref":"#/definitions/ExchangeRatePriceDto"}},"commodityFee":{"type":"array","items":{"$ref":"#/definitions/ExchangeRatePriceDto"}},"measuringOperationsFee":{"type":"array","items":{"$ref":"#/definitions/ExchangeRatePriceDto"}},"billingFee":{"type":"array","items":{"$ref":"#/definitions/ExchangeRatePriceDto"}},"qualityConversionCharge":{"type":"array","items":{"$ref":"#/definitions/ExchangeRatePriceDto"}}}},"BalancingGroupMinimalDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"balancingGroupNumber":{"type":"string"},"href":{"type":"string"}}},"BookingShipperDto":{"type":"object","properties":{"name":{"type":"string"},"eic":{"type":"string"},"user":{"$ref":"#/definitions/BookingShipperUserDto"}}},"BookingShipperUserDto":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"}}},"BookingUpgradeDto":{"type":"object","properties":{"quantity":{"$ref":"#/definitions/QuantityDto"},"oldDealId":{"type":"integer","format":"int64"},"oldContractId":{"type":"string"},"oldBalancingGroup":{"type":"string"}}},"ConversionAmountDto":{"type":"object","required":["amount"],"properties":{"amount":{"description":"the converted amount mustn't be bigger than the amount of the auction","$ref":"#/definitions/QuantityDto"},"runtime":{"description":"only allowed if tso allows selection of runtimes for conversion","$ref":"#/definitions/DateInterval"}}},"ConversionDto":{"type":"object","required":["amountPerRuntime","direction"],"properties":{"contractId":{"type":"string","description":"Depending on the settings of the tso contractId might be required, optional or not applicable."},"balancingGroupId":{"type":"integer","format":"int64","description":"Depending on the settings of the tso balancingGroupId might be required, optional or not applicable."},"amountPerRuntime":{"type":"array","description":"Depending on the settings of the tso multiple values might be allowed. One amount is required. Defined runtimes have to be in the runtime of the auction. Runtimes mustn't overlap. If the tso does not allow a definition of a runtime,  the runtime field mustn't be used.","items":{"$ref":"#/definitions/ConversionAmountDto"}},"direction":{"type":"string","enum":["ENTRY","EXIT"]}}},"DateInterval":{"type":"object","properties":{"start":{"type":"string","format":"date-time","example":"2017-04-01T04:00:00.000Z","description":"must be before end"},"end":{"type":"string","format":"date-time","example":"2017-05-01T04:00:00.000Z","description":"must be after start"}}},"ExchangeRateDto":{"type":"object","properties":{"value":{"type":"string"},"unit":{"type":"string"},"time":{"type":"string","format":"date-time"}}},"ExchangeRatePriceDto":{"type":"object","properties":{"price":{"$ref":"#/definitions/PriceDto"},"exchangeRate":{"$ref":"#/definitions/ExchangeRateDto"}}},"MarketAreaDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"NetworkPointMinimalDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"identifier":{"type":"string"},"name":{"type":"string"},"direction":{"type":"string","enum":["ENTRY","EXIT","BUNDLE"]},"href":{"type":"string"}}},"PortfolioCodeMinimalDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"portfolioCodeId":{"type":"string"},"href":{"type":"string"}}},"PriceDto":{"type":"object","required":["unit","value"],"properties":{"value":{"type":"string","example":"0.00","description":"Value is cut off after 8 decimal places without rounding."},"unit":{"$ref":"#/definitions/PriceUnitDto"}}},"PriceUnitDto":{"type":"object","required":["currency","subunit"],"properties":{"currency":{"type":"string","example":"EUR","description":"three-character currency code (See https://www.iso.org/iso-4217-currency-codes.html)"},"subunit":{"type":"boolean","description":"whether the price is in the subunit of the currency (e.g. if subunit is 'true' for currency 'EUR', then the unit is CENT)"},"quantityUnit":{"type":"string","enum":["K_WH_H","K_WH_D","M3","M3_H"]},"priceRuntime":{"type":"string","example":"RUNTIME","enum":["HOUR","DAY","MONTH","QUARTER","YEAR","RUNTIME"]}}},"QuantityDto":{"type":"object","required":["unit","value"],"properties":{"value":{"type":"integer","format":"int64","example":1},"unit":{"type":"string","enum":["K_WH_H","K_WH_D","M3","M3_H"]}}},"TsoMinimalDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"eic":{"type":"string"},"href":{"type":"string"}}},"MultipleConversionsAuctionBookingDto":{"type":"object","properties":{"auctionId":{"type":"integer","format":"int64"},"bookingDate":{"type":"string","format":"date-time"},"dealId":{"type":"string"},"quantity":{"$ref":"#/definitions/QuantityDto"},"capacityCategory":{"type":"string","enum":["FZK","FZK_C","FZK_INC","B_FZK","B_FZK_C","B_FZK_1","BZK","U_BZK","U_KC","DZK","TVK","FIRM","FIRM_ADDITIONAL","INTERRUPTIBLE","INTERRUPTIBLE_LEVEL_1","INTERRUPTIBLE_LEVEL_2","INTERRUPTIBLE_LEVEL_N","BACKHAUL_CAPACITY","BACKHAUL_LEVEL_1","BACKHAUL_LEVEL_2","BACKHAUL_LEVEL_N","DZK_1","DZK_2","DZK_3","DZK_4","DZK_5","INCREMENTAL_OFFER_LEVEL_1","INCREMENTAL_OFFER_LEVEL_2","INCREMENTAL_OFFER_LEVEL_3","INCREMENTAL_OFFER_LEVEL_4","INCREMENTAL_OFFER_LEVEL_5","DZK_SH","IUKCF_1"]},"runtime":{"$ref":"#/definitions/DateInterval"},"periodType":{"type":"string","enum":["YEAR","REST_OF_YEAR","QUARTER","MONTH","DAY","WITHINDAY","MULTIHOUR","HOUR"]},"balancingGroup":{"$ref":"#/definitions/BalancingGroupMinimalDto"},"portfolioCode":{"$ref":"#/definitions/PortfolioCodeMinimalDto"},"marketArea":{"$ref":"#/definitions/MarketAreaDto"},"bundled":{"type":"boolean"},"undiscounted":{"type":"boolean"},"note":{"type":"string"},"networkPoint":{"$ref":"#/definitions/NetworkPointMinimalDto"},"tso":{"$ref":"#/definitions/TsoMinimalDto"},"shipper":{"$ref":"#/definitions/BookingShipperDto"},"bundleInformation":{"$ref":"#/definitions/AuctionBookingBundleInformationDto"},"upgrade":{"$ref":"#/definitions/BookingUpgradeDto"},"priceInformation":{"$ref":"#/definitions/AuctionBookingPriceInformationDto"},"conversions":{"type":"array","items":{"$ref":"#/definitions/ConversionDto"}}}},"AuctionCalendarDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"periodType":{"type":"string","enum":["YEAR","REST_OF_YEAR","QUARTER","MONTH","DAY","WITHINDAY","MULTIHOUR","HOUR"]},"publishDate":{"type":"string","format":"date-time"},"openingDate":{"type":"string","format":"date-time"},"productRuntime":{"$ref":"#/definitions/DateInterval"},"slot":{"type":"integer","format":"int32"},"revised":{"type":"boolean"},"calendarIdentifier":{"type":"string"}}},"AuctionDetailDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"periodType":{"type":"string","enum":["YEAR","REST_OF_YEAR","QUARTER","MONTH","DAY","WITHINDAY","MULTIHOUR","HOUR"]},"runtime":{"$ref":"#/definitions/DateInterval"},"state":{"type":"string","enum":["PREOPEN","PUBLISHED","OPEN","EVALUATING","CLOSED","ECONOMIC_TEST_PENDING","WAITING_FOR_EXTERNAL_ALLOCATION_RESULT","FINISHED","SKIPPED","CANCELLED","TERMINATED","UNSUCCESSFUL"]},"networkPoint":{"$ref":"#/definitions/NetworkPointMinimalDto"},"tsos":{"type":"array","items":{"$ref":"#/definitions/TsoMinimalDto"}},"marketableCapacity":{"$ref":"#/definitions/QuantityDto"},"marketedCapacity":{"$ref":"#/definitions/QuantityDto"},"capacityCategory":{"type":"string","enum":["FZK","FZK_C","FZK_INC","B_FZK","B_FZK_C","B_FZK_1","BZK","U_BZK","U_KC","DZK","TVK","FIRM","FIRM_ADDITIONAL","INTERRUPTIBLE","INTERRUPTIBLE_LEVEL_1","INTERRUPTIBLE_LEVEL_2","INTERRUPTIBLE_LEVEL_N","BACKHAUL_CAPACITY","BACKHAUL_LEVEL_1","BACKHAUL_LEVEL_2","BACKHAUL_LEVEL_N","DZK_1","DZK_2","DZK_3","DZK_4","DZK_5","INCREMENTAL_OFFER_LEVEL_1","INCREMENTAL_OFFER_LEVEL_2","INCREMENTAL_OFFER_LEVEL_3","INCREMENTAL_OFFER_LEVEL_4","INCREMENTAL_OFFER_LEVEL_5","DZK_SH","IUKCF_1"]},"entryCapacityCategory":{"type":"string","enum":["FZK","FZK_C","FZK_INC","B_FZK","B_FZK_C","B_FZK_1","BZK","U_BZK","U_KC","DZK","TVK","FIRM","FIRM_ADDITIONAL","INTERRUPTIBLE","INTERRUPTIBLE_LEVEL_1","INTERRUPTIBLE_LEVEL_2","INTERRUPTIBLE_LEVEL_N","BACKHAUL_CAPACITY","BACKHAUL_LEVEL_1","BACKHAUL_LEVEL_2","BACKHAUL_LEVEL_N","DZK_1","DZK_2","DZK_3","DZK_4","DZK_5","INCREMENTAL_OFFER_LEVEL_1","INCREMENTAL_OFFER_LEVEL_2","INCREMENTAL_OFFER_LEVEL_3","INCREMENTAL_OFFER_LEVEL_4","INCREMENTAL_OFFER_LEVEL_5","DZK_SH","IUKCF_1"]},"exitCapacityCategory":{"type":"string","enum":["FZK","FZK_C","FZK_INC","B_FZK","B_FZK_C","B_FZK_1","BZK","U_BZK","U_KC","DZK","TVK","FIRM","FIRM_ADDITIONAL","INTERRUPTIBLE","INTERRUPTIBLE_LEVEL_1","INTERRUPTIBLE_LEVEL_2","INTERRUPTIBLE_LEVEL_N","BACKHAUL_CAPACITY","BACKHAUL_LEVEL_1","BACKHAUL_LEVEL_2","BACKHAUL_LEVEL_N","DZK_1","DZK_2","DZK_3","DZK_4","DZK_5","INCREMENTAL_OFFER_LEVEL_1","INCREMENTAL_OFFER_LEVEL_2","INCREMENTAL_OFFER_LEVEL_3","INCREMENTAL_OFFER_LEVEL_4","INCREMENTAL_OFFER_LEVEL_5","DZK_SH","IUKCF_1"]},"entryStartingPrice":{"$ref":"#/definitions/PriceDto"},"exitStartingPrice":{"$ref":"#/definitions/PriceDto"},"entryCurrency":{"type":"string"},"exitCurrency":{"type":"string"},"entryCharges":{"$ref":"#/definitions/ChargesDto"},"exitCharges":{"$ref":"#/definitions/ChargesDto"},"entryAuctionNote":{"type":"string"},"exitAuctionNote":{"type":"string"},"largePriceStep":{"$ref":"#/definitions/PriceDto"},"smallPriceStep":{"$ref":"#/definitions/PriceDto"},"surcharge":{"$ref":"#/definitions/PriceDto"},"numberOfSmallPriceSteps":{"type":"integer","format":"int32"},"numberOfLargePriceSteps":{"type":"integer","format":"int32"},"competitions":{"type":"array","items":{"$ref":"#/definitions/CompetitionDto"}},"self":{"type":"string"},"auctionStart":{"type":"string","format":"date-time"},"auctionEnd":{"type":"string","format":"date-time"},"auctionPublished":{"type":"string","format":"date-time"},"auctionWindows":{"type":"array","items":{"$ref":"#/definitions/AuctionWindowDto"}}}},"AuctionWindowDto":{"type":"object","properties":{"windowSequenceNumber":{"$ref":"#/definitions/Number"},"roundNumber":{"type":"string"},"totalRequestedQuantity":{"$ref":"#/definitions/QuantityDto"},"windowAuctionSurcharge":{"$ref":"#/definitions/PriceDto"}}},"ChargesDto":{"type":"object","properties":{"regulatedTariff":{"$ref":"#/definitions/PriceDto"},"measurementCharge":{"$ref":"#/definitions/PriceDto"},"biogasCharge":{"$ref":"#/definitions/PriceDto"},"balancingCharge":{"$ref":"#/definitions/PriceDto"},"commodityFee":{"$ref":"#/definitions/PriceDto"},"operatingCharge":{"$ref":"#/definitions/PriceDto"},"accountingCharge":{"$ref":"#/definitions/PriceDto"},"gasQualityConversionCharge":{"$ref":"#/definitions/PriceDto"}}},"CompetitionDto":{"type":"object","properties":{"constraint":{"$ref":"#/definitions/QuantityDto"},"href":{"type":"string"}}},"Number":{"type":"object"},"AuctionDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"periodType":{"type":"string","enum":["YEAR","REST_OF_YEAR","QUARTER","MONTH","DAY","WITHINDAY","MULTIHOUR","HOUR"]},"runtime":{"$ref":"#/definitions/DateInterval"},"state":{"type":"string","enum":["PREOPEN","PUBLISHED","OPEN","EVALUATING","CLOSED","ECONOMIC_TEST_PENDING","WAITING_FOR_EXTERNAL_ALLOCATION_RESULT","FINISHED","SKIPPED","CANCELLED","TERMINATED","UNSUCCESSFUL"]},"networkPoint":{"$ref":"#/definitions/NetworkPointMinimalDto"},"tsos":{"type":"array","items":{"$ref":"#/definitions/TsoMinimalDto"}},"capacityCategory":{"type":"string","enum":["FZK","FZK_C","FZK_INC","B_FZK","B_FZK_C","B_FZK_1","BZK","U_BZK","U_KC","DZK","TVK","FIRM","FIRM_ADDITIONAL","INTERRUPTIBLE","INTERRUPTIBLE_LEVEL_1","INTERRUPTIBLE_LEVEL_2","INTERRUPTIBLE_LEVEL_N","BACKHAUL_CAPACITY","BACKHAUL_LEVEL_1","BACKHAUL_LEVEL_2","BACKHAUL_LEVEL_N","DZK_1","DZK_2","DZK_3","DZK_4","DZK_5","INCREMENTAL_OFFER_LEVEL_1","INCREMENTAL_OFFER_LEVEL_2","INCREMENTAL_OFFER_LEVEL_3","INCREMENTAL_OFFER_LEVEL_4","INCREMENTAL_OFFER_LEVEL_5","DZK_SH","IUKCF_1"]},"entryCapacityCategory":{"type":"string","enum":["FZK","FZK_C","FZK_INC","B_FZK","B_FZK_C","B_FZK_1","BZK","U_BZK","U_KC","DZK","TVK","FIRM","FIRM_ADDITIONAL","INTERRUPTIBLE","INTERRUPTIBLE_LEVEL_1","INTERRUPTIBLE_LEVEL_2","INTERRUPTIBLE_LEVEL_N","BACKHAUL_CAPACITY","BACKHAUL_LEVEL_1","BACKHAUL_LEVEL_2","BACKHAUL_LEVEL_N","DZK_1","DZK_2","DZK_3","DZK_4","DZK_5","INCREMENTAL_OFFER_LEVEL_1","INCREMENTAL_OFFER_LEVEL_2","INCREMENTAL_OFFER_LEVEL_3","INCREMENTAL_OFFER_LEVEL_4","INCREMENTAL_OFFER_LEVEL_5","DZK_SH","IUKCF_1"]},"exitCapacityCategory":{"type":"string","enum":["FZK","FZK_C","FZK_INC","B_FZK","B_FZK_C","B_FZK_1","BZK","U_BZK","U_KC","DZK","TVK","FIRM","FIRM_ADDITIONAL","INTERRUPTIBLE","INTERRUPTIBLE_LEVEL_1","INTERRUPTIBLE_LEVEL_2","INTERRUPTIBLE_LEVEL_N","BACKHAUL_CAPACITY","BACKHAUL_LEVEL_1","BACKHAUL_LEVEL_2","BACKHAUL_LEVEL_N","DZK_1","DZK_2","DZK_3","DZK_4","DZK_5","INCREMENTAL_OFFER_LEVEL_1","INCREMENTAL_OFFER_LEVEL_2","INCREMENTAL_OFFER_LEVEL_3","INCREMENTAL_OFFER_LEVEL_4","INCREMENTAL_OFFER_LEVEL_5","DZK_SH","IUKCF_1"]},"marketableCapacity":{"$ref":"#/definitions/QuantityDto"},"marketedCapacity":{"$ref":"#/definitions/QuantityDto"},"entryStartingPrice":{"$ref":"#/definitions/PriceDto"},"exitStartingPrice":{"$ref":"#/definitions/PriceDto"},"entryCurrency":{"type":"string","example":"EUR","description":"three-character currency code (See https://www.iso.org/iso-4217-currency-codes.html)"},"exitCurrency":{"type":"string","example":"EUR","description":"three-character currency code (See https://www.iso.org/iso-4217-currency-codes.html)"},"self":{"type":"string"},"competitions":{"type":"array","items":{"$ref":"#/definitions/CompetitionDto"}},"auctionStart":{"type":"string","format":"date-time"},"auctionEnd":{"type":"string","format":"date-time"},"auctionPublished":{"type":"string","format":"date-time"}}},"BalancingGroupDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"balancingGroupNumber":{"type":"string"},"gasType":{"type":"string","enum":["H_GAS","L_GAS"]},"validity":{"$ref":"#/definitions/DateInterval"},"undiscountedTariff":{"type":"boolean"},"capacityRestrictions":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["FZK","FZK_C","FZK_INC","B_FZK","B_FZK_C","B_FZK_1","BZK","U_BZK","U_KC","DZK","TVK","FIRM","FIRM_ADDITIONAL","INTERRUPTIBLE","INTERRUPTIBLE_LEVEL_1","INTERRUPTIBLE_LEVEL_2","INTERRUPTIBLE_LEVEL_N","BACKHAUL_CAPACITY","BACKHAUL_LEVEL_1","BACKHAUL_LEVEL_2","BACKHAUL_LEVEL_N","DZK_1","DZK_2","DZK_3","DZK_4","DZK_5","INCREMENTAL_OFFER_LEVEL_1","INCREMENTAL_OFFER_LEVEL_2","INCREMENTAL_OFFER_LEVEL_3","INCREMENTAL_OFFER_LEVEL_4","INCREMENTAL_OFFER_LEVEL_5","DZK_SH","IUKCF_1"]}}}},"MultipleConversionBidDto":{"type":"object","required":["auctionId","capacityQuantity","gtcAccepted","surcharge","userEmail"],"properties":{"id":{"type":"integer","format":"int64","description":"Must not be set on upload","readOnly":true},"auctionId":{"type":"integer","format":"int64"},"balancingGroupIdExit":{"type":"integer","format":"int64"},"portfolioCodeIdExit":{"type":"integer","format":"int64"},"balancingGroupIdEntry":{"type":"integer","format":"int64"},"portfolioCodeIdEntry":{"type":"integer","format":"int64"},"userEmail":{"type":"string"},"surcharge":{"$ref":"#/definitions/PriceDto"},"capacityQuantity":{"description":"Must be smaller or equal as the quantity of the auction. For long-term, the quantity on the curve must be monotonically decreasing.","$ref":"#/definitions/QuantityDto"},"minimumQuantity":{"description":"Required only for short-term, must be at least 1","$ref":"#/definitions/QuantityDto"},"bidRollover":{"type":"boolean"},"gtcAccepted":{"type":"boolean"},"upgradeExit":{"$ref":"#/definitions/UpgradeDto"},"upgradeEntry":{"$ref":"#/definitions/UpgradeDto"},"undiscountedTariff":{"type":"boolean"},"resultingDeal":{"description":"Must not be set on upload","readOnly":true,"$ref":"#/definitions/ResultingDealDto"},"biddingDate":{"type":"string","format":"date-time","description":"Must not be set on upload","readOnly":true},"submissionId":{"type":"string","format":"uuid"},"conversions":{"type":"array","items":{"$ref":"#/definitions/ConversionDto"}}}},"ResultingDealDto":{"type":"object","properties":{"dealId":{"type":"integer","format":"int64"},"allocatedQuantity":{"$ref":"#/definitions/QuantityDto"}}},"UpgradeDto":{"type":"object","required":["capacityAmount","contractId"],"properties":{"oldDealId":{"type":"integer","format":"int64"},"contractId":{"type":"string"},"capacityAmount":{"$ref":"#/definitions/QuantityDto"},"balancingGroupId":{"type":"integer","format":"int64"}}},"BidDto":{"type":"object","required":["auctionId","capacityQuantity","gtcAccepted","surcharge","userEmail"],"properties":{"id":{"type":"integer","format":"int64","description":"Must not be set on upload","readOnly":true},"auctionId":{"type":"integer","format":"int64"},"balancingGroupIdExit":{"type":"integer","format":"int64"},"portfolioCodeIdExit":{"type":"integer","format":"int64"},"balancingGroupIdEntry":{"type":"integer","format":"int64"},"portfolioCodeIdEntry":{"type":"integer","format":"int64"},"userEmail":{"type":"string"},"surcharge":{"$ref":"#/definitions/PriceDto"},"capacityQuantity":{"description":"Must be smaller or equal as the quantity of the auction. For long-term, the quantity on the curve must be monotonically decreasing.","$ref":"#/definitions/QuantityDto"},"minimumQuantity":{"description":"Required only for short-term, must be at least 1","$ref":"#/definitions/QuantityDto"},"bidRollover":{"type":"boolean"},"gtcAccepted":{"type":"boolean"},"upgradeExit":{"$ref":"#/definitions/UpgradeDto"},"upgradeEntry":{"$ref":"#/definitions/UpgradeDto"},"undiscountedTariff":{"type":"boolean"},"resultingDeal":{"description":"Must not be set on upload","readOnly":true,"$ref":"#/definitions/ResultingDealDto"},"biddingDate":{"type":"string","format":"date-time","description":"Must not be set on upload","readOnly":true},"conversion":{"$ref":"#/definitions/ConversionDto"}}},"SecondaryProposalDirectionInformationDto":{"type":"object","properties":{"capacityCategory":{"type":"string","enum":["FZK","FZK_C","FZK_INC","B_FZK","B_FZK_C","B_FZK_1","BZK","U_BZK","U_KC","DZK","TVK","FIRM","FIRM_ADDITIONAL","INTERRUPTIBLE","INTERRUPTIBLE_LEVEL_1","INTERRUPTIBLE_LEVEL_2","INTERRUPTIBLE_LEVEL_N","BACKHAUL_CAPACITY","BACKHAUL_LEVEL_1","BACKHAUL_LEVEL_2","BACKHAUL_LEVEL_N","DZK_1","DZK_2","DZK_3","DZK_4","DZK_5","INCREMENTAL_OFFER_LEVEL_1","INCREMENTAL_OFFER_LEVEL_2","INCREMENTAL_OFFER_LEVEL_3","INCREMENTAL_OFFER_LEVEL_4","INCREMENTAL_OFFER_LEVEL_5","DZK_SH","IUKCF_1"]},"tso":{"$ref":"#/definitions/TsoMinimalDto"},"direction":{"type":"string","enum":["ENTRY","EXIT","BUNDLE"]}}},"SecondaryProposalDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"runtime":{"$ref":"#/definitions/DateInterval"},"procedure":{"type":"string","enum":["CFO","FCFS","OTC"]},"type":{"type":"string","enum":["PROPOSAL_TO_BUY","PROPOSAL_TO_SELL"]},"quantity":{"$ref":"#/definitions/QuantityDto"},"price":{"$ref":"#/definitions/PriceDto"},"bundled":{"type":"boolean"},"tradingConditionsName":{"type":"string"},"transactionType":{"type":"string","enum":["ASSIGNMENT","TRANSFER_OF_USE"]},"comment":{"type":"string"},"otcCounterPartyEic":{"type":"string"},"balancingGroup":{"$ref":"#/definitions/BalancingGroupMinimalDto"},"portfolioCode":{"$ref":"#/definitions/PortfolioCodeMinimalDto"},"marketArea":{"$ref":"#/definitions/MarketAreaDto"},"networkPoint":{"$ref":"#/definitions/NetworkPointMinimalDto"},"initiatingCompanyName":{"type":"string"},"initiatingCompanyType":{"type":"string","enum":["SHIPPER","TSO"]},"exit":{"$ref":"#/definitions/SecondaryProposalDirectionInformationDto"},"entry":{"$ref":"#/definitions/SecondaryProposalDirectionInformationDto"}}},"SecondaryTradeDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"bookingDate":{"type":"string","format":"date-time"},"quantity":{"$ref":"#/definitions/QuantityDto"},"price":{"$ref":"#/definitions/PriceDto"},"runtime":{"$ref":"#/definitions/DateInterval"},"responseSubmittedAt":{"type":"string","format":"date-time"},"respondingCompanyName":{"type":"string"},"respondingCompanyType":{"type":"string","enum":["SHIPPER","TSO"]},"proposal":{"$ref":"#/definitions/SecondaryProposalDto"}}},"FcfsBookingDirectionInformationDto":{"type":"object","properties":{"contractId":{"type":"string"},"owner":{"type":"string"},"marketerTso":{"$ref":"#/definitions/TsoMinimalDto"},"capacityCategory":{"type":"string","enum":["FZK","FZK_C","FZK_INC","B_FZK","B_FZK_C","B_FZK_1","BZK","U_BZK","U_KC","DZK","TVK","FIRM","FIRM_ADDITIONAL","INTERRUPTIBLE","INTERRUPTIBLE_LEVEL_1","INTERRUPTIBLE_LEVEL_2","INTERRUPTIBLE_LEVEL_N","BACKHAUL_CAPACITY","BACKHAUL_LEVEL_1","BACKHAUL_LEVEL_2","BACKHAUL_LEVEL_N","DZK_1","DZK_2","DZK_3","DZK_4","DZK_5","INCREMENTAL_OFFER_LEVEL_1","INCREMENTAL_OFFER_LEVEL_2","INCREMENTAL_OFFER_LEVEL_3","INCREMENTAL_OFFER_LEVEL_4","INCREMENTAL_OFFER_LEVEL_5","DZK_SH","IUKCF_1"]},"balancingGroup":{"$ref":"#/definitions/BalancingGroupMinimalDto"},"portfolioCode":{"$ref":"#/definitions/PortfolioCodeMinimalDto"},"marketArea":{"$ref":"#/definitions/MarketAreaDto"},"undiscountedTariff":{"type":"boolean"},"charges":{"$ref":"#/definitions/FcfsChargesDto"},"upgrade":{"$ref":"#/definitions/BookingUpgradeDto"}}},"FcfsBookingDto":{"type":"object","properties":{"bookingDate":{"type":"string","format":"date-time"},"quantity":{"$ref":"#/definitions/QuantityDto"},"runtime":{"$ref":"#/definitions/DateInterval"},"dealId":{"type":"integer","format":"int64"},"bundled":{"type":"boolean"},"shipperLabel":{"type":"string"},"networkPoint":{"$ref":"#/definitions/NetworkPointMinimalDto"},"exit":{"$ref":"#/definitions/FcfsBookingDirectionInformationDto"},"entry":{"$ref":"#/definitions/FcfsBookingDirectionInformationDto"},"shipper":{"$ref":"#/definitions/BookingShipperDto"}}},"FcfsChargesDto":{"type":"object","properties":{"regulatedCapacityTariff":{"$ref":"#/definitions/PriceDto"},"measuringFee":{"$ref":"#/definitions/PriceDto"},"biogasRedistributionLevy":{"$ref":"#/definitions/PriceDto"},"neutralityCharge":{"$ref":"#/definitions/PriceDto"},"commodityFee":{"$ref":"#/definitions/PriceDto"},"measuringOperationsFee":{"$ref":"#/definitions/PriceDto"},"billingFee":{"$ref":"#/definitions/PriceDto"},"qualityConversionCharge":{"$ref":"#/definitions/PriceDto"},"totalCharge":{"$ref":"#/definitions/PriceDto"}}},"RegularFcfsBookCapacityRequest":{"type":"object","required":["alternativeId","bookingProcessId","networkPointId","shipperUserEmail"],"properties":{"shipperUserEmail":{"type":"string","description":"The user who is performing the request"},"networkPointId":{"type":"integer","format":"int64"},"bookingProcessId":{"type":"string","format":"uuid"},"alternativeId":{"type":"string","format":"uuid"},"shipperLabel":{"type":"string"},"balancingGroup":{"type":"string"},"portfolioCode":{"type":"string"},"upgrade":{"$ref":"#/definitions/Upgrade"}}},"Upgrade":{"type":"object","required":["maxQuantity"],"properties":{"maxQuantity":{"$ref":"#/definitions/FcfsQuantity"},"allocationId":{"type":"string","format":"uuid"},"contractId":{"type":"string"},"balancingGroup":{"type":"string"},"portfolioCode":{"type":"string"}}},"Alternative":{"type":"object","properties":{"alternativeId":{"type":"string","format":"uuid"},"parts":{"type":"array","items":{"$ref":"#/definitions/Offer"}}}},"BookCapacityResponse":{"type":"object","properties":{"contractId":{"type":"string"},"bookedCapacities":{"type":"array","items":{"$ref":"#/definitions/BookedCapacity"}}}},"BookedCapacity":{"type":"object","properties":{"assignedAllocationId":{"type":"string"},"capacity":{"$ref":"#/definitions/Capacity"}}},"Charge":{"type":"object","properties":{"type":{"type":"string","enum":["REGULATED","MEASUREMENT","BIOGAS","BALANCING","COMMODITY","OPERATING","ACCOUNTING","GAS_QUALITY_CONVERSION","AUCTION_SURCHARGE","TOTAL","BILLING"]},"price":{"$ref":"#/definitions/RegularFcfsPrice"}}},"FcfsRuntimeInterval":{"type":"object","required":["end","start"],"properties":{"start":{"type":"string","example":"2017-04-01T04:00:00.000Z","description":"must be before end"},"end":{"type":"string","example":"2017-05-01T04:00:00.000Z","description":"must be after start"}}},"Offer":{"type":"object","properties":{"offerId":{"type":"string","format":"uuid"},"assignedOfferId":{"type":"string"},"capacityCategory":{"type":"string","enum":["FZK","FZK_C","FZK_INC","B_FZK","B_FZK_C","B_FZK_1","BZK","U_BZK","U_KC","DZK","TVK","FIRM","FIRM_ADDITIONAL","INTERRUPTIBLE","INTERRUPTIBLE_LEVEL_1","INTERRUPTIBLE_LEVEL_2","INTERRUPTIBLE_LEVEL_N","BACKHAUL_CAPACITY","BACKHAUL_LEVEL_1","BACKHAUL_LEVEL_2","BACKHAUL_LEVEL_N","DZK_1","DZK_2","DZK_3","DZK_4","DZK_5","INCREMENTAL_OFFER_LEVEL_1","INCREMENTAL_OFFER_LEVEL_2","INCREMENTAL_OFFER_LEVEL_3","INCREMENTAL_OFFER_LEVEL_4","INCREMENTAL_OFFER_LEVEL_5","DZK_SH","IUKCF_1"]},"interval":{"$ref":"#/definitions/FcfsRuntimeInterval"},"quantity":{"$ref":"#/definitions/QuantityDto"},"charges":{"type":"array","items":{"$ref":"#/definitions/Charge"}}}},"RegularFcfsAvailabilityCheckRequestDto":{"type":"object","properties":{"runtimeType":{"type":"string","enum":["WITHINDAY","CUSTOM","DAY","MONTH","QUARTER","GAS_YEAR","CALENDAR_YEAR","FULL_WITHINDAY"]},"capacityCategory":{"type":"string","enum":["FZK","FZK_C","FZK_INC","B_FZK","B_FZK_C","B_FZK_1","BZK","U_BZK","U_KC","DZK","TVK","FIRM","FIRM_ADDITIONAL","INTERRUPTIBLE","INTERRUPTIBLE_LEVEL_1","INTERRUPTIBLE_LEVEL_2","INTERRUPTIBLE_LEVEL_N","BACKHAUL_CAPACITY","BACKHAUL_LEVEL_1","BACKHAUL_LEVEL_2","BACKHAUL_LEVEL_N","DZK_1","DZK_2","DZK_3","DZK_4","DZK_5","INCREMENTAL_OFFER_LEVEL_1","INCREMENTAL_OFFER_LEVEL_2","INCREMENTAL_OFFER_LEVEL_3","INCREMENTAL_OFFER_LEVEL_4","INCREMENTAL_OFFER_LEVEL_5","DZK_SH","IUKCF_1"]},"networkPointId":{"type":"integer","format":"int64"},"quantity":{"$ref":"#/definitions/QuantityDto"},"runtime":{"$ref":"#/definitions/FcfsRuntimeInterval"}}},"RegularFcfsAvailabilityCheckResponseDto":{"type":"object","properties":{"offerType":{"type":"string","enum":["CONFIRMED","MANUALLY_PROCESSED","ALTERNATIVES_OFFERED"]},"alternatives":{"type":"array","items":{"$ref":"#/definitions/Alternative"}}}},"RegularFcfsBookingProcessStateResponse":{"type":"object","properties":{"runtimeSettings":{"$ref":"#/definitions/RuntimeSettings"},"bookingProcessId":{"type":"string","format":"uuid"},"assignedBookingProcessId":{"type":"string"},"state":{"type":"string","enum":["STARTED","OFFERED","OFFER_CANCELLED","BOOKING_PENDING","MANUAL_PROCESSING","BOOKED","BOOKING_CANCELLED","ERROR"]},"createdBy":{"type":"string"},"createdAt":{"type":"string"},"availabilityCheckRequest":{"$ref":"#/definitions/RegularFcfsAvailabilityCheckRequestDto"},"availabilityCheckResponse":{"$ref":"#/definitions/RegularFcfsAvailabilityCheckResponseDto"},"bookingResponse":{"$ref":"#/definitions/BookCapacityResponse"},"errorMessage":{"type":"string"}}},"RegularFcfsPrice":{"type":"object","required":["value"],"properties":{"value":{"type":"string","example":"0.01"},"currency":{"type":"string"},"flowUnit":{"type":"string"},"timeUnit":{"type":"string"}}},"RegularFcfsPriceUnit":{"type":"object","properties":{"currency":{"type":"string"},"subUnit":{"type":"boolean","example":false},"flowUnit":{"type":"string","enum":["K_WH_H","K_WH_D","M3","M3_H"]},"timeUnit":{"type":"string","example":"RUNTIME","enum":["HOUR","DAY","MONTH","QUARTER","YEAR"]}}},"RuntimeSettings":{"type":"object","properties":{"balancingGroupConfig":{"type":"string"},"portfolioCodeConfig":{"type":"string"},"balancingGroups":{"type":"array","items":{"type":"string"}},"portfolioCodes":{"type":"array","items":{"type":"string"}},"upgradeSupported":{"type":"boolean"},"upgradableAllocations":{"type":"array","items":{"type":"string"}},"upgradeContractId":{"type":"string"}}},"DirectFcfsOfferResponse":{"type":"object","properties":{"networkPointId":{"type":"integer","format":"int64"},"productType":{"type":"string","enum":["DAILY","WEEKLY_WORKING_DAYS","WEEKLY","WEEKLY_SAT_FRI","WEEKEND","MONTHLY","QUARTERLY","CALENDAR_YEARLY","YEARLY","WID"]},"runtime":{"$ref":"#/definitions/FcfsRuntimePeriod"},"runtimeZoneId":{"type":"string"},"minimumRequestedCapacityAmount":{"$ref":"#/definitions/QuantityDto"},"requestedCapacityAmount":{"$ref":"#/definitions/QuantityDto"},"offeredCapacityAmount":{"$ref":"#/definitions/QuantityDto"},"totalPrice":{"$ref":"#/definitions/DirectFcfsPrice"},"peerTotalPrice":{"$ref":"#/definitions/DirectFcfsPrice"}}},"DirectFcfsPrice":{"type":"object","required":["value"],"properties":{"value":{"type":"number","format":"double","example":0.01},"unit":{"$ref":"#/definitions/DirectFcfsPriceUnit"}}},"DirectFcfsPriceUnit":{"type":"object","properties":{"currency":{"type":"string"},"subUnit":{"type":"boolean","example":false}}},"FcfsRuntimePeriod":{"type":"object","required":["from","to"],"properties":{"from":{"type":"string","example":"2017-04-01T04:00:00.000Z","description":"must be before end"},"to":{"type":"string","example":"2017-05-01T04:00:00.000Z","description":"must be after start"}}},"DirectFcfsOfferRequest":{"type":"object","required":["minimumRequestedCapacityAmount","networkPointId","productType","requestedCapacityAmount","runtime","shipperUserEmail"],"properties":{"networkPointId":{"type":"integer","format":"int64"},"shipperUserEmail":{"type":"string","description":"The user who is performing the request"},"productType":{"type":"string","enum":["DAILY","WEEKLY_WORKING_DAYS","WEEKLY","WEEKLY_SAT_FRI","WEEKEND","MONTHLY","QUARTERLY","CALENDAR_YEARLY","YEARLY","WID"]},"runtime":{"$ref":"#/definitions/FcfsRuntimePeriod"},"minimumRequestedCapacityAmount":{"example":"1","$ref":"#/definitions/QuantityDto"},"requestedCapacityAmount":{"example":"1","$ref":"#/definitions/QuantityDto"}}},"DirectFcfsBookingResponse":{"type":"object","properties":{"networkPointId":{"type":"integer","format":"int64"},"productType":{"type":"string","enum":["DAILY","WEEKLY_WORKING_DAYS","WEEKLY","WEEKLY_SAT_FRI","WEEKEND","MONTHLY","QUARTERLY","CALENDAR_YEARLY","YEARLY","WID"]},"runtime":{"$ref":"#/definitions/FcfsRuntimePeriod"},"bookedCapacityAmount":{"$ref":"#/definitions/QuantityDto"},"totalPrice":{"$ref":"#/definitions/DirectFcfsPrice"},"peerTotalPrice":{"$ref":"#/definitions/DirectFcfsPrice"},"requestId":{"type":"string","format":"uuid"},"requestIdentifier":{"type":"string"},"availableCapacityAmount":{"type":"integer","format":"int64"},"requestedBy":{"type":"string"},"requestedOn":{"type":"string"},"status":{"type":"string","enum":["SUCCESS","REQUEST_FORWARDED","FAILED"]},"reason":{"type":"string"},"runtimeZoneId":{"type":"string"}}},"DirectFcfsBookingRequest":{"type":"object","required":["networkPointId","offeredCapacityAmount","productType","runtime","shipperUserEmail"],"properties":{"networkPointId":{"type":"integer","format":"int64"},"shipperUserEmail":{"type":"string","description":"The user who is performing the request"},"productType":{"type":"string","enum":["DAILY","WEEKLY_WORKING_DAYS","WEEKLY","WEEKLY_SAT_FRI","WEEKEND","MONTHLY","QUARTERLY","CALENDAR_YEARLY","YEARLY","WID"]},"runtime":{"$ref":"#/definitions/FcfsRuntimePeriod"},"offeredCapacityAmount":{"$ref":"#/definitions/QuantityDto"},"totalPrice":{"$ref":"#/definitions/DirectFcfsPrice"},"peerTotalPrice":{"$ref":"#/definitions/DirectFcfsPrice"}}},"DirectFcfsBookingsResponse":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid"},"requestIdentifier":{"type":"string"},"productType":{"type":"string","enum":["DAILY","WEEKLY_WORKING_DAYS","WEEKLY","WEEKLY_SAT_FRI","WEEKEND","MONTHLY","QUARTERLY","CALENDAR_YEARLY","YEARLY","WID"]},"minimumRequestedCapacityAmount":{"$ref":"#/definitions/QuantityDto"},"requestedCapacityAmount":{"$ref":"#/definitions/QuantityDto"},"offeredCapacityAmount":{"$ref":"#/definitions/QuantityDto"},"allocatedCapacityAmount":{"$ref":"#/definitions/QuantityDto"},"totalPrice":{"$ref":"#/definitions/DirectFcfsPrice"},"peerTotalPrice":{"$ref":"#/definitions/DirectFcfsPrice"},"currency":{"type":"string"},"flowUnit":{"type":"string"},"runtimeFrom":{"type":"string"},"runtimeTo":{"type":"string"},"runtimeZoneId":{"type":"string"},"requestedTime":{"type":"string"},"resolutionTime":{"type":"string"},"status":{"type":"string","enum":["SUCCESS","REQUEST_FORWARDED","FAILED"]},"bookedByUserId":{"type":"integer","format":"int64"},"networkPointId":{"type":"integer","format":"int64"},"networkPointDirection":{"type":"string","enum":["ENTRY","EXIT","BUNDLE"]},"operatorId":{"type":"integer","format":"int64"},"peerOperatorId":{"type":"integer","format":"int64"},"approved":{"type":"boolean"},"rejectionReason":{"type":"string"}}},"DirectFcfsAvailableProductsResponse":{"type":"object","properties":{"productType":{"type":"string","enum":["DAILY","WEEKLY_WORKING_DAYS","WEEKLY","WEEKLY_SAT_FRI","WEEKEND","MONTHLY","QUARTERLY","CALENDAR_YEARLY","YEARLY","WID"]},"runtimes":{"type":"array","items":{"$ref":"#/definitions/Runtime"}}}},"Runtime":{"type":"object","properties":{"runtimePeriod":{"$ref":"#/definitions/FcfsRuntimePeriod"},"runtimeZoneId":{"type":"string"},"minimumBookableCapacityAmount":{"$ref":"#/definitions/QuantityDto"}}},"RegularFcfsAvailabilityCheckRequest":{"type":"object","required":["capacityCategory","networkPointId","runtimeType","shipperUserEmail"],"properties":{"shipperUserEmail":{"type":"string","description":"The user who is performing the request"},"runtimeType":{"type":"string","enum":["WITHINDAY","CUSTOM","DAY","MONTH","QUARTER","GAS_YEAR","CALENDAR_YEAR","FULL_WITHINDAY"]},"capacityCategory":{"type":"string","enum":["FZK","FZK_C","FZK_INC","B_FZK","B_FZK_C","B_FZK_1","BZK","U_BZK","U_KC","DZK","TVK","FIRM","FIRM_ADDITIONAL","INTERRUPTIBLE","INTERRUPTIBLE_LEVEL_1","INTERRUPTIBLE_LEVEL_2","INTERRUPTIBLE_LEVEL_N","BACKHAUL_CAPACITY","BACKHAUL_LEVEL_1","BACKHAUL_LEVEL_2","BACKHAUL_LEVEL_N","DZK_1","DZK_2","DZK_3","DZK_4","DZK_5","INCREMENTAL_OFFER_LEVEL_1","INCREMENTAL_OFFER_LEVEL_2","INCREMENTAL_OFFER_LEVEL_3","INCREMENTAL_OFFER_LEVEL_4","INCREMENTAL_OFFER_LEVEL_5","DZK_SH","IUKCF_1"]},"networkPointId":{"type":"integer","format":"int64"},"quantity":{"$ref":"#/definitions/QuantityDto"},"runtime":{"$ref":"#/definitions/DateInterval"}}},"Interval":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"NetworkPointDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"direction":{"type":"string","enum":["ENTRY","EXIT","BUNDLE"]},"eic":{"type":"string"},"connectionPointType":{"type":"string","enum":["MARKET_TRANSITION_POINT","BORDER_TRANSITION_POINT","RESERVOIR","GRID_ACCESS_POINT","PRODUCTION","BIOGAS_ENTRY","OTHER_NETWORK_POINT"]},"gasType":{"type":"string","enum":["H_GAS","L_GAS"]},"physicalUnit":{"type":"string","enum":["K_WH_H","K_WH_D","M3","M3_H"]},"validity":{"$ref":"#/definitions/Interval"},"entry":{"$ref":"#/definitions/NetworkPointDto"},"exit":{"$ref":"#/definitions/NetworkPointDto"},"marketArea":{"$ref":"#/definitions/MarketAreaDto"},"self":{"type":"string"},"href":{"type":"string"}}},"CapacityTariffDto":{"type":"object","properties":{"priceDto":{"$ref":"#/definitions/PriceDto"},"validity":{"$ref":"#/definitions/DateInterval"}}},"NetworkPointDetailDto":{"type":"object","required":["calorificValue"],"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"direction":{"type":"string","enum":["ENTRY","EXIT","BUNDLE"]},"eic":{"type":"string"},"connectionPointType":{"type":"string","enum":["MARKET_TRANSITION_POINT","BORDER_TRANSITION_POINT","RESERVOIR","GRID_ACCESS_POINT","PRODUCTION","BIOGAS_ENTRY","OTHER_NETWORK_POINT"]},"gasType":{"type":"string","enum":["H_GAS","L_GAS"]},"physicalUnit":{"type":"string","enum":["K_WH_H","K_WH_D","M3","M3_H"]},"validity":{"$ref":"#/definitions/Interval"},"entry":{"$ref":"#/definitions/NetworkPointDetailDto"},"exit":{"$ref":"#/definitions/NetworkPointDetailDto"},"marketArea":{"$ref":"#/definitions/MarketAreaDto"},"self":{"type":"string"},"href":{"type":"string"},"internalIdentifier":{"type":"string"},"identifier":{"type":"string"},"meterPointCode":{"type":"string"},"owner":{"type":"string"},"marketerTso":{"$ref":"#/definitions/TsoMinimalDto"},"adjacentTsos":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"capacityCategories":{"type":"array","uniqueItems":true,"items":{"type":"string","enum":["FZK","FZK_C","FZK_INC","B_FZK","B_FZK_C","B_FZK_1","BZK","U_BZK","U_KC","DZK","TVK","FIRM","FIRM_ADDITIONAL","INTERRUPTIBLE","INTERRUPTIBLE_LEVEL_1","INTERRUPTIBLE_LEVEL_2","INTERRUPTIBLE_LEVEL_N","BACKHAUL_CAPACITY","BACKHAUL_LEVEL_1","BACKHAUL_LEVEL_2","BACKHAUL_LEVEL_N","DZK_1","DZK_2","DZK_3","DZK_4","DZK_5","INCREMENTAL_OFFER_LEVEL_1","INCREMENTAL_OFFER_LEVEL_2","INCREMENTAL_OFFER_LEVEL_3","INCREMENTAL_OFFER_LEVEL_4","INCREMENTAL_OFFER_LEVEL_5","DZK_SH","IUKCF_1"]}},"calorificValue":{"type":"string","example":"0.01"},"nominationResponsible":{"type":"boolean"},"marketerTerms":{"type":"string"},"comments":{"type":"string"},"individualFields":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"capacityTariffs":{"type":"array","items":{"$ref":"#/definitions/CapacityTariffDto"}},"charges":{"$ref":"#/definitions/ChargesDto"},"tradingMarkets":{"type":"array","items":{"type":"string","enum":["PRIMARY","SECONDARY","ALL","NONE"]}},"periodTypes":{"type":"array","items":{"type":"string","enum":["INTRADAY","DAY","MONTH","QUARTER","YEAR"]}},"authorityCode":{"type":"string","enum":["DVGW","EIC","ILN","EPCP"]},"supportsUndiscountedTariff":{"type":"boolean","description":"Whether the network point supports undiscounted tariff bidding"}}},"PortfolioCodeDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"portfolioCodeId":{"type":"string"},"validity":{"$ref":"#/definitions/DateInterval"}}},"FcfsQuantity":{"type":"object","required":["unit","value"],"properties":{"value":{"type":"integer","format":"int64","example":1},"unit":{"type":"string"}}},"RegularFcfsRequestCapacityRequest":{"type":"object","required":["capacityCategory","networkPointId","quantity","runtime","runtimeType","shipperUserEmail"],"properties":{"shipperUserEmail":{"type":"string"},"runtimeType":{"type":"string","enum":["WEEKLY_WORKING_DAYS","WEEKLY","WEEKLY_SAT_FRI","WEEKEND","SEASON","BOM","WITHINDAY","CUSTOM","DAY","MONTH","QUARTER","GAS_YEAR","CALENDAR_YEAR","FULL_WITHINDAY","UNKNOWN"]},"capacityCategory":{"type":"string","enum":["FZK","FZK_C","FZK_INC","B_FZK","B_FZK_C","B_FZK_1","BZK","U_BZK","U_KC","DZK","TVK","FIRM","FIRM_ADDITIONAL","INTERRUPTIBLE","INTERRUPTIBLE_LEVEL_1","INTERRUPTIBLE_LEVEL_2","INTERRUPTIBLE_LEVEL_N","BACKHAUL_CAPACITY","BACKHAUL_LEVEL_1","BACKHAUL_LEVEL_2","BACKHAUL_LEVEL_N","DZK_1","DZK_2","DZK_3","DZK_4","DZK_5","INCREMENTAL_OFFER_LEVEL_1","INCREMENTAL_OFFER_LEVEL_2","INCREMENTAL_OFFER_LEVEL_3","INCREMENTAL_OFFER_LEVEL_4","INCREMENTAL_OFFER_LEVEL_5","DZK_SH","IUKCF_1"]},"networkPointId":{"type":"string","format":"uuid"},"quantity":{"$ref":"#/definitions/FcfsQuantity"},"minimumQuantity":{"$ref":"#/definitions/FcfsQuantity"},"runtime":{"$ref":"#/definitions/FcfsRuntimeInterval"}}},"BookingRequest":{"type":"object","properties":{"offeredCapacityId":{"type":"string","format":"uuid"},"shipperLabel":{"type":"string"},"balancingGroup":{"$ref":"#/definitions/UuidIdentifier"},"portfolioCode":{"$ref":"#/definitions/UuidIdentifier"},"upgrade":{"$ref":"#/definitions/Upgrade"},"requestedBy":{"type":"string"},"requestedAt":{"type":"string"}}},"BookingResult":{"type":"object","properties":{"bookedCapacities":{"type":"array","items":{"$ref":"#/definitions/BookedCapacity"}},"contractId":{"type":"string"},"bookedAt":{"type":"string"}}},"BookingSettings":{"type":"object","properties":{"shipperLabelSupported":{"type":"boolean"},"balancingGroupConfig":{"type":"string"},"portfolioCodeConfig":{"type":"string"},"balancingGroups":{"type":"array","items":{"$ref":"#/definitions/UuidIdentifier"}},"portfolioCodes":{"type":"array","items":{"$ref":"#/definitions/UuidIdentifier"}},"upgradeSupported":{"type":"boolean"},"upgradableAllocations":{"type":"array","items":{"$ref":"#/definitions/UuidIdentifier"}},"upgradeContractIdConfig":{"type":"string"}}},"Capacity":{"type":"object","properties":{"offerId":{"type":"string","format":"uuid"},"assignedOfferId":{"type":"string"},"capacityCategory":{"type":"string"},"interval":{"$ref":"#/definitions/FcfsRuntimeInterval"},"quantity":{"$ref":"#/definitions/FcfsQuantity"},"charges":{"type":"array","items":{"$ref":"#/definitions/RegularFcfsCharge"}}}},"CapacityRequest":{"type":"object","properties":{"payload":{"$ref":"#/definitions/Payload"},"requestedBy":{"type":"string"},"requestedAt":{"type":"string"}}},"FcfsBookingDetails":{"type":"object","properties":{"bookingId":{"type":"string","format":"uuid"},"assignedBookingId":{"type":"string"},"networkPointId":{"type":"string","format":"uuid"},"status":{"type":"string"},"errorReason":{"type":"string"},"capacityRequest":{"$ref":"#/definitions/CapacityRequest"},"offeredCapacities":{"type":"array","items":{"$ref":"#/definitions/OfferedCapacity"}},"bookingSettings":{"$ref":"#/definitions/BookingSettings"},"bookingRequest":{"$ref":"#/definitions/BookingRequest"},"bookingResult":{"$ref":"#/definitions/BookingResult"}}},"OfferedCapacity":{"type":"object","properties":{"offeredCapacityId":{"type":"string","format":"uuid"},"parts":{"type":"array","items":{"$ref":"#/definitions/OfferedCapacityPart"}}}},"OfferedCapacityPart":{"type":"object","properties":{"offerId":{"type":"string","format":"uuid"},"assignedOfferId":{"type":"string"},"capacityCategory":{"type":"string"},"interval":{"$ref":"#/definitions/FcfsRuntimeInterval"},"quantity":{"$ref":"#/definitions/FcfsQuantity"},"charges":{"type":"array","items":{"$ref":"#/definitions/RegularFcfsCharge"}}}},"Payload":{"type":"object","properties":{"runtimeType":{"type":"string"},"capacityCategory":{"type":"string"},"networkPointId":{"type":"string","format":"uuid"},"quantity":{"$ref":"#/definitions/FcfsQuantity"},"minimumQuantity":{"$ref":"#/definitions/FcfsQuantity"},"runtime":{"$ref":"#/definitions/FcfsRuntimeInterval"}}},"RegularFcfsCharge":{"type":"object","properties":{"type":{"type":"string"},"price":{"$ref":"#/definitions/RegularFcfsPrice"}}},"UuidIdentifier":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"identifier":{"type":"string"}}},"FcfsNetworkPoint":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"identifier":{"type":"string"},"name":{"type":"string"},"direction":{"type":"string"},"tsoId":{"type":"string","format":"uuid"},"tsoName":{"type":"string"},"tsoShortName":{"type":"string"}}},"AvailableRuntime":{"type":"object","properties":{"periodType":{"type":"string"},"runtimes":{"type":"array","items":{"$ref":"#/definitions/RuntimeEntry"}}}},"FcfsNetworkPointDetails":{"type":"object","properties":{"physicalUnit":{"type":"string"},"capacityCategories":{"type":"array","items":{"type":"string"}},"minimumBookableAmountRequired":{"type":"boolean"},"availableRuntimes":{"type":"array","items":{"$ref":"#/definitions/AvailableRuntime"}},"nextBookableRuntimes":{"type":"array","items":{"$ref":"#/definitions/NextBookableRuntime"}},"leadTimeRules":{"type":"array","items":{"$ref":"#/definitions/LeadTimeRule"}},"id":{"type":"string","format":"uuid"},"identifier":{"type":"string"},"name":{"type":"string"},"direction":{"type":"string"},"tsoId":{"type":"string","format":"uuid"},"tsoName":{"type":"string"},"tsoShortName":{"type":"string"}}},"LeadTime":{"type":"object","properties":{"value":{"type":"integer","format":"int32"},"leadTimeUnit":{"type":"string","enum":["DAY","YEAR","MONTH","WORKING_DAY","HOUR","MINUTE","AT_ANY_TIME","UNKNOWN"]}}},"LeadTimeRule":{"type":"object","properties":{"name":{"type":"string"},"infiniteRuntime":{"type":"boolean"},"runtimeLength":{"$ref":"#/definitions/RuntimeLength"},"leadTimeStart":{"$ref":"#/definitions/LeadTime"},"leadTimeEnd":{"$ref":"#/definitions/LeadTime"},"contractPeriodType":{"type":"string","enum":["SUBSEQUENT_WITHINDAY","FULL_WITHINDAY","NON_WITHINDAY","UNKNOWN"]}}},"MinimumBookableCapacityAmount":{"type":"object","properties":{"unit":{"type":"string"},"value":{"type":"integer","format":"int32"}}},"NextBookableRuntime":{"type":"object","properties":{"runtime":{"$ref":"#/definitions/Interval"},"periodType":{"type":"string","enum":["WITHINDAY","FULL_WITHINDAY","DAY","MONTH","QUARTER","GAS_YEAR","CALENDAR_YEAR","CUSTOM","UNKNOWN"]}}},"RuntimeEntry":{"type":"object","properties":{"runtimePeriod":{"$ref":"#/definitions/RuntimePeriod"},"minimumBookableCapacityAmount":{"$ref":"#/definitions/MinimumBookableCapacityAmount"}}},"RuntimeLength":{"type":"object","properties":{"value":{"type":"integer","format":"int32"},"timeUnit":{"type":"string","enum":["HOURS","DAYS","MONTHS","QUARTERS","YEARS","UNKNOWN"]}}},"RuntimePeriod":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"},"displayInZoneId":{"type":"string"}}},"FcfsBookingItem":{"type":"object","properties":{"bookingId":{"type":"string","format":"uuid"},"assignedBookingId":{"type":"string"},"networkPointId":{"type":"string","format":"uuid"},"status":{"type":"string"},"errorReason":{"type":"string"},"runtimeType":{"type":"string"},"runtime":{"$ref":"#/definitions/FcfsRuntimeInterval"},"requestedCapacityCategory":{"type":"string"},"requestedQuantity":{"$ref":"#/definitions/FcfsQuantity"},"requestedMinimumQuantity":{"$ref":"#/definitions/FcfsQuantity"},"requestedBy":{"type":"string"},"requestedAt":{"type":"string"},"assignedAllocationId":{"type":"string"},"contractId":{"type":"string"},"bookedAt":{"type":"string"},"capacityCategory":{"type":"string"},"quantity":{"$ref":"#/definitions/FcfsQuantity"},"charges":{"type":"array","items":{"$ref":"#/definitions/RegularFcfsCharge"}}}},"FcfsBookingsResponse":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"items":{"type":"array","items":{"$ref":"#/definitions/FcfsBookingItem"}}}},"FcfsUuidIdentifierDto":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"identifier":{"type":"string"}}},"RegularFcfsBookCapacityShipperRequest":{"type":"object","required":["bookingId","networkPointId","offeredCapacityId","shipperUserEmail"],"properties":{"shipperUserEmail":{"type":"string"},"networkPointId":{"type":"string","format":"uuid"},"bookingId":{"type":"string","format":"uuid"},"offeredCapacityId":{"type":"string","format":"uuid"},"shipperLabel":{"type":"string"},"balancingGroup":{"$ref":"#/definitions/FcfsUuidIdentifierDto"},"portfolioCode":{"$ref":"#/definitions/FcfsUuidIdentifierDto"},"upgrade":{"$ref":"#/definitions/Upgrade"}}},"AddressDto":{"type":"object","properties":{"street":{"type":"string"},"zipCode":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"poBox":{"type":"string"},"poBoxZipCode":{"type":"string"},"poBoxCity":{"type":"string"}}},"CommunicationInfo":{"type":"object","properties":{"phone":{"type":"string"},"phoneBackup":{"type":"string"},"phoneOnCall":{"type":"string"},"mobile":{"type":"string"},"fax":{"type":"string"},"email":{"type":"string"}}},"ContractingServiceDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"serviceLabel":{"type":"string"},"serviceEmail":{"type":"string"},"fieldLabels":{"type":"array","items":{"type":"string"}},"enabled":{"type":"boolean"}}},"Currency":{"type":"object","properties":{"currencyCode":{"type":"string"},"defaultFractionDigits":{"type":"integer","format":"int32"},"numericCode":{"type":"integer","format":"int32"},"symbol":{"type":"string"},"displayName":{"type":"string"}}},"TsoDetailDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"shortName":{"type":"string"},"eic":{"type":"string"},"dvgw":{"type":"string"},"gtcUrl":{"type":"string"},"address":{"$ref":"#/definitions/AddressDto"},"communication":{"$ref":"#/definitions/CommunicationInfo"},"url":{"type":"string"},"contactFormUrl":{"type":"string"},"requiredTsoSpecificIdList":{"type":"array","items":{"type":"string"}},"contractingServicesList":{"type":"array","items":{"$ref":"#/definitions/ContractingServiceDto"}},"fcfsLeadTimeHint":{"type":"string"},"marketAreas":{"type":"array","items":{"$ref":"#/definitions/MarketAreaDto"}},"currency":{"$ref":"#/definitions/Currency"},"self":{"type":"string"},"href":{"type":"string"}}},"TsoDto":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"eic":{"type":"string"},"dvgw":{"type":"string"},"marketAreas":{"type":"array","items":{"$ref":"#/definitions/MarketAreaDto"}},"self":{"type":"string"},"href":{"type":"string"}}}}}