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.3.100-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:
    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
    • 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-Z][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-Z][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-Z][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 for this 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-Z][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
    • 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-Z][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:
    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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
      • 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 _ ). C04 - Mandatory: Number of the exclusive 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-Z][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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
        • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
          Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
      • <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-Z][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:
    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
      • <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
        A Collection of returned errors. It may contain Error Objects too, if state is ACK. In this case, contents should be treated as Warnings.
      • <sessionToken> - optional, nillable Type SessionToken urn:openaccess
        Session Token used in other API calls as a Header Object in the request.
        • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z][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=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-Z][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.
    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-Z][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-Z][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-Z][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-Z][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
    • 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-Z][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
    • 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
    • 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-Z][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
        A Collection of returned errors. It may contain Error Objects too, if state is ACK. In this case, contents should be treated as Warnings.
      • <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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
        • <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-Z][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
    • 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-Z][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
  21. RetrieveLoopBlocksWithGroupId
    Answers all Block Orders for this Loop Block Orders(C88) with 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-Z][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
    • 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.
        • <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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
    • 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-Z][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_RetrieveMarketResultsForResponse)
      RetrieveMarketResultAcknowledgement Type RetrieveMarketResultAcknowledgement urn:openaccess
      Acknowledgement sent in response to a RetrieveMarketResultFor message and contains a collection with all the messages. 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.
  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-Z][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
    • 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-Z][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:
  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
    • 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-Z][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
        A Collection of returned errors. It may contain Error Objects too, if state is ACK. In this case, contents should be treated as Warnings.
      • <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 _ ). C04 - Mandatory: Number of the exclusive 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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
        • 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: Will only provided if the input provides AuctionIdentification. In input this value is ignored and should be omitted. The currency used for an order is bound to the area/portfolio link.
    • 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-Z][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-Z][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-Z][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-Z][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-Z][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-Z][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-Z][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. 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-Z][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.
    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-Z][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.3.100-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:
    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
    • 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-Z][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-Z][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-Z][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 for this 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-Z][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
    • 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-Z][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:
    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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
      • 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 _ ). C04 - Mandatory: Number of the exclusive 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-Z][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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
        • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
          Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
      • <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-Z][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:
    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
      • <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
        A Collection of returned errors. It may contain Error Objects too, if state is ACK. In this case, contents should be treated as Warnings.
      • <sessionToken> - optional, nillable Type SessionToken urn:openaccess
        Session Token used in other API calls as a Header Object in the request.
        • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z][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=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-Z][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.
    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-Z][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-Z][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-Z][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-Z][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
    • 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-Z][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
    • 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
    • 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-Z][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
        A Collection of returned errors. It may contain Error Objects too, if state is ACK. In this case, contents should be treated as Warnings.
      • <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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
        • <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-Z][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
    • 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-Z][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
  21. RetrieveLoopBlocksWithGroupId
    Answers all Block Orders for this Loop Block Orders(C88) with 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-Z][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
    • 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.
        • <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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
    • 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-Z][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_RetrieveMarketResultsForResponse)
      RetrieveMarketResultAcknowledgement Type RetrieveMarketResultAcknowledgement urn:openaccess
      Acknowledgement sent in response to a RetrieveMarketResultFor message and contains a collection with all the messages. 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.
  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-Z][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
    • 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-Z][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:
  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
    • 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-Z][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
        A Collection of returned errors. It may contain Error Objects too, if state is ACK. In this case, contents should be treated as Warnings.
      • <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 _ ). C04 - Mandatory: Number of the exclusive 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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
        • 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: Will only provided if the input provides AuctionIdentification. In input this value is ignored and should be omitted. The currency used for an order is bound to the area/portfolio link.
    • 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-Z][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-Z][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-Z][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-Z][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. 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-Z][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.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-Z][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.
  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.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-Z][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. 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.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-Z][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.
    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-Z][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.0_OpenAccessPortType

Description:
Version: 3.3.100-Api 3.0
  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:
    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.0_CancelComplexOrder)
      OrderIdentifier Type ComplexOrderIdentification 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-Z][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.0_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-Z][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.0_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-Z][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. 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.0_CancelOrder)
      OrderIdentifier Type OrderIdentifier 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-Z][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. 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:
    Output:
  7. 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.0_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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
      • 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 _ ). C04 - Mandatory: Number of the exclusive 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-Z][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. 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.0_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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
        • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
          Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
      • <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-Z][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. 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:
    Output:
  10. 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.0_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
      • <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
        A Collection of returned errors. It may contain Error Objects too, if state is ACK. In this case, contents should be treated as Warnings.
      • <sessionToken> - optional, nillable Type SessionToken urn:openaccess
        Session Token used in other API calls as a Header Object in the request.
        • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z][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=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-Z][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
  11. KeepAlive
    Tests connectivity to the Open Access Server and Keeps the HTTP Connection active.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    KeepAlive
    Input:
    • Body (use=literal, Message=OpenAccess_3.0_KeepAlive)
      Empty
    Output:
  12. 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.0_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-Z][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:
  13. 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.0_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-Z][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. 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.0_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-Z][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:
  15. 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.0_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-Z][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:
  16. 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.0_RetrieveBlockOrders)
      BlockOrderIdentifier Type BlockOrderIdentifier urn:openaccess
      This object contains the search parameters for 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-Z][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.0_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
    • 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.
  17. 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.0_RetrieveComplexOrders)
      OrderIdentifier Type ComplexOrderIdentification 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-Z][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.0_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
        A Collection of returned errors. It may contain Error Objects too, if state is ACK. In this case, contents should be treated as Warnings.
      • <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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
        • <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.
  18. 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.0_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-Z][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.0_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
    • 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. 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.0_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-Z][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.0_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
  20. 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.0_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.
        • <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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
    • 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-Z][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.0_RetrieveMarketResultsForResponse)
      RetrieveMarketResultAcknowledgement Type RetrieveMarketResultAcknowledgement urn:openaccess
      Acknowledgement sent in response to a RetrieveMarketResultFor message and contains a collection with all the messages. 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.
  21. 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.0_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-Z][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:
  22. 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.0_RetrieveOrders)
      OrderIdentifier Type OrderIdentifier 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-Z][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. 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.0_RetrieveSmartBlockOrders)
      BlockOrderIdentifier Type BlockOrderIdentifier urn:openaccess
      This object contains the search parameters for 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-Z][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.0_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
        A Collection of returned errors. It may contain Error Objects too, if state is ACK. In this case, contents should be treated as Warnings.
      • <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 _ ). C04 - Mandatory: Number of the exclusive 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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
        • 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: Will only provided if the input provides AuctionIdentification. In input this value is ignored and should be omitted. The currency used for an order is bound to the area/portfolio link.
    • 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.
  24. 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.0_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-Z][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:
  25. 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.0_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-Z][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.0_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.
  26. 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.0_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-Z][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.0_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.
  27. 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.0_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-Z][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.0_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.
  28. 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.0_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-Z][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:
  29. 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.0_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-Z][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.0_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.
  30. 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.0_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-Z][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.0_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. 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.
  31. 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.0_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-Z][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:
  32. SetNewPassword
    Change the User Password.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    SetNewPassword
    Input:
    • Body (use=literal, Message=OpenAccess_3.0_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-Z][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: OpenAccessOpenAccessPortType

Description:
This is the comaptibility interface for ETS 2.10 Version: 2.10-Api 1.10.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:
    Output:
  2. 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=OpenAccessCancelExclusiveGroupWithId)
    • 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-Z][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. 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=OpenAccessCancelGroupForBlockId)
    • 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-Z][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. CancelHourlyOrder
    Cancel already submitted Hourly Orders. Deprecated: Use CancelOrder instead.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    CancelHourlyOrder
    Input:
    Output:
  5. 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=OpenAccessCancelOrder)
      OrderIdentifier Type OrderIdentifier 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-Z][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. 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:
    Output:
  7. 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=OpenAccessEnterBlockOrderBatch)
      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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
      • 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 _ ). C04 - Mandatory: Number of the exclusive 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-Z][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. EnterHourlyOrder
    Enter Hourly Orders for a specified Date.
    Additional Rules: 1. Hourly Orders are modified only by replacement. By sending in a new Order, the old Order is overwritten with the new values. Deprecated: Use EnterOrder instead.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    EnterHourlyOrder
    Input:
    Output:
  9. 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:
    Output:
  10. 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=OpenAccessEstablishConnectionResponse)
      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
      • <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
        A Collection of returned errors. It may contain Error Objects too, if state is ACK. In this case, contents should be treated as Warnings.
      • <sessionToken> - optional, nillable Type SessionToken urn:openaccess
        Session Token used in other API calls as a Header Object in the request.
        • <userLoginName> - mandatory Type UserLoginName urn:openaccess based on string http://www.w3.org/2001/XMLSchema restriction { pattern="[A-Z][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=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-Z][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
  11. KeepAlive
    Tests connectivity to the Open Access Server and Keeps the HTTP Connection active.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    KeepAlive
    Input:
    • Body (use=literal, Message=OpenAccessKeepAlive)
      Empty
    Output:
  12. 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=OpenAccessLogout)
      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-Z][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:
  13. 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=OpenAccessRetrieveAreaInformation)
    • 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-Z][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. 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=OpenAccessRetrieveBlockOrders)
      BlockOrderIdentifier Type BlockOrderIdentifier urn:openaccess
      This object contains the search parameters for 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-Z][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=OpenAccessRetrieveBlockOrdersResponse)
      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
    • 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.
  15. 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=OpenAccessRetrieveExclusiveGroupWithId)
    • 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-Z][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=OpenAccessRetrieveExclusiveGroupWithIdResponse)
      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
    • 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.
  16. 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=OpenAccessRetrieveGroupForBlockId)
    • 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-Z][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=OpenAccessRetrieveGroupForBlockIdResponse)
      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
  17. RetrieveHourlyOrders
    Retrieve all Hourly Orders matching the search parameter in the Hourly Order Identifier Object. Only the active versions of each Order are returned. Deprecated: Use RetrieveOrder instead.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    RetrieveHourlyOrders
    Input:
    • Body (use=literal, Message=OpenAccessRetrieveHourlyOrders)
      HourlyOrderIdentification Type HourlyOrderIdentification urn:openaccess
      Object whose parameters are used for searching for matching hourly 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-Z][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. 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=OpenAccessRetrieveMarketResultsFor)
      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.
        • <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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
          • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
            Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
    • 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-Z][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=OpenAccessRetrieveMarketResultsForResponse)
      RetrieveMarketResultAcknowledgement Type RetrieveMarketResultAcknowledgement urn:openaccess
      Acknowledgement sent in response to a RetrieveMarketResultFor message and contains a collection with all the messages. 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.
  19. 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=OpenAccessRetrieveMessagesUnreadOnly)
    • 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-Z][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:
  20. 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=OpenAccessRetrieveOrders)
      OrderIdentifier Type OrderIdentifier 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-Z][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. 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=OpenAccessRetrieveSmartBlockOrders)
      BlockOrderIdentifier Type BlockOrderIdentifier urn:openaccess
      This object contains the search parameters for 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-Z][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=OpenAccessRetrieveSmartBlockOrdersResponse)
      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
        A Collection of returned errors. It may contain Error Objects too, if state is ACK. In this case, contents should be treated as Warnings.
      • <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 _ ). C04 - Mandatory: Number of the exclusive 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. If using UTCDateTime the name can be omitted. If using AuctionDate: If more than one auction is defined its mandatory
            • <duration> - optional Type string http://www.w3.org/2001/XMLSchema restriction enumeration { '15 min', '30 min', '60 min' }
              Duration of a period in the Auction. If omitted: 1. using it as Input for an entry/modify action: - exactly one Auction Duration is defined, this Duration is used - otherwise Action will fail 2. using it as Input for an retrieval/cancellation Action: all available durations are affected
        • 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: Will only provided if the input provides AuctionIdentification. In input this value is ignored and should be omitted. The currency used for an order is bound to the area/portfolio link.
    • 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.
  22. 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=OpenAccessRetrieveTradableAreaSets)
      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-Z][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=OpenAccessRetrieveTradableAreaSetsResponse)
      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.
  23. 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=OpenAccessRetrieveTradableAreas)
      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-Z][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=OpenAccessRetrieveTradableAreasResponse)
      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.
  24. 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=OpenAccessRetrieveTradablePortfolios)
      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-Z][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=OpenAccessRetrieveTradablePortfoliosResponse)
      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.
  25. 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=OpenAccessRetrieveViewableAreas)
      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-Z][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=OpenAccessRetrieveViewableAreasResponse)
      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.
  26. 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=OpenAccessRetrieveViewablePortfolios)
      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-Z][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=OpenAccessRetrieveViewablePortfoliosResponse)
      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. 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.
  27. 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=OpenAccessSetMessagesAsRead)
      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-Z][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:
  28. SetNewPassword
    Change the User Password.
    Operation Type:
    Request-response.The endpoint receives a message, and sends a correlated message.
    SOAP Action:
    SetNewPassword
    Input:
    • Body (use=literal, Message=OpenAccessSetNewPassword)
    • 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-Z][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: EchoOpenAccessPortType

Description:
Version: 3.3.100-Api 3.3
  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

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.