IBT Web Services Data Exchange Specification Page 7 of 22
2015 ISO New England Inc.
1. Web Service Overview
This section gives an overview of web service concepts associated with the IBT web services,
how to access the IBT web services, and the appropriate IBT roles.
1.1 Web Service Design
The IBT web services (the IBT application’s programmatic interface) are organized as a tree of
HTTP resources with different URL patterns for different types of resources. Each type of HTTP
resource is considered a separate “web service” in section 3 below. The different resource
types support specific operations from the standard HTTP methods (GET, POST, etc.) and have
their own message structures for transferring contract data between a Market Participant and
the IBT application through the interaction of the Market Participant’s client interface and IBT’s
web services. The web service messages use XML format for data transmission, which is
discussed in more detail in chapter 2 entitled REST Messages.
All web service requests follow the request/response pattern supported by HTTP(S)
communication. A request may contain a message that modifies (or submits) data identified in
the URL or it may query for data identified in the URL. The response is a message that is either:
1) the new state of the data following a modification, 2) an error, or 3) the current state of the
data for a query.
Any resource that allows data to be modified will support a GET operation that allows for that
data to be queried. These resources have a modifying operation (POST e.g.) and a GET operation
that return the same data. Some resources simply have GET operations, and they are used for
the sole purpose of requesting specific data from the IBT application.
1.2 Accessing the IBT Web Services
The IBT web services are based on REST over HTTPS (version 1.1). A client application that
accesses IBT can be written in nearly any modern enterprise technology and language, such as
Java, .NET, C++, Ruby, etc. The web service is accessible to authorized Participants through an
ISO New England published URL, and all posts/puts of data and queries are serviced via the
same URL.
Access to IBT web services is managed through the Customer and Asset Management System
(CAMS).
Your company’s Security Administrator (SA) is responsible for assigning roles per your
company’s internal procedures and controls.
The SA is also responsible for issuing digital certificates to users, as required (e.g., a customer
may already have a digital certificate if they already have access to another ISO SMD
application).
For details on managing access, SAs can refer to the “CAMS User Guide for Digital Certificates”
which is available by contacting ISO-NE Customer Support.