Web Service: OpenAccessServer

Target Namespace:
urn:openaccess
Description:
OpenAccess API


Port: OpenAccessEchoPort


Transport:
SOAP
Style:
rpc
Transport Protocol:
SOAP over HTTP
Operations:
Location:
https://ETSOpenAccess/OpenAccess/Echo

Operations

Port Type: OpenAccess_3.2_OpenAccessPortType

Description:
Version: 3.4.2-Api 3.2
  1. CancelBlockOrder
    Cancel a specified range of Block Orders.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelBlockOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_CancelBlockOrder)
      BlockOrderIdentifier Type BlockOrderIdentifier urn:openaccess
      This object contains the search parameters for block orders
      • Choice - mandatory
      • Choice - mandatory
      • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
        Comment field of the Block Orders.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Delivery Day the Order applies to.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Range of Delivery Days the Order applies to.
        • <timeIntervals> - optional, unbounded Type DateTimeRange urn:openaccess
          Time Interval to identify the Orders. Deprecated: for compatibilty reason only. Use deliveryDay | deliveryDays instead.
        • <AuctionIdentification> - optional, unbounded Type AuctionIdentification urn:openaccess
          0 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • <blockCode> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88', 'ALL' }
        Block Code the Order applies to.
      • <minBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Lowest Block Order ID to specify a range of Block Orders.
      • <maxBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Highest Block Order ID to specify a range of Block Orders.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  2. CancelComplexOrder
    Cancel already submitted Daily Orders.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelComplexOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_CancelComplexOrder)
      OrderIdentifier Type ComplexOrderIdentification urn:openaccess
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Area for the Order.
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Portfolio the Order applies to.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The Delivery Day of the Order.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Date Range to search over.
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          1 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  3. CancelExclusiveGroupWithId
    Cancel all Block Orders for this Exclusive Group ID.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelExclusiveGroupWithId
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_CancelExclusiveGroupWithId)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  4. CancelGroupForBlockId
    Cancel all Block Orders belonging to the same Exclusive Group or Family as the identified Block Order.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelGroupForBlockId
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_CancelGroupForBlockId)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  5. CancelLoopBlocksWithGroupId
    Cancel all Loop Block Orders (C88) in the family with the specified Group ID.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelLoopBlocksWithGroupId
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_CancelLoopBlocksWithGroupId)
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  6. CancelOrder
    Cancel already submitted Daily Orders.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_CancelOrder)
      OrderIdentifier Type OrderIdentifier urn:openaccess
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Area for the Order.
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Portfolio the Order applies to.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The Delivery Day of the Order.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Date Range to search over.
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          1 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  7. EnterBlockOrder
    Enter a Block Order for a specific date.
    Additional Rules: 1. Modification of a Block Order is accomplished the same as Daily Order entry. A new block order is sent and the old one is overwritten. 2. Only C01 Block Orders can be Entered/Modified
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EnterBlockOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_EnterBlockOrder)
      blockOrder Type BlockOrder urn:openaccess
      This object contains the details for a block order
      • <blockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Block Order ID returned if the Block Order was accepted.
      • Choice - mandatory
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Delivery Date of the Block Order. Only usable if only 1 Auction is defined per day.
        • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Applying Date of the Block Order. Deprecated: Use auctionIdentification or deliveryDay instead.
        • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
          Auction Identification.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • Choice - mandatory
      • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
        Price of the Block Order.
      • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
        Comment field for the Block Order.
      • <periods> - mandatory, max 100 Type BlockPeriod urn:openaccess
        Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
      • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
        In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  8. EnterBlockOrderBatch
    Submit a Batch of Block Orders for the same Portfolio, Area and Applying Date.
    Additional Rules: Modification of a Block Order is accomplished the same as EnterBlockOrder.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EnterBlockOrderBatch
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_EnterBlockOrderBatch)
      blockOrderBatch Type BlockOrderBatch urn:openaccess
      Contains the details for entering/modifying a set of block orders
      • Choice - mandatory
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Delivery Day of the Block Orders. Delivery Day can only be used if exacly one Auction is defined. Otherwise you have to use auctionIdentification
        • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Applying Date of the Block Orders. Deprecated: Use Delivery Day instead.
        • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
          Auction Identification of the Block Orders.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • Choice - mandatory
      • <BlockOrder> - mandatory, unbounded Type BlockOrderForBatch urn:openaccess
        Collection of Block Orders that will be entered/modified within this Batch.
        • <blockCode> - mandatory Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88' }
          C01 - Standard Block Order. C02 - Linked Block Order. C04 - Exclusive Block Order. C88 - Loop Block Order (only availabe in services with version >= 3.2).
        • <blockCodePRM> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Consideration of this Parameter depends on the value of blockCode: C01 - Optional: The value is ignored. C02 - Mandatory: Reference to the blockIndex of the parent(s) (if more than 1 seperated by _ (underscore Unicode U+005F LOW LINE) ). C04 - Mandatory: Id of the exclusive group. C88 - Mandatory: Id of the loop group
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          An optional comment of the Block Order.
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <Period> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <MAR> - optional Type decimal http://www.w3.org/2001/XMLSchema restriction { , maxInclusive="1", totalDigits="3" }
          The Block Orders Minimum Acceptance Ratio (only availabe in services with version >= 3.2)
        • <BlockIndex> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
          Virtual or Real Block ID. If a Block Order for Portfolio, Area and Applying Date with this ID exists the System triggers a Modification. Otherwise it is treated as a new Block Order.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  9. EnterComplexOrder
    Enter Complex Orders for specific Auction identification(s).
    Additional Rules: 1. Complex Orders are modified only by replacement. By sending in a new Order, the old Order is overwritten with the new values. 2. If more than one Auction Identification is submitted, rule one is executed on each Auction that is specified with the same values.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EnterComplexOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_EnterComplexOrder)
      Order Type ComplexOrder urn:openaccess
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
      • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
        List of Auction Identifiers.
        • Choice - mandatory
        • <name> - optional Type string http://www.w3.org/2001/XMLSchema
          The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
        • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
          Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • <Curve> - mandatory, unbounded Type Curve urn:openaccess
        List of Curves.
      • <fixed_Term> - mandatory Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="18", fractionDigits="11" }
        Fixed Term of the Complex Order. (Zero value if no Fixed Term is defined).
      • <variable_Term> - mandatory Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="18", fractionDigits="11" }
        Variable Term. (Zero value if no Variable Term is defined).
      • <increase_Gradient> - optional, nillable Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="11", fractionDigits="5", minInclusive="0" }
        Increase Gradient. ( NULL value if no Increase Gradient is defined).
      • <decrease_Gradient> - optional, nillable Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="11", fractionDigits="5", minInclusive="0" }
        Decrease Gradient. (NULL value if no Decrease Gradient is defined)
      • <schedule_Stop> - mandatory Type int http://www.w3.org/2001/XMLSchema restriction { totalDigits="2", minInclusive="0" }
        Number of Scheduled Stop Periods starting from Period #1. Value should be non-negative. (Zero value if no Schedule Stop is defined).
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  10. EnterOrder
    Enter Daily Orders for a specified date.
    Additional Rules: 1. Daily Orders are modified only by replacement. By sending in a new order, the old order is overwritten with the new values.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EnterOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_EnterOrder)
      Order Type Order urn:openaccess
      This object contains the data for the Order. AuctionIdentification must occur not more than once.
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Area for the Order.
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Portfolio the Order applies to.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The Delivery Day of the Order.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Date Range to search over.
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          1 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • <Curve> - mandatory, max 100 Type Curve urn:openaccess
        Collection of Curves.
      • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
        In output: The settlement currency is included in every order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  11. EstablishConnection
    Login to the Open Access Server and start a User Session.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EstablishConnection
    Input:
    Output:
    • Body (use=literal, Message=OpenAccess_3.2_EstablishConnectionResponse)
      EstablishSessionResponse Type EstablishSessionResponse urn:openaccess
      Indicates success or failure of a login attempt. The successful response contains a session token to be used for other API calls
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
  12. KeepAlive
    Tests connectivity to the Open Access Server and keeps the HTTP connection active by sending a message to the server at regular intervals. If the the KeepAlive message reaches the server, a KeepAliveResponse message will be returned which contains the string "OpenAccess <version> - I am Alive".
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    KeepAlive
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_KeepAlive)
      Empty
    Output:
  13. Logout
    Logout the User Session from the Open Access Server.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    Logout
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_Logout)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  14. RetrieveAreaInformation
    Retrieve Area information for a specified Area.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveAreaInformation
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveAreaInformation)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  15. RetrieveAreaPortfolioInformation
    Retrieve Area/Portfolio Informations for specified Area(s) and/or Portfolio(s). Absence of Areas and/or Portfolios means all, so if nothing is specified the result is the same as RetrieveViewableAreaPortfolioInformations
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveAreaPortfolioInformation
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveAreaPortfolioInformation)
      AreaPortfolioInformationQuery Type AreaPortfolioInformationQuery urn:openaccess
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  16. RetrieveAuctionInformation
    Retrieve next <NumberOfAuctions> Informations for specified <Area>(s).
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveAuctionInformation
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveAuctionInformation)
      AuctionInformationQuery Type AuctionInformationQuery urn:openaccess
      • <Area> - mandatory, unbounded Type string http://www.w3.org/2001/XMLSchema
        Area Name(s) to query
      • <NumberOfAuctions> - mandatory Type int http://www.w3.org/2001/XMLSchema restriction { minInclusive="1", maxInclusive="50" }
        The Number of the next Auctions.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  17. RetrieveBlockOrders
    Retrieve all Block Orders matching the search parameter in the Block Order Identifier Object.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveBlockOrders
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveBlockOrders)
      BlockOrderIdentifier Type BlockOrderIdentifier urn:openaccess
      This object contains the search parameters for block orders
      • Choice - mandatory
      • Choice - mandatory
      • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
        Comment field of the Block Orders.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Delivery Day the Order applies to.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Range of Delivery Days the Order applies to.
        • <timeIntervals> - optional, unbounded Type DateTimeRange urn:openaccess
          Time Interval to identify the Orders. Deprecated: for compatibilty reason only. Use deliveryDay | deliveryDays instead.
        • <AuctionIdentification> - optional, unbounded Type AuctionIdentification urn:openaccess
          0 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • <blockCode> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88', 'ALL' }
        Block Code the Order applies to.
      • <minBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Lowest Block Order ID to specify a range of Block Orders.
      • <maxBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Highest Block Order ID to specify a range of Block Orders.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveBlockOrdersResponse)
      RetrieveBlockOrdersAcknowledgement Type RetrieveBlockOrdersAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveBlockOrders message and contains the results of the search. Indicates success or failure of the message
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <blockOrders> - optional, nillable, unbounded Type BlockOrder urn:openaccess
        Collection of Block Orders found.
        • <blockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
          Block Order ID returned if the Block Order was accepted.
        • Choice - mandatory
        • Choice - mandatory
          • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Delivery Date of the Block Order. Only usable if only 1 Auction is defined per day.
          • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Applying Date of the Block Order. Deprecated: Use auctionIdentification or deliveryDay instead.
          • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
            Auction Identification.
            • Choice - mandatory
            • <name> - optional Type string http://www.w3.org/2001/XMLSchema
              The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • Choice - mandatory
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Comment field for the Block Order.
        • <periods> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
          In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  18. RetrieveComplexOrders
    Retrieve all Hourly/Stepwise Orders matching the search parameter in the Order Identifier Object. Only the active versions of each Order are returned.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveComplexOrders
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveComplexOrders)
      OrderIdentifier Type ComplexOrderIdentification urn:openaccess
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Area for the Order.
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Portfolio the Order applies to.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The Delivery Day of the Order.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Date Range to search over.
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          1 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveComplexOrdersResponse)
      RetrieveComplexOrdersResult Type RetrieveComplexOrdersAcknowledgement urn:openaccess
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <Order> - optional, unbounded Type ComplexOrder urn:openaccess
        Collection of Complex Orders that match the search parameters.
        • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          List of Auction Identifiers.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • <Curve> - mandatory, unbounded Type Curve urn:openaccess
          List of Curves.
        • <fixed_Term> - mandatory Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="18", fractionDigits="11" }
          Fixed Term of the Complex Order. (Zero value if no Fixed Term is defined).
        • <variable_Term> - mandatory Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="18", fractionDigits="11" }
          Variable Term. (Zero value if no Variable Term is defined).
        • <increase_Gradient> - optional, nillable Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="11", fractionDigits="5", minInclusive="0" }
          Increase Gradient. ( NULL value if no Increase Gradient is defined).
        • <decrease_Gradient> - optional, nillable Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="11", fractionDigits="5", minInclusive="0" }
          Decrease Gradient. (NULL value if no Decrease Gradient is defined)
        • <schedule_Stop> - mandatory Type int http://www.w3.org/2001/XMLSchema restriction { totalDigits="2", minInclusive="0" }
          Number of Scheduled Stop Periods starting from Period #1. Value should be non-negative. (Zero value if no Schedule Stop is defined).
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  19. RetrieveExclusiveGroupWithId
    Answers all Block Orders for this Exclusive Group ID. Due to required support of previous versions (lower than 1.9) of the WSDL, this call must use deprecated output until such support is no longer required.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveExclusiveGroupWithId
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveExclusiveGroupWithId)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveExclusiveGroupWithIdResponse)
      RetrieveExclusiveGroupResult Type RetrieveExclusiveGroupAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveExclusiveGroupWithId message and contains the results of the search. Indicates success or failure of the message
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <BlockOrder> - optional, unbounded Type SmartBlockOrder urn:openaccess
        This Object contains the Block Orders matching the search parameters.
        • <blockCode> - mandatory Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88' }
          C01 - Standard Block Order. C02 - Linked Block Order. C04 - Exclusive Block Order. C88 - Loop Block Order (only availabe in services with version >= 3.2).
        • <blockCodePRM> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Consideration of this Parameter depends on the value of blockCode: C01 - Optional: The value is ignored. C02 - Mandatory: Reference to the blockIndex of the parent(s) (if more than 1 seperated by _ (underscore Unicode U+005F LOW LINE) ). C04 - Mandatory: Id of the exclusive group. C88 - Mandatory: Id of the loop group
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          An optional comment of the Block Order.
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <Period> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <MAR> - optional Type decimal http://www.w3.org/2001/XMLSchema restriction { , maxInclusive="1", totalDigits="3" }
          The Block Orders Minimum Acceptance Ratio (only availabe in services with version >= 3.2)
        • Choice - mandatory
        • Choice - mandatory
          • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Delivery Day of the Block Order. Only usable if only 1 auction is defined per day.
          • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Applying Date of the Block Order. Deprecated: For compatibility reasons only.
          • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
            The Auction Identification.
            • Choice - mandatory
            • <name> - optional Type string http://www.w3.org/2001/XMLSchema
              The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • Choice - mandatory
        • <blockOrderId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
          ID of the Block Order assigned by the Trading System.
        • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
          In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
      • <groupId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
        This Object contains the search parameters for the Block Orders.
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  20. RetrieveGroupForBlockId
    Answers all Block Orders belonging to the same Exclusive Group or Family. The Exclusive Group or Family will be identified by looking for a Group that has a member with this ID. Due to required support of previous versions (lower than 1.9) of the WSDL, this call must use deprecated output until such support is no longer required.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveGroupForBlockId
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveGroupForBlockId)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveGroupForBlockIdResponse)
      RetrieveGroupResult Type RetrieveGroupAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveGroupForBlockId message and contains the results of the search. Indicates success or failure of the message
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <BlockOrder> - optional, unbounded Type SmartBlockOrder urn:openaccess
        This Object contains the Block Orders matching the search parameters.
        • <blockCode> - mandatory Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88' }
          C01 - Standard Block Order. C02 - Linked Block Order. C04 - Exclusive Block Order. C88 - Loop Block Order (only availabe in services with version >= 3.2).
        • <blockCodePRM> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Consideration of this Parameter depends on the value of blockCode: C01 - Optional: The value is ignored. C02 - Mandatory: Reference to the blockIndex of the parent(s) (if more than 1 seperated by _ (underscore Unicode U+005F LOW LINE) ). C04 - Mandatory: Id of the exclusive group. C88 - Mandatory: Id of the loop group
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          An optional comment of the Block Order.
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <Period> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <MAR> - optional Type decimal http://www.w3.org/2001/XMLSchema restriction { , maxInclusive="1", totalDigits="3" }
          The Block Orders Minimum Acceptance Ratio (only availabe in services with version >= 3.2)
        • Choice - mandatory
        • Choice - mandatory
          • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Delivery Day of the Block Order. Only usable if only 1 auction is defined per day.
          • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Applying Date of the Block Order. Deprecated: For compatibility reasons only.
          • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
            The Auction Identification.
            • Choice - mandatory
            • <name> - optional Type string http://www.w3.org/2001/XMLSchema
              The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • Choice - mandatory
        • <blockOrderId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
          ID of the Block Order assigned by the Trading System.
        • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
          In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
      • <blockOrderId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
        This Object contains the search parameters for the Block Orders.
  21. RetrieveLoopBlocksWithGroupId
    Answers all Loop Block Orders (C88) in the family with the specified Group ID.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveLoopBlocksWithGroupId
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveLoopBlocksWithGroupId)
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveLoopBlocksWithGroupIdResponse)
      RetrieveLoopBlocksWithGroupIdResult Type RetrieveLoopBlocksWithGroupIdAcknowledgement urn:openaccess
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <BlockOrder> - optional, unbounded Type SmartBlockOrder urn:openaccess
        This Object contains the Block Orders matching the search parameters.
        • <blockCode> - mandatory Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88' }
          C01 - Standard Block Order. C02 - Linked Block Order. C04 - Exclusive Block Order. C88 - Loop Block Order (only availabe in services with version >= 3.2).
        • <blockCodePRM> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Consideration of this Parameter depends on the value of blockCode: C01 - Optional: The value is ignored. C02 - Mandatory: Reference to the blockIndex of the parent(s) (if more than 1 seperated by _ (underscore Unicode U+005F LOW LINE) ). C04 - Mandatory: Id of the exclusive group. C88 - Mandatory: Id of the loop group
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          An optional comment of the Block Order.
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <Period> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <MAR> - optional Type decimal http://www.w3.org/2001/XMLSchema restriction { , maxInclusive="1", totalDigits="3" }
          The Block Orders Minimum Acceptance Ratio (only availabe in services with version >= 3.2)
        • Choice - mandatory
        • Choice - mandatory
          • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Delivery Day of the Block Order. Only usable if only 1 auction is defined per day.
          • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Applying Date of the Block Order. Deprecated: For compatibility reasons only.
          • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
            The Auction Identification.
            • Choice - mandatory
            • <name> - optional Type string http://www.w3.org/2001/XMLSchema
              The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • Choice - mandatory
        • <blockOrderId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
          ID of the Block Order assigned by the Trading System.
        • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
          In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
      • <groupId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
        This Object contains the search parameters for the Block Orders.
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  22. RetrieveMarketResultsFor
    Retrieve the Market Results for specified Areas.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveMarketResultsFor
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveMarketResultsFor)
      MarketResultIdentifier Type MarketResultIdentifier urn:openaccess
      This Object identifies the Areas and the Auction details for which the Market Results are requested
      • Choice - mandatory
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Applying Date for the Market Results.
        • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Applying Date for the Market Results. Deprecated: Use Delivery Day or Auction Identification instead.
        • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
          Identifies the Auction for the Market Results.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  23. RetrieveMessagesUnreadOnly
    Retrieve the Messages the user has permission to read. If the parameter is true it only returns the messages still unread and if the parameter is false it returns all the messages.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveMessagesUnreadOnly
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveMessagesUnreadOnly)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  24. RetrieveOrders
    Retrieve all Hourly/Stepwise Orders matching the search parameter in the Order Identifier Object. Only the active versions of each order are returned.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveOrders
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveOrders)
      OrderIdentifier Type OrderIdentifier urn:openaccess
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Area for the Order.
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Portfolio the Order applies to.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The Delivery Day of the Order.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Date Range to search over.
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          1 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveOrdersResponse)
      RetrieveOrdersResult Type RetrieveOrdersAcknowledgement urn:openaccess
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  25. RetrieveSmartBlockOrders
    Retrieve all Block Orders matching the search parameter in the Block Order Identifier.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveSmartBlockOrders
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveSmartBlockOrders)
      BlockOrderIdentifier Type BlockOrderIdentifier urn:openaccess
      This object contains the search parameters for block orders
      • Choice - mandatory
      • Choice - mandatory
      • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
        Comment field of the Block Orders.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Delivery Day the Order applies to.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Range of Delivery Days the Order applies to.
        • <timeIntervals> - optional, unbounded Type DateTimeRange urn:openaccess
          Time Interval to identify the Orders. Deprecated: for compatibilty reason only. Use deliveryDay | deliveryDays instead.
        • <AuctionIdentification> - optional, unbounded Type AuctionIdentification urn:openaccess
          0 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • <blockCode> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88', 'ALL' }
        Block Code the Order applies to.
      • <minBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Lowest Block Order ID to specify a range of Block Orders.
      • <maxBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Highest Block Order ID to specify a range of Block Orders.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveSmartBlockOrdersResponse)
      RetrieveSmartBlockOrdersAcknowledgement Type RetrieveSmartBlockOrdersAcknowledgement urn:openaccess
      This object is used as result for the new RetrieveSmartBlockOrders call. In difference from the RetrieveBlocksAcknowledgement it contains Block Orders which additionally have a Block Code and a BlockCodePRM.
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <blockOrders> - optional, nillable, unbounded Type SmartBlockOrder urn:openaccess
        Collection of Block Orders found.
        • <blockCode> - mandatory Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88' }
          C01 - Standard Block Order. C02 - Linked Block Order. C04 - Exclusive Block Order. C88 - Loop Block Order (only availabe in services with version >= 3.2).
        • <blockCodePRM> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Consideration of this Parameter depends on the value of blockCode: C01 - Optional: The value is ignored. C02 - Mandatory: Reference to the blockIndex of the parent(s) (if more than 1 seperated by _ (underscore Unicode U+005F LOW LINE) ). C04 - Mandatory: Id of the exclusive group. C88 - Mandatory: Id of the loop group
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          An optional comment of the Block Order.
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <Period> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <MAR> - optional Type decimal http://www.w3.org/2001/XMLSchema restriction { , maxInclusive="1", totalDigits="3" }
          The Block Orders Minimum Acceptance Ratio (only availabe in services with version >= 3.2)
        • Choice - mandatory
        • Choice - mandatory
          • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Delivery Day of the Block Order. Only usable if only 1 auction is defined per day.
          • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Applying Date of the Block Order. Deprecated: For compatibility reasons only.
          • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
            The Auction Identification.
            • Choice - mandatory
            • <name> - optional Type string http://www.w3.org/2001/XMLSchema
              The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • Choice - mandatory
        • <blockOrderId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
          ID of the Block Order assigned by the Trading System.
        • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
          In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  26. RetrieveTradableAreaPortfolioInformations
    Retrieve Area/Portfolio Informations for specified Area(s) and/or Portfolio(s).
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveTradableAreaPortfolioInformations
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveTradableAreaPortfolioInformations)
      Empty
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  27. RetrieveTradableAreaSets
    Retrieve Area Set names that are both active and that the User Session is permitted to trade on.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveTradableAreaSets
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveTradableAreaSets)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveTradableAreaSetsResponse)
      RetrieveTradeableAreaSetsAcknowledgement Type RetrieveTradeableAreaSetsAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveTradeableAreaSets message. Contains a collection of area Names that the user session is allowed to trade on. Indicates success or failure of the message
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  28. RetrieveTradableAreas
    Retrieve all Area names which are opened for trade.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveTradableAreas
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveTradableAreas)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveTradableAreasResponse)
      RetrieveTradableAreasAcknowledgement Type RetrieveTradableAreasAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveTradableAreas and contain a collection of area Names. Indicates success or failure of the message
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  29. RetrieveTradablePortfolios
    Retrieve Portfolio names that a User Session is allowed to trade on and are open in the Auction.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveTradablePortfolios
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveTradablePortfolios)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveTradablePortfoliosResponse)
      RetrieveTradablePortfoliosAcknowledgement Type RetrieveTradablePortfoliosAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveTradablePortfolios message. It contains a collection of portfolios names that the user session is allowed to trade on
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  30. RetrieveViewableAreaPortfolioInformations
    Retrieve Area/Portfolio Informations for specified Area(s) and/or Portfolio(s).
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveViewableAreaPortfolioInformations
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveViewableAreaPortfolioInformations)
      Empty
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  31. RetrieveViewableAreas
    Retrieve all Area names the User Session has permissions to view.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveViewableAreas
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveViewableAreas)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveViewableAreasResponse)
      RetrieveViewableAreasAcknowledgement Type RetrieveViewableAreasAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveViewableAreas and contain a collection of area Names. Indicates success or failure of the message
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  32. RetrieveViewablePortfolios
    Retrieve all Portfolio names the User Sessions has permissions to view.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveViewablePortfolios
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveViewablePortfolios)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.2_RetrieveViewablePortfoliosResponse)
      RetrieveViewablePortfoliosAcknowledgement Type RetrieveViewablePortfoliosAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveViewablePortfolios message. Contains a collection of portfolios names that the user session is allowed to view. Indicates success or failure of the message view.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  33. SetMessagesAsRead
    Set already existing messages as read.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    SetMessagesAsRead
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_SetMessagesAsRead)
      MessageIdentifier Type MessageIdentifier urn:openaccess
      This object contains the search parameters of the message
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  34. SetNewPassword
    Change the user password. The new password must meet the following requirements: It must contain between 8 and 30 characters. It must contain at least 3 of the following: symbol (e.g. ',', '&', '~', ']'), digit (e.g. '1', '7', '0'), uppercase letter (e.g. 'E', 'T', 'S'), lowercase letter (e.g. 'e', 't', 's'). It must not contain composed characters (e.g. the characters represented by Unicode code points U+00E2, U+00E9, U+00EA). It may include the space character; this counts as a symbol. It must not contain a sequence of three or more instances of the same character.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    SetNewPassword
    Input:
    • Body (use=literal, Message=OpenAccess_3.2_SetNewPassword)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:

Port Type: OpenAccess_3.3_OpenAccessPortType

Description:
Version: 3.4.2-Api 3.3
  1. CancelBlockOrder
    Cancel a specified range of Block Orders.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelBlockOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_CancelBlockOrder)
      BlockOrderIdentifier Type BlockOrderIdentifier urn:openaccess
      This object contains the search parameters for block orders
      • Choice - mandatory
      • Choice - mandatory
      • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
        Comment field of the Block Orders.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Delivery Day the Order applies to.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Range of Delivery Days the Order applies to.
        • <timeIntervals> - optional, unbounded Type DateTimeRange urn:openaccess
          Time Interval to identify the Orders. Deprecated: for compatibilty reason only. Use deliveryDay | deliveryDays instead.
        • <AuctionIdentification> - optional, unbounded Type AuctionIdentification urn:openaccess
          0 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • <blockCode> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88', 'ALL' }
        Block Code the Order applies to.
      • <minBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Lowest Block Order ID to specify a range of Block Orders.
      • <maxBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Highest Block Order ID to specify a range of Block Orders.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  2. CancelComplexOrder
    Cancel already submitted Complex Orders.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelComplexOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_CancelComplexOrder)
      ComplexOrderIdentifier Type ComplexOrderIdentification urn:openaccess
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Area for the Order.
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Portfolio the Order applies to.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The Delivery Day of the Order.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Date Range to search over.
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          1 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  3. CancelExclusiveGroupWithId
    Cancel all Block Orders for this Exclusive Group ID.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelExclusiveGroupWithId
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_CancelExclusiveGroupWithId)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  4. CancelGroupForBlockId
    Cancel all Block Orders belonging to the same Exclusive Group or Family as the identified Block Order.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelGroupForBlockId
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_CancelGroupForBlockId)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  5. CancelLoopBlocksWithGroupId
    Cancel all Loop Block Orders (C88) in the family with the specified Group ID.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelLoopBlocksWithGroupId
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_CancelLoopBlocksWithGroupId)
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  6. CancelOrder
    Cancel already submitted Daily Orders.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_CancelOrder)
      OrderIdentifier Type OrderIdentifier urn:openaccess
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Area for the Order.
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Portfolio the Order applies to.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The Delivery Day of the Order.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Date Range to search over.
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          1 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  7. EnterBlockOrder
    Enter a Block Order for a specific date.
    Additional Rules: 1. Modification of a Block Order is accomplished the same as Daily Order entry. A new block order is sent and the old one is overwritten. 2. Only C01 Block Orders can be Entered/Modified
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EnterBlockOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_EnterBlockOrder)
      blockOrder Type BlockOrder urn:openaccess
      This object contains the details for a block order
      • <blockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Block Order ID returned if the Block Order was accepted.
      • Choice - mandatory
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Delivery Date of the Block Order. Only usable if only 1 Auction is defined per day.
        • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Applying Date of the Block Order. Deprecated: Use auctionIdentification or deliveryDay instead.
        • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
          Auction Identification.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • Choice - mandatory
      • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
        Price of the Block Order.
      • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
        Comment field for the Block Order.
      • <periods> - mandatory, max 100 Type BlockPeriod urn:openaccess
        Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
      • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
        In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  8. EnterBlockOrderBatch
    Submit a Batch of Block Orders for the same Portfolio, Area and Applying Date.
    Additional Rules: Modification of a Block Order is accomplished the same as EnterBlockOrder.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EnterBlockOrderBatch
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_EnterBlockOrderBatch)
      blockOrderBatch Type BlockOrderBatch urn:openaccess
      Contains the details for entering/modifying a set of block orders
      • Choice - mandatory
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Delivery Day of the Block Orders. Delivery Day can only be used if exacly one Auction is defined. Otherwise you have to use auctionIdentification
        • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Applying Date of the Block Orders. Deprecated: Use Delivery Day instead.
        • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
          Auction Identification of the Block Orders.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • Choice - mandatory
      • <BlockOrder> - mandatory, unbounded Type BlockOrderForBatch urn:openaccess
        Collection of Block Orders that will be entered/modified within this Batch.
        • <blockCode> - mandatory Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88' }
          C01 - Standard Block Order. C02 - Linked Block Order. C04 - Exclusive Block Order. C88 - Loop Block Order (only availabe in services with version >= 3.2).
        • <blockCodePRM> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Consideration of this Parameter depends on the value of blockCode: C01 - Optional: The value is ignored. C02 - Mandatory: Reference to the blockIndex of the parent(s) (if more than 1 seperated by _ (underscore Unicode U+005F LOW LINE) ). C04 - Mandatory: Id of the exclusive group. C88 - Mandatory: Id of the loop group
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          An optional comment of the Block Order.
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <Period> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <MAR> - optional Type decimal http://www.w3.org/2001/XMLSchema restriction { , maxInclusive="1", totalDigits="3" }
          The Block Orders Minimum Acceptance Ratio (only availabe in services with version >= 3.2)
        • <BlockIndex> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
          Virtual or Real Block ID. If a Block Order for Portfolio, Area and Applying Date with this ID exists the System triggers a Modification. Otherwise it is treated as a new Block Order.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  9. EnterComplexOrder
    Enter Complex Orders for specific Auction identification(s).
    Additional Rules: 1. Complex Orders are modified only by replacement. By sending in a new Order, the old Order is overwritten with the new values. 2. If more than one Auction Identification is submitted, rule one is executed on each Auction that is specified with the same values.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EnterComplexOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_EnterComplexOrder)
      ComplexOrder Type ComplexOrder urn:openaccess
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
      • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
        List of Auction Identifiers.
        • Choice - mandatory
        • <name> - optional Type string http://www.w3.org/2001/XMLSchema
          The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
        • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
          Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • <Curve> - mandatory, unbounded Type Curve urn:openaccess
        List of Curves.
      • <fixed_Term> - mandatory Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="18", fractionDigits="11" }
        Fixed Term of the Complex Order. (Zero value if no Fixed Term is defined).
      • <variable_Term> - mandatory Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="18", fractionDigits="11" }
        Variable Term. (Zero value if no Variable Term is defined).
      • <increase_Gradient> - optional, nillable Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="11", fractionDigits="5", minInclusive="0" }
        Increase Gradient. ( NULL value if no Increase Gradient is defined).
      • <decrease_Gradient> - optional, nillable Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="11", fractionDigits="5", minInclusive="0" }
        Decrease Gradient. (NULL value if no Decrease Gradient is defined)
      • <schedule_Stop> - mandatory Type int http://www.w3.org/2001/XMLSchema restriction { totalDigits="2", minInclusive="0" }
        Number of Scheduled Stop Periods starting from Period #1. Value should be non-negative. (Zero value if no Schedule Stop is defined).
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  10. EnterOrder
    Enter Daily Orders for a specified date.
    Additional Rules: 1. Daily Orders are modified only by replacement. By sending in a new order, the old order is overwritten with the new values.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EnterOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_EnterOrder)
      Order Type Order urn:openaccess
      This object contains the data for the Order. AuctionIdentification must occur not more than once.
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Area for the Order.
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Portfolio the Order applies to.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The Delivery Day of the Order.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Date Range to search over.
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          1 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • <Curve> - mandatory, max 100 Type Curve urn:openaccess
        Collection of Curves.
      • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
        In output: The settlement currency is included in every order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  11. EstablishConnection
    Login to the Open Access Server and start a User Session.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EstablishConnection
    Input:
    Output:
    • Body (use=literal, Message=OpenAccess_3.3_EstablishConnectionResponse)
      EstablishSessionResponse Type EstablishSessionResponse urn:openaccess
      Indicates success or failure of a login attempt. The successful response contains a session token to be used for other API calls
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
  12. KeepAlive
    Tests connectivity to the Open Access Server and keeps the HTTP connection active by sending a message to the server at regular intervals. If the the KeepAlive message reaches the server, a KeepAliveResponse message will be returned which contains the string "OpenAccess <version> - I am Alive".
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    KeepAlive
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_KeepAlive)
      Empty
    Output:
  13. Logout
    Logout the User Session from the Open Access Server.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    Logout
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_Logout)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  14. RetrieveAreaInformation
    Retrieve Area information for a specified Area.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveAreaInformation
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveAreaInformation)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  15. RetrieveAreaPortfolioInformation
    Retrieve Area/Portfolio Informations for specified Area(s) and/or Portfolio(s). Absence of Areas and/or Portfolios means all, so if nothing is specified the result is the same as RetrieveViewableAreaPortfolioInformations
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveAreaPortfolioInformation
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveAreaPortfolioInformation)
      AreaPortfolioInformationQuery Type AreaPortfolioInformationQuery urn:openaccess
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  16. RetrieveAuctionInformation
    Retrieve next <NumberOfAuctions> Informations for specified <Area>(s).
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveAuctionInformation
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveAuctionInformation)
      AuctionInformationQuery Type AuctionInformationQuery urn:openaccess
      • <Area> - mandatory, unbounded Type string http://www.w3.org/2001/XMLSchema
        Area Name(s) to query
      • <NumberOfAuctions> - mandatory Type int http://www.w3.org/2001/XMLSchema restriction { minInclusive="1", maxInclusive="50" }
        The Number of the next Auctions.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  17. RetrieveBlockOrders
    Retrieve all Block Orders matching the search parameter in the Block Order Identifier Object.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveBlockOrders
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveBlockOrders)
      BlockOrderIdentifier Type BlockOrderIdentifier urn:openaccess
      This object contains the search parameters for block orders
      • Choice - mandatory
      • Choice - mandatory
      • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
        Comment field of the Block Orders.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Delivery Day the Order applies to.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Range of Delivery Days the Order applies to.
        • <timeIntervals> - optional, unbounded Type DateTimeRange urn:openaccess
          Time Interval to identify the Orders. Deprecated: for compatibilty reason only. Use deliveryDay | deliveryDays instead.
        • <AuctionIdentification> - optional, unbounded Type AuctionIdentification urn:openaccess
          0 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • <blockCode> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88', 'ALL' }
        Block Code the Order applies to.
      • <minBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Lowest Block Order ID to specify a range of Block Orders.
      • <maxBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Highest Block Order ID to specify a range of Block Orders.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveBlockOrdersResponse)
      RetrieveBlockOrdersAcknowledgement Type RetrieveBlockOrdersAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveBlockOrders message and contains the results of the search. Indicates success or failure of the message
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <blockOrders> - optional, nillable, unbounded Type BlockOrder urn:openaccess
        Collection of Block Orders found.
        • <blockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
          Block Order ID returned if the Block Order was accepted.
        • Choice - mandatory
        • Choice - mandatory
          • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Delivery Date of the Block Order. Only usable if only 1 Auction is defined per day.
          • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Applying Date of the Block Order. Deprecated: Use auctionIdentification or deliveryDay instead.
          • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
            Auction Identification.
            • Choice - mandatory
            • <name> - optional Type string http://www.w3.org/2001/XMLSchema
              The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • Choice - mandatory
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Comment field for the Block Order.
        • <periods> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
          In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  18. RetrieveComplexOrders
    Retrieve all Complex Orders matching the search parameter in the Order Identifier Object. Only the active versions of each Order are returned.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveComplexOrders
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveComplexOrders)
      ComplexOrderIdentifier Type ComplexOrderIdentification urn:openaccess
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Area for the Order.
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Portfolio the Order applies to.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The Delivery Day of the Order.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Date Range to search over.
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          1 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveComplexOrdersResponse)
      RetrieveComplexOrdersResult Type RetrieveComplexOrdersAcknowledgement urn:openaccess
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <Order> - optional, unbounded Type ComplexOrder urn:openaccess
        Collection of Complex Orders that match the search parameters.
        • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          List of Auction Identifiers.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • <Curve> - mandatory, unbounded Type Curve urn:openaccess
          List of Curves.
        • <fixed_Term> - mandatory Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="18", fractionDigits="11" }
          Fixed Term of the Complex Order. (Zero value if no Fixed Term is defined).
        • <variable_Term> - mandatory Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="18", fractionDigits="11" }
          Variable Term. (Zero value if no Variable Term is defined).
        • <increase_Gradient> - optional, nillable Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="11", fractionDigits="5", minInclusive="0" }
          Increase Gradient. ( NULL value if no Increase Gradient is defined).
        • <decrease_Gradient> - optional, nillable Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="11", fractionDigits="5", minInclusive="0" }
          Decrease Gradient. (NULL value if no Decrease Gradient is defined)
        • <schedule_Stop> - mandatory Type int http://www.w3.org/2001/XMLSchema restriction { totalDigits="2", minInclusive="0" }
          Number of Scheduled Stop Periods starting from Period #1. Value should be non-negative. (Zero value if no Schedule Stop is defined).
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  19. RetrieveExclusiveGroupWithId
    Answers all Block Orders for this Exclusive Group ID. Due to required support of previous versions (lower than 1.9) of the WSDL, this call must use deprecated output until such support is no longer required.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveExclusiveGroupWithId
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveExclusiveGroupWithId)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveExclusiveGroupWithIdResponse)
      RetrieveExclusiveGroupResult Type RetrieveExclusiveGroupAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveExclusiveGroupWithId message and contains the results of the search. Indicates success or failure of the message
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <BlockOrder> - optional, unbounded Type SmartBlockOrder urn:openaccess
        This Object contains the Block Orders matching the search parameters.
        • <blockCode> - mandatory Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88' }
          C01 - Standard Block Order. C02 - Linked Block Order. C04 - Exclusive Block Order. C88 - Loop Block Order (only availabe in services with version >= 3.2).
        • <blockCodePRM> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Consideration of this Parameter depends on the value of blockCode: C01 - Optional: The value is ignored. C02 - Mandatory: Reference to the blockIndex of the parent(s) (if more than 1 seperated by _ (underscore Unicode U+005F LOW LINE) ). C04 - Mandatory: Id of the exclusive group. C88 - Mandatory: Id of the loop group
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          An optional comment of the Block Order.
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <Period> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <MAR> - optional Type decimal http://www.w3.org/2001/XMLSchema restriction { , maxInclusive="1", totalDigits="3" }
          The Block Orders Minimum Acceptance Ratio (only availabe in services with version >= 3.2)
        • Choice - mandatory
        • Choice - mandatory
          • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Delivery Day of the Block Order. Only usable if only 1 auction is defined per day.
          • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Applying Date of the Block Order. Deprecated: For compatibility reasons only.
          • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
            The Auction Identification.
            • Choice - mandatory
            • <name> - optional Type string http://www.w3.org/2001/XMLSchema
              The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • Choice - mandatory
        • <blockOrderId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
          ID of the Block Order assigned by the Trading System.
        • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
          In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
      • <groupId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
        This Object contains the search parameters for the Block Orders.
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  20. RetrieveGroupForBlockId
    Answers all Block Orders belonging to the same Exclusive Group or Family. The Exclusive Group or Family will be identified by looking for a Group that has a member with this ID. Due to required support of previous versions (lower than 1.9) of the WSDL, this call must use deprecated output until such support is no longer required.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveGroupForBlockId
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveGroupForBlockId)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveGroupForBlockIdResponse)
      RetrieveGroupResult Type RetrieveGroupAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveGroupForBlockId message and contains the results of the search. Indicates success or failure of the message
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <BlockOrder> - optional, unbounded Type SmartBlockOrder urn:openaccess
        This Object contains the Block Orders matching the search parameters.
        • <blockCode> - mandatory Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88' }
          C01 - Standard Block Order. C02 - Linked Block Order. C04 - Exclusive Block Order. C88 - Loop Block Order (only availabe in services with version >= 3.2).
        • <blockCodePRM> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Consideration of this Parameter depends on the value of blockCode: C01 - Optional: The value is ignored. C02 - Mandatory: Reference to the blockIndex of the parent(s) (if more than 1 seperated by _ (underscore Unicode U+005F LOW LINE) ). C04 - Mandatory: Id of the exclusive group. C88 - Mandatory: Id of the loop group
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          An optional comment of the Block Order.
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <Period> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <MAR> - optional Type decimal http://www.w3.org/2001/XMLSchema restriction { , maxInclusive="1", totalDigits="3" }
          The Block Orders Minimum Acceptance Ratio (only availabe in services with version >= 3.2)
        • Choice - mandatory
        • Choice - mandatory
          • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Delivery Day of the Block Order. Only usable if only 1 auction is defined per day.
          • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Applying Date of the Block Order. Deprecated: For compatibility reasons only.
          • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
            The Auction Identification.
            • Choice - mandatory
            • <name> - optional Type string http://www.w3.org/2001/XMLSchema
              The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • Choice - mandatory
        • <blockOrderId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
          ID of the Block Order assigned by the Trading System.
        • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
          In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
      • <blockOrderId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
        This Object contains the search parameters for the Block Orders.
  21. RetrieveLoopBlocksWithGroupId
    Answers all Loop Block Orders (C88) in the family with the specified Group ID.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveLoopBlocksWithGroupId
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveLoopBlocksWithGroupId)
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveLoopBlocksWithGroupIdResponse)
      RetrieveLoopBlocksWithGroupIdResult Type RetrieveLoopBlocksWithGroupIdAcknowledgement urn:openaccess
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <BlockOrder> - optional, unbounded Type SmartBlockOrder urn:openaccess
        This Object contains the Block Orders matching the search parameters.
        • <blockCode> - mandatory Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88' }
          C01 - Standard Block Order. C02 - Linked Block Order. C04 - Exclusive Block Order. C88 - Loop Block Order (only availabe in services with version >= 3.2).
        • <blockCodePRM> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Consideration of this Parameter depends on the value of blockCode: C01 - Optional: The value is ignored. C02 - Mandatory: Reference to the blockIndex of the parent(s) (if more than 1 seperated by _ (underscore Unicode U+005F LOW LINE) ). C04 - Mandatory: Id of the exclusive group. C88 - Mandatory: Id of the loop group
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          An optional comment of the Block Order.
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <Period> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <MAR> - optional Type decimal http://www.w3.org/2001/XMLSchema restriction { , maxInclusive="1", totalDigits="3" }
          The Block Orders Minimum Acceptance Ratio (only availabe in services with version >= 3.2)
        • Choice - mandatory
        • Choice - mandatory
          • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Delivery Day of the Block Order. Only usable if only 1 auction is defined per day.
          • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Applying Date of the Block Order. Deprecated: For compatibility reasons only.
          • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
            The Auction Identification.
            • Choice - mandatory
            • <name> - optional Type string http://www.w3.org/2001/XMLSchema
              The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • Choice - mandatory
        • <blockOrderId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
          ID of the Block Order assigned by the Trading System.
        • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
          In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
      • <groupId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
        This Object contains the search parameters for the Block Orders.
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  22. RetrieveMarketResultsFor
    Retrieve the Market Results for specified Areas.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveMarketResultsFor
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveMarketResultsFor)
      MarketResultIdentifier Type MarketResultIdentifier urn:openaccess
      This Object identifies the Areas and the Auction details for which the Market Results are requested
      • Choice - mandatory
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Applying Date for the Market Results.
        • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Applying Date for the Market Results. Deprecated: Use Delivery Day or Auction Identification instead.
        • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
          Identifies the Auction for the Market Results.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  23. RetrieveMessagesUnreadOnly
    Retrieve the Messages the user has permission to read. If the parameter is true it only returns the messages still unread and if the parameter is false it returns all the messages.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveMessagesUnreadOnly
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveMessagesUnreadOnly)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  24. RetrieveOrders
    Retrieve all Hourly/Stepwise Orders matching the search parameter in the Order Identifier Object. Only the active versions of each order are returned.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveOrders
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveOrders)
      OrderIdentifier Type OrderIdentifier urn:openaccess
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Area for the Order.
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Portfolio the Order applies to.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The Delivery Day of the Order.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Date Range to search over.
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          1 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveOrdersResponse)
      RetrieveOrdersResult Type RetrieveOrdersAcknowledgement urn:openaccess
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  25. RetrieveSmartBlockOrders
    Retrieve all Block Orders matching the search parameter in the Block Order Identifier.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveSmartBlockOrders
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveSmartBlockOrders)
      BlockOrderIdentifier Type BlockOrderIdentifier urn:openaccess
      This object contains the search parameters for block orders
      • Choice - mandatory
      • Choice - mandatory
      • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
        Comment field of the Block Orders.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Delivery Day the Order applies to.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Range of Delivery Days the Order applies to.
        • <timeIntervals> - optional, unbounded Type DateTimeRange urn:openaccess
          Time Interval to identify the Orders. Deprecated: for compatibilty reason only. Use deliveryDay | deliveryDays instead.
        • <AuctionIdentification> - optional, unbounded Type AuctionIdentification urn:openaccess
          0 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • <blockCode> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88', 'ALL' }
        Block Code the Order applies to.
      • <minBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Lowest Block Order ID to specify a range of Block Orders.
      • <maxBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Highest Block Order ID to specify a range of Block Orders.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveSmartBlockOrdersResponse)
      RetrieveSmartBlockOrdersAcknowledgement Type RetrieveSmartBlockOrdersAcknowledgement urn:openaccess
      This object is used as result for the new RetrieveSmartBlockOrders call. In difference from the RetrieveBlocksAcknowledgement it contains Block Orders which additionally have a Block Code and a BlockCodePRM.
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <blockOrders> - optional, nillable, unbounded Type SmartBlockOrder urn:openaccess
        Collection of Block Orders found.
        • <blockCode> - mandatory Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88' }
          C01 - Standard Block Order. C02 - Linked Block Order. C04 - Exclusive Block Order. C88 - Loop Block Order (only availabe in services with version >= 3.2).
        • <blockCodePRM> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Consideration of this Parameter depends on the value of blockCode: C01 - Optional: The value is ignored. C02 - Mandatory: Reference to the blockIndex of the parent(s) (if more than 1 seperated by _ (underscore Unicode U+005F LOW LINE) ). C04 - Mandatory: Id of the exclusive group. C88 - Mandatory: Id of the loop group
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          An optional comment of the Block Order.
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <Period> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <MAR> - optional Type decimal http://www.w3.org/2001/XMLSchema restriction { , maxInclusive="1", totalDigits="3" }
          The Block Orders Minimum Acceptance Ratio (only availabe in services with version >= 3.2)
        • Choice - mandatory
        • Choice - mandatory
          • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Delivery Day of the Block Order. Only usable if only 1 auction is defined per day.
          • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Applying Date of the Block Order. Deprecated: For compatibility reasons only.
          • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
            The Auction Identification.
            • Choice - mandatory
            • <name> - optional Type string http://www.w3.org/2001/XMLSchema
              The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • Choice - mandatory
        • <blockOrderId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
          ID of the Block Order assigned by the Trading System.
        • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
          In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  26. RetrieveTradableAreaPortfolioInformations
    Retrieve Area/Portfolio Informations for specified Area(s) and/or Portfolio(s).
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveTradableAreaPortfolioInformations
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveTradableAreaPortfolioInformations)
      Empty
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  27. RetrieveTradableAreaSets
    Retrieve Area Set names that are both active and that the User Session is permitted to trade on.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveTradableAreaSets
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveTradableAreaSets)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveTradableAreaSetsResponse)
      RetrieveTradeableAreaSetsAcknowledgement Type RetrieveTradeableAreaSetsAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveTradeableAreaSets message. Contains a collection of area Names that the user session is allowed to trade on. Indicates success or failure of the message
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  28. RetrieveTradableAreas
    Retrieve all Area names which are opened for trade.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveTradableAreas
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveTradableAreas)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveTradableAreasResponse)
      RetrieveTradableAreasAcknowledgement Type RetrieveTradableAreasAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveTradableAreas and contain a collection of area Names. Indicates success or failure of the message
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  29. RetrieveTradablePortfolios
    Retrieve Portfolio names that a User Session is allowed to trade on and are open in the Auction.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveTradablePortfolios
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveTradablePortfolios)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveTradablePortfoliosResponse)
      RetrieveTradablePortfoliosAcknowledgement Type RetrieveTradablePortfoliosAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveTradablePortfolios message. It contains a collection of portfolios names that the user session is allowed to trade on
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  30. RetrieveTradesReportFor
    Retrieve a trade report identified and limited by the TradeReportOptions
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveTradesReportFor
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveTradesReportFor)
      TradeReportOptions Type TradeReportOptions urn:openaccess
      • Choice - mandatory
        • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
          Identifies the auction for the trade report.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The delivery date for the trade report.
      • <MemberName> - optional Type string http://www.w3.org/2001/XMLSchema
        MemberName: if MemberName information is omitted or empty, then the information for all the members the user has access to is exported; otherwise only for the indicated member
      • <AreaSet> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Identify the AreaSet of an Auction
      • @IndexType boolean http://www.w3.org/2001/XMLSchema
        Index (Boolean, default: True): if false then MarketAreaIndex (and all its children) are not included in the report
      • @TradeAreaType boolean http://www.w3.org/2001/XMLSchema
        TradeArea (Boolean, default: True): if false then TradeArea tag (and all its children) are not included in the report
      • @CurveType boolean http://www.w3.org/2001/XMLSchema
        Curve (Boolean, default: False); not used yet: if false then Order.Period.Curve is not included in the report. If Curve is true and TradeArea is false, then TradeArea tag (and all its children) are not included in the report
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  31. RetrieveViewableAreaPortfolioInformations
    Retrieve Area/Portfolio Informations for specified Area(s) and/or Portfolio(s).
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveViewableAreaPortfolioInformations
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveViewableAreaPortfolioInformations)
      Empty
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  32. RetrieveViewableAreas
    Retrieve all Area names the User Session has permissions to view.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveViewableAreas
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveViewableAreas)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveViewableAreasResponse)
      RetrieveViewableAreasAcknowledgement Type RetrieveViewableAreasAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveViewableAreas and contain a collection of area Names. Indicates success or failure of the message
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  33. RetrieveViewablePortfolios
    Retrieve all Portfolio names the User Sessions has permissions to view.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveViewablePortfolios
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveViewablePortfolios)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.3_RetrieveViewablePortfoliosResponse)
      RetrieveViewablePortfoliosAcknowledgement Type RetrieveViewablePortfoliosAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveViewablePortfolios message. Contains a collection of portfolios names that the user session is allowed to view. Indicates success or failure of the message view.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  34. SetMessagesAsRead
    Set already existing messages as read.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    SetMessagesAsRead
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_SetMessagesAsRead)
      MessageIdentifier Type MessageIdentifier urn:openaccess
      This object contains the search parameters of the message
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  35. SetNewPassword
    Change the user password. The new password must meet the following requirements: It must contain between 8 and 30 characters. It must contain at least 3 of the following: symbol (e.g. ',', '&', '~', ']'), digit (e.g. '1', '7', '0'), uppercase letter (e.g. 'E', 'T', 'S'), lowercase letter (e.g. 'e', 't', 's'). It must not contain composed characters (e.g. the characters represented by Unicode code points U+00E2, U+00E9, U+00EA). It may include the space character; this counts as a symbol. It must not contain a sequence of three or more instances of the same character.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    SetNewPassword
    Input:
    • Body (use=literal, Message=OpenAccess_3.3_SetNewPassword)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:

Port Type: OpenAccess_3.4_OpenAccessPortType

Description:
Version: 3.4.2-Api 3.4
  1. CancelBlockOrder
    Cancel a specified range of Block Orders.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelBlockOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_CancelBlockOrder)
      BlockOrderIdentifier Type BlockOrderIdentifier urn:openaccess
      This object contains the search parameters for block orders
      • Choice - mandatory
      • Choice - mandatory
      • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
        Comment field of the Block Orders.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Delivery Day the Order applies to.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Range of Delivery Days the Order applies to.
        • <timeIntervals> - optional, unbounded Type DateTimeRange urn:openaccess
          Time Interval to identify the Orders. Deprecated: for compatibilty reason only. Use deliveryDay | deliveryDays instead.
        • <AuctionIdentification> - optional, unbounded Type AuctionIdentification urn:openaccess
          0 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • <blockCode> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88', 'ALL' }
        Block Code the Order applies to.
      • <minBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Lowest Block Order ID to specify a range of Block Orders.
      • <maxBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Highest Block Order ID to specify a range of Block Orders.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  2. CancelComplexOrder
    Cancel already submitted Complex Orders.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelComplexOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_CancelComplexOrder)
      ComplexOrderIdentifier Type ComplexOrderIdentification urn:openaccess
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Area for the Order.
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Portfolio the Order applies to.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The Delivery Day of the Order.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Date Range to search over.
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          1 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  3. CancelExclusiveGroupWithId
    Cancel all Block Orders for this Exclusive Group ID.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelExclusiveGroupWithId
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_CancelExclusiveGroupWithId)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  4. CancelGroupForBlockId
    Cancel all Block Orders belonging to the same Exclusive Group or Family as the identified Block Order.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelGroupForBlockId
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_CancelGroupForBlockId)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  5. CancelLoopBlocksWithGroupId
    Cancel all Loop Block Orders (C88) in the family with the specified Group ID.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelLoopBlocksWithGroupId
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_CancelLoopBlocksWithGroupId)
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  6. CancelOrder
    Cancel already submitted Daily Orders.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_CancelOrder)
      OrderIdentifier Type OrderIdentifier urn:openaccess
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Area for the Order.
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Portfolio the Order applies to.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The Delivery Day of the Order.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Date Range to search over.
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          1 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  7. EnterBlockOrder
    Enter a Block Order for a specific date.
    Additional Rules: 1. Modification of a Block Order is accomplished the same as Daily Order entry. A new block order is sent and the old one is overwritten. 2. Only C01 Block Orders can be Entered/Modified
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EnterBlockOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_EnterBlockOrder)
      blockOrder Type BlockOrder urn:openaccess
      This object contains the details for a block order
      • <blockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Block Order ID returned if the Block Order was accepted.
      • Choice - mandatory
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Delivery Date of the Block Order. Only usable if only 1 Auction is defined per day.
        • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Applying Date of the Block Order. Deprecated: Use auctionIdentification or deliveryDay instead.
        • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
          Auction Identification.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • Choice - mandatory
      • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
        Price of the Block Order.
      • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
        Comment field for the Block Order.
      • <periods> - mandatory, max 100 Type BlockPeriod urn:openaccess
        Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
      • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
        In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  8. EnterBlockOrderBatch
    Submit a Batch of Block Orders for the same Portfolio, Area and Applying Date.
    Additional Rules: Modification of a Block Order is accomplished the same as EnterBlockOrder.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EnterBlockOrderBatch
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_EnterBlockOrderBatch)
      blockOrderBatch Type BlockOrderBatch urn:openaccess
      Contains the details for entering/modifying a set of block orders
      • Choice - mandatory
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Delivery Day of the Block Orders. Delivery Day can only be used if exacly one Auction is defined. Otherwise you have to use auctionIdentification
        • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Applying Date of the Block Orders. Deprecated: Use Delivery Day instead.
        • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
          Auction Identification of the Block Orders.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • Choice - mandatory
      • <BlockOrder> - mandatory, unbounded Type BlockOrderForBatch urn:openaccess
        Collection of Block Orders that will be entered/modified within this Batch.
        • <blockCode> - mandatory Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88' }
          C01 - Standard Block Order. C02 - Linked Block Order. C04 - Exclusive Block Order. C88 - Loop Block Order (only availabe in services with version >= 3.2).
        • <blockCodePRM> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Consideration of this Parameter depends on the value of blockCode: C01 - Optional: The value is ignored. C02 - Mandatory: Reference to the blockIndex of the parent(s) (if more than 1 seperated by _ (underscore Unicode U+005F LOW LINE) ). C04 - Mandatory: Id of the exclusive group. C88 - Mandatory: Id of the loop group
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          An optional comment of the Block Order.
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <Period> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <MAR> - optional Type decimal http://www.w3.org/2001/XMLSchema restriction { , maxInclusive="1", totalDigits="3" }
          The Block Orders Minimum Acceptance Ratio (only availabe in services with version >= 3.2)
        • <BlockIndex> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
          Virtual or Real Block ID. If a Block Order for Portfolio, Area and Applying Date with this ID exists the System triggers a Modification. Otherwise it is treated as a new Block Order.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  9. EnterComplexOrder
    Enter Complex Orders for specific Auction identification(s).
    Additional Rules: 1. Complex Orders are modified only by replacement. By sending in a new Order, the old Order is overwritten with the new values. 2. If more than one Auction Identification is submitted, rule one is executed on each Auction that is specified with the same values.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EnterComplexOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_EnterComplexOrder)
      ComplexOrder Type ComplexOrder urn:openaccess
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
      • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
        List of Auction Identifiers.
        • Choice - mandatory
        • <name> - optional Type string http://www.w3.org/2001/XMLSchema
          The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
        • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
          Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • <Curve> - mandatory, unbounded Type Curve urn:openaccess
        List of Curves.
      • <fixed_Term> - mandatory Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="18", fractionDigits="11" }
        Fixed Term of the Complex Order. (Zero value if no Fixed Term is defined).
      • <variable_Term> - mandatory Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="18", fractionDigits="11" }
        Variable Term. (Zero value if no Variable Term is defined).
      • <increase_Gradient> - optional, nillable Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="11", fractionDigits="5", minInclusive="0" }
        Increase Gradient. ( NULL value if no Increase Gradient is defined).
      • <decrease_Gradient> - optional, nillable Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="11", fractionDigits="5", minInclusive="0" }
        Decrease Gradient. (NULL value if no Decrease Gradient is defined)
      • <schedule_Stop> - mandatory Type int http://www.w3.org/2001/XMLSchema restriction { totalDigits="2", minInclusive="0" }
        Number of Scheduled Stop Periods starting from Period #1. Value should be non-negative. (Zero value if no Schedule Stop is defined).
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  10. EnterOrder
    Enter Daily Orders for a specified date.
    Additional Rules: 1. Daily Orders are modified only by replacement. By sending in a new order, the old order is overwritten with the new values.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EnterOrder
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_EnterOrder)
      Order Type Order urn:openaccess
      This object contains the data for the Order. AuctionIdentification must occur not more than once.
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Area for the Order.
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Portfolio the Order applies to.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The Delivery Day of the Order.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Date Range to search over.
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          1 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • <Curve> - mandatory, max 100 Type Curve urn:openaccess
        Collection of Curves.
      • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
        In output: The settlement currency is included in every order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  11. EstablishConnection
    Login to the Open Access Server and start a User Session.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EstablishConnection
    Input:
    Output:
    • Body (use=literal, Message=OpenAccess_3.4_EstablishConnectionResponse)
      EstablishSessionResponse Type EstablishSessionResponse urn:openaccess
      Indicates success or failure of a login attempt. The successful response contains a session token to be used for other API calls
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
  12. KeepAlive
    Tests connectivity to the Open Access Server and keeps the HTTP connection active by sending a message to the server at regular intervals. If the the KeepAlive message reaches the server, a KeepAliveResponse message will be returned which contains the string "OpenAccess <version> - I am Alive".
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    KeepAlive
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_KeepAlive)
      Empty
    Output:
  13. Logout
    Logout the User Session from the Open Access Server.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    Logout
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_Logout)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  14. ResetPassword
    Set a new password, which is valid for 90 days.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    ResetPassword
    Input:
    Output:
  15. ResetPasswordRequestActivationCode
    Request a password reset code for user login name. If the request is successful a code will be sent to the email address for the login name. The code can be then sent with the ResetPassword message to set a new password for the user.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    ResetPasswordRequestActivationCode
    Input:
    Output:
  16. RetrieveAreaInformation
    Retrieve Area information for a specified Area.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveAreaInformation
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveAreaInformation)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  17. RetrieveAreaPortfolioInformation
    Retrieve Area/Portfolio Informations for specified Area(s) and/or Portfolio(s). Absence of Areas and/or Portfolios means all, so if nothing is specified the result is the same as RetrieveViewableAreaPortfolioInformations
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveAreaPortfolioInformation
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveAreaPortfolioInformation)
      AreaPortfolioInformationQuery Type AreaPortfolioInformationQuery urn:openaccess
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  18. RetrieveAuctionInformation
    Retrieve next <NumberOfAuctions> Informations for specified <Area>(s).
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveAuctionInformation
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveAuctionInformation)
      AuctionInformationQuery Type AuctionInformationQuery urn:openaccess
      • <Area> - mandatory, unbounded Type string http://www.w3.org/2001/XMLSchema
        Area Name(s) to query
      • <NumberOfAuctions> - mandatory Type int http://www.w3.org/2001/XMLSchema restriction { minInclusive="1", maxInclusive="50" }
        The Number of the next Auctions.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  19. RetrieveBlockOrders
    Retrieve all Block Orders matching the search parameter in the Block Order Identifier Object.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveBlockOrders
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveBlockOrders)
      BlockOrderIdentifier Type BlockOrderIdentifier urn:openaccess
      This object contains the search parameters for block orders
      • Choice - mandatory
      • Choice - mandatory
      • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
        Comment field of the Block Orders.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Delivery Day the Order applies to.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Range of Delivery Days the Order applies to.
        • <timeIntervals> - optional, unbounded Type DateTimeRange urn:openaccess
          Time Interval to identify the Orders. Deprecated: for compatibilty reason only. Use deliveryDay | deliveryDays instead.
        • <AuctionIdentification> - optional, unbounded Type AuctionIdentification urn:openaccess
          0 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • <blockCode> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88', 'ALL' }
        Block Code the Order applies to.
      • <minBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Lowest Block Order ID to specify a range of Block Orders.
      • <maxBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Highest Block Order ID to specify a range of Block Orders.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveBlockOrdersResponse)
      RetrieveBlockOrdersAcknowledgement Type RetrieveBlockOrdersAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveBlockOrders message and contains the results of the search. Indicates success or failure of the message
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <blockOrders> - optional, nillable, unbounded Type BlockOrder urn:openaccess
        Collection of Block Orders found.
        • <blockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
          Block Order ID returned if the Block Order was accepted.
        • Choice - mandatory
        • Choice - mandatory
          • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Delivery Date of the Block Order. Only usable if only 1 Auction is defined per day.
          • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Applying Date of the Block Order. Deprecated: Use auctionIdentification or deliveryDay instead.
          • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
            Auction Identification.
            • Choice - mandatory
            • <name> - optional Type string http://www.w3.org/2001/XMLSchema
              The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • Choice - mandatory
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Comment field for the Block Order.
        • <periods> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
          In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  20. RetrieveCentralCounterPartyAndSettlementMemberNames
    Retrieve the names of all central counterparties and settlement members
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveCentralCounterPartyAndSettlementMemberNames
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveCentralCounterPartyAndSettlementMemberNames)
      Empty
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  21. RetrieveComplexOrders
    Retrieve all Complex Orders matching the search parameter in the Order Identifier Object. Only the active versions of each Order are returned.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveComplexOrders
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveComplexOrders)
      ComplexOrderIdentifier Type ComplexOrderIdentification urn:openaccess
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Area for the Order.
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Portfolio the Order applies to.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The Delivery Day of the Order.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Date Range to search over.
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          1 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveComplexOrdersResponse)
      RetrieveComplexOrdersResult Type RetrieveComplexOrdersAcknowledgement urn:openaccess
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <Order> - optional, unbounded Type ComplexOrder urn:openaccess
        Collection of Complex Orders that match the search parameters.
        • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          List of Auction Identifiers.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • <Curve> - mandatory, unbounded Type Curve urn:openaccess
          List of Curves.
        • <fixed_Term> - mandatory Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="18", fractionDigits="11" }
          Fixed Term of the Complex Order. (Zero value if no Fixed Term is defined).
        • <variable_Term> - mandatory Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="18", fractionDigits="11" }
          Variable Term. (Zero value if no Variable Term is defined).
        • <increase_Gradient> - optional, nillable Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="11", fractionDigits="5", minInclusive="0" }
          Increase Gradient. ( NULL value if no Increase Gradient is defined).
        • <decrease_Gradient> - optional, nillable Type decimal http://www.w3.org/2001/XMLSchema restriction { totalDigits="11", fractionDigits="5", minInclusive="0" }
          Decrease Gradient. (NULL value if no Decrease Gradient is defined)
        • <schedule_Stop> - mandatory Type int http://www.w3.org/2001/XMLSchema restriction { totalDigits="2", minInclusive="0" }
          Number of Scheduled Stop Periods starting from Period #1. Value should be non-negative. (Zero value if no Schedule Stop is defined).
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  22. RetrieveExclusiveGroupWithId
    Answers all Block Orders for this Exclusive Group ID. Due to required support of previous versions (lower than 1.9) of the WSDL, this call must use deprecated output until such support is no longer required.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveExclusiveGroupWithId
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveExclusiveGroupWithId)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveExclusiveGroupWithIdResponse)
      RetrieveExclusiveGroupResult Type RetrieveExclusiveGroupAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveExclusiveGroupWithId message and contains the results of the search. Indicates success or failure of the message
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <BlockOrder> - optional, unbounded Type SmartBlockOrder urn:openaccess
        This Object contains the Block Orders matching the search parameters.
        • <blockCode> - mandatory Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88' }
          C01 - Standard Block Order. C02 - Linked Block Order. C04 - Exclusive Block Order. C88 - Loop Block Order (only availabe in services with version >= 3.2).
        • <blockCodePRM> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Consideration of this Parameter depends on the value of blockCode: C01 - Optional: The value is ignored. C02 - Mandatory: Reference to the blockIndex of the parent(s) (if more than 1 seperated by _ (underscore Unicode U+005F LOW LINE) ). C04 - Mandatory: Id of the exclusive group. C88 - Mandatory: Id of the loop group
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          An optional comment of the Block Order.
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <Period> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <MAR> - optional Type decimal http://www.w3.org/2001/XMLSchema restriction { , maxInclusive="1", totalDigits="3" }
          The Block Orders Minimum Acceptance Ratio (only availabe in services with version >= 3.2)
        • Choice - mandatory
        • Choice - mandatory
          • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Delivery Day of the Block Order. Only usable if only 1 auction is defined per day.
          • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Applying Date of the Block Order. Deprecated: For compatibility reasons only.
          • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
            The Auction Identification.
            • Choice - mandatory
            • <name> - optional Type string http://www.w3.org/2001/XMLSchema
              The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • Choice - mandatory
        • <blockOrderId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
          ID of the Block Order assigned by the Trading System.
        • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
          In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
      • <groupId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
        This Object contains the search parameters for the Block Orders.
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  23. RetrieveGroupForBlockId
    Answers all Block Orders belonging to the same Exclusive Group or Family. The Exclusive Group or Family will be identified by looking for a Group that has a member with this ID. Due to required support of previous versions (lower than 1.9) of the WSDL, this call must use deprecated output until such support is no longer required.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveGroupForBlockId
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveGroupForBlockId)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveGroupForBlockIdResponse)
      RetrieveGroupResult Type RetrieveGroupAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveGroupForBlockId message and contains the results of the search. Indicates success or failure of the message
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <BlockOrder> - optional, unbounded Type SmartBlockOrder urn:openaccess
        This Object contains the Block Orders matching the search parameters.
        • <blockCode> - mandatory Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88' }
          C01 - Standard Block Order. C02 - Linked Block Order. C04 - Exclusive Block Order. C88 - Loop Block Order (only availabe in services with version >= 3.2).
        • <blockCodePRM> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Consideration of this Parameter depends on the value of blockCode: C01 - Optional: The value is ignored. C02 - Mandatory: Reference to the blockIndex of the parent(s) (if more than 1 seperated by _ (underscore Unicode U+005F LOW LINE) ). C04 - Mandatory: Id of the exclusive group. C88 - Mandatory: Id of the loop group
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          An optional comment of the Block Order.
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <Period> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <MAR> - optional Type decimal http://www.w3.org/2001/XMLSchema restriction { , maxInclusive="1", totalDigits="3" }
          The Block Orders Minimum Acceptance Ratio (only availabe in services with version >= 3.2)
        • Choice - mandatory
        • Choice - mandatory
          • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Delivery Day of the Block Order. Only usable if only 1 auction is defined per day.
          • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Applying Date of the Block Order. Deprecated: For compatibility reasons only.
          • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
            The Auction Identification.
            • Choice - mandatory
            • <name> - optional Type string http://www.w3.org/2001/XMLSchema
              The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • Choice - mandatory
        • <blockOrderId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
          ID of the Block Order assigned by the Trading System.
        • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
          In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
      • <blockOrderId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
        This Object contains the search parameters for the Block Orders.
  24. RetrieveLoopBlocksWithGroupId
    Answers all Loop Block Orders (C88) in the family with the specified Group ID.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveLoopBlocksWithGroupId
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveLoopBlocksWithGroupId)
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveLoopBlocksWithGroupIdResponse)
      RetrieveLoopBlocksWithGroupIdResult Type RetrieveLoopBlocksWithGroupIdAcknowledgement urn:openaccess
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <BlockOrder> - optional, unbounded Type SmartBlockOrder urn:openaccess
        This Object contains the Block Orders matching the search parameters.
        • <blockCode> - mandatory Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88' }
          C01 - Standard Block Order. C02 - Linked Block Order. C04 - Exclusive Block Order. C88 - Loop Block Order (only availabe in services with version >= 3.2).
        • <blockCodePRM> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Consideration of this Parameter depends on the value of blockCode: C01 - Optional: The value is ignored. C02 - Mandatory: Reference to the blockIndex of the parent(s) (if more than 1 seperated by _ (underscore Unicode U+005F LOW LINE) ). C04 - Mandatory: Id of the exclusive group. C88 - Mandatory: Id of the loop group
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          An optional comment of the Block Order.
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <Period> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <MAR> - optional Type decimal http://www.w3.org/2001/XMLSchema restriction { , maxInclusive="1", totalDigits="3" }
          The Block Orders Minimum Acceptance Ratio (only availabe in services with version >= 3.2)
        • Choice - mandatory
        • Choice - mandatory
          • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Delivery Day of the Block Order. Only usable if only 1 auction is defined per day.
          • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Applying Date of the Block Order. Deprecated: For compatibility reasons only.
          • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
            The Auction Identification.
            • Choice - mandatory
            • <name> - optional Type string http://www.w3.org/2001/XMLSchema
              The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • Choice - mandatory
        • <blockOrderId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
          ID of the Block Order assigned by the Trading System.
        • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
          In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
      • <groupId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
        This Object contains the search parameters for the Block Orders.
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  25. RetrieveMarketResultsFor
    Retrieve the Market Results for specified Areas.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveMarketResultsFor
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveMarketResultsFor)
      MarketResultIdentifier Type MarketResultIdentifier urn:openaccess
      This Object identifies the Areas and the Auction details for which the Market Results are requested
      • Choice - mandatory
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Applying Date for the Market Results.
        • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Applying Date for the Market Results. Deprecated: Use Delivery Day or Auction Identification instead.
        • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
          Identifies the Auction for the Market Results.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  26. RetrieveMessagesUnreadOnly
    Retrieve the Messages the user has permission to read. If the parameter is true it only returns the messages still unread and if the parameter is false it returns all the messages.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveMessagesUnreadOnly
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveMessagesUnreadOnly)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  27. RetrieveOrders
    Retrieve all Hourly/Stepwise Orders matching the search parameter in the Order Identifier Object. Only the active versions of each order are returned.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveOrders
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveOrders)
      OrderIdentifier Type OrderIdentifier urn:openaccess
      • <area> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Area for the Order.
      • <portfolio> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Name of the Portfolio the Order applies to.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The Delivery Day of the Order.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Date Range to search over.
        • <AuctionIdentification> - mandatory, unbounded Type AuctionIdentification urn:openaccess
          1 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveOrdersResponse)
      RetrieveOrdersResult Type RetrieveOrdersAcknowledgement urn:openaccess
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  28. RetrieveSmartBlockOrders
    Retrieve all Block Orders matching the search parameter in the Block Order Identifier.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveSmartBlockOrders
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveSmartBlockOrders)
      BlockOrderIdentifier Type BlockOrderIdentifier urn:openaccess
      This object contains the search parameters for block orders
      • Choice - mandatory
      • Choice - mandatory
      • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
        Comment field of the Block Orders.
      • Choice - mandatory
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          Delivery Day the Order applies to.
        • <deliveryDays> - mandatory Type DateRange urn:openaccess
          Range of Delivery Days the Order applies to.
        • <timeIntervals> - optional, unbounded Type DateTimeRange urn:openaccess
          Time Interval to identify the Orders. Deprecated: for compatibilty reason only. Use deliveryDay | deliveryDays instead.
        • <AuctionIdentification> - optional, unbounded Type AuctionIdentification urn:openaccess
          0 or more Auction Identifications.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
      • <blockCode> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88', 'ALL' }
        Block Code the Order applies to.
      • <minBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Lowest Block Order ID to specify a range of Block Orders.
      • <maxBlockOrderId> - optional, nillable Type integer http://www.w3.org/2001/XMLSchema
        Highest Block Order ID to specify a range of Block Orders.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveSmartBlockOrdersResponse)
      RetrieveSmartBlockOrdersAcknowledgement Type RetrieveSmartBlockOrdersAcknowledgement urn:openaccess
      This object is used as result for the new RetrieveSmartBlockOrders call. In difference from the RetrieveBlocksAcknowledgement it contains Block Orders which additionally have a Block Code and a BlockCodePRM.
      • <state> - mandatory Type string http://www.w3.org/2001/XMLSchema
        String indicating Reply Status. NAK and NOT FOUND are not necessarily Errors. - NOT FOUND is returned for example when a search fails. - NAK represents a negative answer to the call. - ERROR OCCURED means that an error happened and there is most likely an error object in the errors slot.
      • <errors> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. It may contain an Error even when the state is ACK. In this case, the contents should be treated as a Warning. Used in legacy versions. Version 3.4 has dedicated Error and Warning elements.
      • <error> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the error message. Supported from version 3.4 onwards.
      • <warning> - optional, nillable, unbounded Type ErrorObject urn:openaccess
        Contains the warning message. Supported from version 3.4 onwards.
      • <blockOrders> - optional, nillable, unbounded Type SmartBlockOrder urn:openaccess
        Collection of Block Orders found.
        • <blockCode> - mandatory Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'C01', 'C02', 'C04', 'C88' }
          C01 - Standard Block Order. C02 - Linked Block Order. C04 - Exclusive Block Order. C88 - Loop Block Order (only availabe in services with version >= 3.2).
        • <blockCodePRM> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          Consideration of this Parameter depends on the value of blockCode: C01 - Optional: The value is ignored. C02 - Mandatory: Reference to the blockIndex of the parent(s) (if more than 1 seperated by _ (underscore Unicode U+005F LOW LINE) ). C04 - Mandatory: Id of the exclusive group. C88 - Mandatory: Id of the loop group
        • <comment> - optional, nillable Type string http://www.w3.org/2001/XMLSchema
          An optional comment of the Block Order.
        • <price> - mandatory Type decimal http://www.w3.org/2001/XMLSchema
          Price of the Block Order.
        • <Period> - mandatory, max 100 Type BlockPeriod urn:openaccess
          Collection of Block Periods specifying the Interval and the Volume. See BlockPeriod description.
        • <MAR> - optional Type decimal http://www.w3.org/2001/XMLSchema restriction { , maxInclusive="1", totalDigits="3" }
          The Block Orders Minimum Acceptance Ratio (only availabe in services with version >= 3.2)
        • Choice - mandatory
        • Choice - mandatory
          • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Delivery Day of the Block Order. Only usable if only 1 auction is defined per day.
          • <applyingDate> - mandatory Type date http://www.w3.org/2001/XMLSchema
            Applying Date of the Block Order. Deprecated: For compatibility reasons only.
          • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
            The Auction Identification.
            • Choice - mandatory
            • <name> - optional Type string http://www.w3.org/2001/XMLSchema
              The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • Choice - mandatory
        • <blockOrderId> - mandatory Type positiveInteger http://www.w3.org/2001/XMLSchema
          ID of the Block Order assigned by the Trading System.
        • <settlementCurrency> - optional Type string http://www.w3.org/2001/XMLSchema
          In output: The settlement currency is included in every block order contained in a response. In input: The settlement currency may be included in a request. If it is included, it will be validated against the area and portfolio specified in the request but otherwise ignored.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  29. RetrieveTradableAreaPortfolioInformations
    Retrieve Area/Portfolio Informations for specified Area(s) and/or Portfolio(s).
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveTradableAreaPortfolioInformations
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveTradableAreaPortfolioInformations)
      Empty
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  30. RetrieveTradableAreaSets
    Retrieve Area Set names that are both active and that the User Session is permitted to trade on.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveTradableAreaSets
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveTradableAreaSets)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveTradableAreaSetsResponse)
      RetrieveTradeableAreaSetsAcknowledgement Type RetrieveTradeableAreaSetsAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveTradeableAreaSets message. Contains a collection of area Names that the user session is allowed to trade on. Indicates success or failure of the message
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  31. RetrieveTradableAreas
    Retrieve all Area names which are opened for trade.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveTradableAreas
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveTradableAreas)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveTradableAreasResponse)
      RetrieveTradableAreasAcknowledgement Type RetrieveTradableAreasAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveTradableAreas and contain a collection of area Names. Indicates success or failure of the message
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  32. RetrieveTradablePortfolios
    Retrieve Portfolio names that a User Session is allowed to trade on and are open in the Auction.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveTradablePortfolios
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveTradablePortfolios)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveTradablePortfoliosResponse)
      RetrieveTradablePortfoliosAcknowledgement Type RetrieveTradablePortfoliosAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveTradablePortfolios message. It contains a collection of portfolios names that the user session is allowed to trade on
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  33. RetrieveTradesReportFor
    Retrieve a trade report identified and limited by the TradeReportOptions
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveTradesReportFor
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveTradesReportFor)
      TradeReportOptions Type TradeReportOptions urn:openaccess
      • Choice - mandatory
        • <auctionIdentification> - mandatory Type AuctionIdentification urn:openaccess
          Identifies the auction for the trade report.
          • Choice - mandatory
          • <name> - optional Type string http://www.w3.org/2001/XMLSchema
            The Name of the Auction. In output: It is included in every AuctionIdentification contained in a response. In input: If UTCDateTime is used the name can be omitted; if AuctionDate is used and more than one auction is defined the name mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in an auction. It is included in every AuctionIdentification contained in a response. It is used in two different kinds of request: 1. Order entry/modification request: The duration element must be included in the request, and it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is empty or omitted entirely, the request will fail. 2. Order retrievel or auction cancellation request: The duration element may be included in the request. If it is included, it must have as its value exactly one of '15' min '30 min' or '60 min'. If the duration element is included in the request, the request is deemed to relate to the auction with the given duration for the auction date and market area specified in the request. If the duration element is omitted, the request is deemed to relate to all auctions for the auction date and market area specified in the request.
        • <deliveryDay> - mandatory Type date http://www.w3.org/2001/XMLSchema
          The delivery date for the trade report.
      • <MemberName> - optional Type string http://www.w3.org/2001/XMLSchema
        MemberName: if MemberName information is omitted or empty, then the information for all the members the user has access to is exported; otherwise only for the indicated member
      • <AreaSet> - mandatory Type string http://www.w3.org/2001/XMLSchema
        Identify the AreaSet of an Auction
      • @IndexType boolean http://www.w3.org/2001/XMLSchema
        Index (Boolean, default: True): if false then MarketAreaIndex (and all its children) are not included in the report
      • @TradeAreaType boolean http://www.w3.org/2001/XMLSchema
        TradeArea (Boolean, default: True): if false then TradeArea tag (and all its children) are not included in the report
      • @CurveType boolean http://www.w3.org/2001/XMLSchema
        Curve (Boolean, default: False); not used yet: if false then Order.Period.Curve is not included in the report. If Curve is true and TradeArea is false, then TradeArea tag (and all its children) are not included in the report
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  34. RetrieveTradingLimitExtendedDetails
    Retrieve trading limit extended details identified and limited by the TradingLimitExtendedDetailOptions
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveTradingLimitExtendedDetails
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveTradingLimitExtendedDetails)
      TradingLimitExtendedDetailOptions Type TradingLimitExtendedDetailOptions urn:openaccess
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  35. RetrieveTradingLimits
    Retrieve trading limits identified and limited by the TradingLimitOptions
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveTradingLimits
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveTradingLimits)
      TradingLimitOptions Type TradingLimitOptions urn:openaccess
      • <tradingLimitDay> - mandatory Type date http://www.w3.org/2001/XMLSchema restriction { pattern="[0-9][0-9][0-9][0-9]\-[01][0-9]\-[0-3][0-9]" }
        Trading Limit Day corresponds to a period of 24 hours, which can be on 2 days. This day is then different from the Auction or Delivery days.
      • <exchange> - optional Type string http://www.w3.org/2001/XMLSchema restriction { maxLength="40" }
        Exchange where the Trading Limits are applied.
      • <centralCounterParty> - optional Type string http://www.w3.org/2001/XMLSchema restriction { maxLength="10" }
        CCP associated to the Trading Limit.
      • <settlementMember> - optional, unbounded Type string http://www.w3.org/2001/XMLSchema restriction { maxLength="60" }
        SM associated to the Trading Limit.
      • <area> - optional, unbounded Type string http://www.w3.org/2001/XMLSchema restriction { maxLength="40" }
        The area.
      • <portfolio> - optional, unbounded Type string http://www.w3.org/2001/XMLSchema restriction { maxLength="32" }
        The portfolio.
      • <id> - optional Type integer http://www.w3.org/2001/XMLSchema
        Unique ID of the Trading Limit, as identified in the ETS database.
      • <version> - optional Type integer http://www.w3.org/2001/XMLSchema
        Version of a Trading Limit, as identified in the ETS database.
      • <currency> - optional Type string http://www.w3.org/2001/XMLSchema restriction { maxLength="3" }
        Currency of the Trading Limit.
      • <tl_Status> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { 'Cancelled', 'Created' }
        The status of a trading limit: "Created" or "Cancelled".
      • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '60MIN', '30MIN', '15MIN' }
        The duration.
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  36. RetrieveViewableAreaPortfolioInformations
    Retrieve Area/Portfolio Informations for specified Area(s) and/or Portfolio(s).
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveViewableAreaPortfolioInformations
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveViewableAreaPortfolioInformations)
      Empty
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
  37. RetrieveViewableAreas
    Retrieve all Area names the User Session has permissions to view.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveViewableAreas
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveViewableAreas)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveViewableAreasResponse)
      RetrieveViewableAreasAcknowledgement Type RetrieveViewableAreasAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveViewableAreas and contain a collection of area Names. Indicates success or failure of the message
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  38. RetrieveViewablePortfolios
    Retrieve all Portfolio names the User Sessions has permissions to view.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveViewablePortfolios
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveViewablePortfolios)
      Empty
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
    Output:
    • Body (use=literal, Message=OpenAccess_3.4_RetrieveViewablePortfoliosResponse)
      RetrieveViewablePortfoliosAcknowledgement Type RetrieveViewablePortfoliosAcknowledgement urn:openaccess
      Acknowledgement sent in response to the RetrieveViewablePortfolios message. Contains a collection of portfolios names that the user session is allowed to view. Indicates success or failure of the message view.
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=ResponseLimitationHeaderHeaderParts, Part=ResponseLimitationHeader, optional)
      ResponseLimitationHeader Element ResponseLimitationHeader urn:openaccess
      ResponseLimitationHeader can be used to restrict the result size of an API call. Element resultSize: here you can specify the maximum number of result elements your call must return. Element range: can be used to specify a dedicated range within the result you want as result set. Elements start/stop within the range don't specifies id's of objects. This values are offsets in the result set. Example: your call will return 120 orders and you specifiy a range start=25 stop=30, than you get 6 elements: element 25,26,27,28,29 and 30 independent of the order id's. Processing order: First the range restrictions are applied, then the resultSize restrictions will be used to modify the result set. For the example above that means, if you additionally to the range specify a resultSize of 3, your result set will only contain the elements 25,26,27 of the original result set.
  39. SetMessagesAsRead
    Set already existing messages as read.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    SetMessagesAsRead
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_SetMessagesAsRead)
      MessageIdentifier Type MessageIdentifier urn:openaccess
      This object contains the search parameters of the message
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  40. SetNewPassword
    Change the user password. The new password must meet the following requirements: It must contain between 8 and 30 characters. It must contain at least 3 of the following: symbol (e.g. ',', '&', '~', ']'), digit (e.g. '1', '7', '0'), uppercase letter (e.g. 'E', 'T', 'S'), lowercase letter (e.g. 'e', 't', 's'). It must not contain composed characters (e.g. the characters represented by Unicode code points U+00E2, U+00E9, U+00EA). It may include the space character; this counts as a symbol. It must not contain a sequence of three or more instances of the same character.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    SetNewPassword
    Input:
    • Body (use=literal, Message=OpenAccess_3.4_SetNewPassword)
    • Header (use=literal, Message=AsynchronousResponseHeaderHeaderParts, Part=AsynchronousResponseHeader)
      AsynchronousResponseHeader Element AsynchronousResponseHeader urn:openaccess
      Header required for most API calls to tell the Open Access Server if the reply is synchronous or not
    • Header (use=literal, Message=SessionTokenHeaderParts, Part=SessionToken)
      SessionToken Element SessionToken urn:openaccess
      Header that contains the sessionKey and the user ID of the user session. It is returned after an establish session message and successful login. It is needed as a header for most API calls.
      • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z0-9\-_ ]*[A-Z0-9]" }
        The user login name for the user session
      • <sessionKey> - mandatory Type SessionKey urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { minLength="10", maxLength="500", pattern="[0-9A-F]+" }
        The users session key that is used to lookup the current session in most of the API calls. This is a secure key
    Output:
  41. UpdatePassword
    Change the user password. The new password must meet the following requirements: It must contain between 8 and 30 characters. It must contain at least 3 of the following: symbol (e.g. ',', '&', '~', ']'), digit (e.g. '1', '7', '0'), uppercase letter (e.g. 'E', 'T', 'S'), lowercase letter (e.g. 'e', 't', 's'). It must not contain composed characters (e.g. the characters represented by Unicode code points U+00E2, U+00E9, U+00EA). It may include the space character; this counts as a symbol. It must not contain a sequence of three or more instances of the same character.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    UpdatePassword
    Input:
    Output:

Port Type: EchoOpenAccessPortType

Description:
Version: 3.4.2-Api 3.4
  1. Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EchoRequest
    Input:
    Output:
  2. Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    KeepAlive
    Input:
    • Body (use=literal, Message=EchoKeepAlive)
      Empty
    Output:

Schema

Attribute Form:
unqualified
Element Form:
unqualified
Target Namespace:
https://www.epexspot.com/AuctionMemberReport
Element Form:
qualified
Target Namespace:
urn:openaccess


Copyright © 2011 - 2015 Soops b.v.
Soops - Specialists in Object Technology
Tel: +31 (0) 20 6222844
Fax: +31 (0) 20 6360827
Web: www.soops.nl

Soops b.v.