[NOTE: This appendix will not appear in the Code of Federal Regulations.] Appendix B Request (Query) Variables April 24, 1996 Version 1.0 Use of Query Variables PHASE 1 OASIS Requirements, Template-specific Query Variables Each query of the OASIS node requests data from a specific OASIS Template in the Information Model. The user specifies which OASIS Template from which to obtain data based on a template query variable. The query variables allowed in a request depends upon which template is being requested. For each template a description of the data request is documented. Each query variable allowed for the template is listed afterwards. At the end of each template, there may be Discussion Issues related to the template. B-1 Use of Query Variables Summary Path Hourly ATC Template This request returns the ATC and for transmission products (e.g. firm and non-firm transmission) by each provider of a given path for each hour on a given day. Variables TEMPLATE=sumpathhouratc OUTPUT_FORMAT VERSION PATH-NAME POR POD YEAR (or YEAR-START and YEAR-END) MONTH (or MONTH-START and MONTH-END) DAY (or DAY-START and DAY-END) RELDAY (or RELDAY-START and RELDAY-END) HOUR (or HOUR-START and HOUR-END) TZ B-2 Use of Query Variables Summary Path Daily ATC Template Response contains on and off-peak firm and non-firm ATC and price by each provider of a given path for a given range of days. Variables TEMPLATE=sumpathdayatc OUTPUT_FORMAT VERSION PATH-NAME POR POD YEAR (or YEAR-START and YEAR-END) MONTH (or MONTH-START and MONTH-END) DAY (or DAY-START and DAY-END) RELDAY (or RELDAY-START and RELDAY-END) B-3 Use of Query Variables Summary Path Monthly ATC Response contains on and off-peak firm and non-firm ATC and price by each provider for a given path for a given range of months. Variables TEMPLATE=sumpathmonthatc OUTPUT_FORMAT VERSION PATH-NAME POR POD YEAR (or YEAR-START and YEAR-END) MONTH (or MONTH-START and MONTH-END) B-4 Use of Query Variables Summary Path Yearly ATC Template Response contains on and off-peak firm and non-firm ATC and price by each provider for a given path for a given range of years. Variables TEMPLATE=sumpathyearatc OUTPUT_FORMAT VERSION PATH-1 POR-1 POD-1 YEAR (or YEAR-START and YEAR-END) B-5 Use of Query Variables Hourly Capacity Available for Purchase Template Response contains firm and non-firm ATC and price for a given provider for one or more paths for each hour on a given day. Variables TEMPLATE=houratc OUTPUT_FORMAT VERSION PROVIDER must be specified PATH-NAME (PATH or PATH1 or PATH2, etc ) POR (or POR1 or POR2, etc ) POD (or POD1 or POD2, etc ) YEAR (or YEAR-START and YEAR-END) MONTH (or MONTH-START and MONTH-END) DAY (or DAY-START and DAY-END) RELDAY (or RELDAY-START and RELDAY-END) HOUR (or HOUR-START and HOUR-END) TZ B-6 Use of Query Variables Daily Capacity Available for Purchase Template Response contains on and off-peak firm and non-firm ATC and price for a given provider for one or more paths for a given range of days. Variables TEMPLATE=dayatc OUTPUT_FORMAT VERSION PROVIDER must be specified PATH-NAME (PATH or PATH1 or PATH2, etc ) POR (or POR1 or POR2, etc ) POD (or POD1 or POD2, etc ) YEAR (or YEAR-START and YEAR-END) MONTH (or MONTH-START and MONTH-END) DAY (or DAY-START and DAY-END) RELDAY (or RELDAY-START and RELDAY-END) B-7 Use of Query Variables Monthly Capacity Available for Purchase Template Response contains on and off-peak firm and non-firm ATC and price for a given provider for one or more paths for a given range of months. Variables TEMPLATE=monthatc OUTPUT_FORMAT VERSION PROVIDER must be specified PATH-NAME (PATH or PATH1 or PATH2, etc ) POR (or POR1 or POR2, etc ) POD (or POD1 or POD2, etc ) YEAR (or YEAR-START and YEAR-END) MONTH (or MONTH-START and MONTH-END) B-8 Use of Query Variables Yearly Capacity Available for Purchase Template Response contains on and off-peak firm and non-firm ATC and price for a given provider for one or more paths for a given range of months. Variables TEMPLATE=yearatc OUTPUT_FORMAT VERSION PROVIDER must be specified PATH-NAME (PATH or PATH1 or PATH2, etc ) POR (or POR1 or POR2, etc ) POD (or POD1 or POD2, etc ) YEAR (or YEAR-START and YEAR-END) B-9 Use of Query Variables Hourly Schedule Template Response contains firm and non-firm ATC schedule by each customer for one or more paths for each hour in a given day. No price information is given. Customer names "might" not be visible. Variables TEMPLATE=scheduledatc OUTPUT_FORMAT VERSION PROVIDER must be specified PATH-NAME (PATH or PATH1 or PATH2, etc ) POR (or POR1 or POR2, etc ) POD (or POD1 or POD2, etc ) YEAR (or YEAR-START and YEAR-END) MONTH (or MONTH-START and MONTH-END) DAY (or DAY-START and DAY-END) RELDAY (or RELDAY-START and RELDAY-END) HOUR (or HOUR-START and HOUR-END) TZ B-10 Use of Query Variables Secondary Provider Capacity Posting (Input) Input contains information to post ATC for sale by a secondary provider. Variables TEMPLATE=secondatcpost VERSION YEAR (or YEAR-START and YEAR-END) MONTH (or MONTH-START and MONTH-END) DAY (or DAY-START and DAY-END) RELDAY (or RELDAY-START and RELDAY-END) HOUR (or HOUR-START and HOUR-END) TZ POR POD PATH PROVIDER CAPACITY CAPACITY_TYPE INTERFACE_TYPE REQUEST_REF PRICE UNITS TERMS_AND_CONDITIONS COMMENTS SELLER_NAME SELLER_COMPANY SELLER_PHONE SELLER_FAX SELLER_EMAIL PREV_ASSIGN_REF REASSIGNED_CAPACITY BEGDATETZ ENDDATETZ COMMENTS B-11 Use of Query Variables Secondary Provider (Reseller) Capacity Remove (Input) Input contains information about a previously posted ATC for sale by a secondary provider. Variables TEMPLATE=secondatcremove VERSION YEAR (or YEAR-START and YEAR-END) MONTH (or MONTH-START and MONTH-END) DAY (or DAY-START and DAY-END) RELDAY (or RELDAY-START and RELDAY-END) HOUR (or HOUR-START and HOUR-END) TZ PROVIDER POR POD PATH CAPACITY CAPACITY_TYPE INTERFACE_TYPE REQUEST_REF PRICE UNITS TERMS_AND_CONDITIONS COMMENTS SELLER_NAME SELLER_COMPANY SELLER_PHONE SELLER_FAX SELLER_EMAIL B-12 Use of Query Variables Ancillary Services Available for Purchase Response contains a list of ancillary services provided by a given Service Provider. Variables TEMPLATE=servavail OUTPUT_FORMAT VERSION PROVIDER B-13 Use of Query Variables Services Transmission Response contains Transmission services tariff information about each service by the given provider. Variables TEMPLATE=servtrans OUTPUT_FORMAT VERSION PROVIDER B-14 Use of Query Variables Customer Capacity Purchase Request (Input) Input contains information necessary to purchase transmission capacity of a specific type (firm or non-firm) at a specific time. Variables TEMPLATE=atcrequest OUTPUT_FORMAT VERSION POR POD PATH CAPACITY CAPACITY_TYPE YEAR (or YEAR-START and YEAR-END) MONTH (or MONTH-START and MONTH-END) DAY (or DAY-START and DAY-END) RELDAY (or RELDAY-START and RELDAY-END) HOUR (or HOUR-START and HOUR-END) TZ PRICE CUSTOMER DISCOUNT DEAL_REF ANCILLARY_SERVICES_REQUIREMENTS INTERFACE_TYPE COMMENTS B-15 Use of Query Variables TSIP Posting of Acknowledge Receipt of Request Response contains the customer capacity purchase information. Variables TEMPLATE=atcacknowledge OUTPUT_FORMAT VERSION B-16 Use of Query Variables Provider Capacity Purchase Status Response to Customer Request Response contains the STATUS and QUEUE INFORMATION for a given customer capacity Purchase Request. Variables TEMPLATE=atcstatus OUTPUT_FORMAT VERSION POR POD PATH CAPACITY CAPACITY_TYPE YEAR (or YEAR-START and YEAR-END) MONTH (or MONTH-START and MONTH-END) DAY (or DAY-START and DAY-END) RELDAY (or RELDAY-START and RELDAY-END) HOUR (or HOUR-START and HOUR-END) TZ PRICE CUSTOMER DISCOUNT DEAL_REF ANCILLARY_SERVICES_REQUIREMENTS INTERFACE_TYPE COMMENTS B-17 Use of Query Variables Customer s Purchase Acknowledge Acceptance (Input) Input contains the Provider Capacity Purchase Status for a given customer Capacity Purchase Request and an indication of acceptance or rejection of the purchase. Variables TEMPLATE=atcaccept OUTPUT_FORMAT VERSION STATUS (must be either Accepted or Rejected ) POR POD PATH CAPACITY CAPACITY_TYPE YEAR (or YEAR-START and YEAR-END) MONTH (or MONTH-START and MONTH-END) DAY (or DAY-START and DAY-END) RELDAY (or RELDAY-START and RELDAY-END) HOUR (or HOUR-START and HOUR-END) TZ PRICE CUSTOMER DISCOUNT DEAL_REF ANCILLARY_SERVICES_REQUIREMENTS INTERFACE_TYPE COMMENTS B-18 Use of Query Variables Seller Form to Acknowledge Capacity Purchase Status (Input) Input contains the Seller s status, queue, and reference number of a Customer Purchase Request. Variables TEMPLATE=sellerack VERSION STATUS DTTZTS_QUEUED REQUEST_REF POR POD PATH PROVIDER SELLER_NAME CAPACITY CAPACITY_TYPE CUSTOMER DISCOUNT DEAL_REFERENCE SERVICE_DESCRIPTION ASSIGNMENT_REF INTERFACE_TYPE COMMENTS PREV_ASSIGN_REF The following may contain multiple values PREV_CAPACITY PREV_STATUS PREV_BEGDATETZ PREV_ENDDATETZ PREV_COMMENTS B-19 Use of Query Variables Seller Form to Reassign Service Rights to Another Customer (Input) Input contains the Seller s status, queue, and reference number of a Customer Purchase Request. Variables TEMPLATE=sellerreassign VERSION POR POD PATH PROVIDER SELLER_NAME CAPACITY CAPACITY_TYPE BEGDATETZ ENDDATETZ REQUEST_REF CUSTOMER DISCOUNT DEAL_REFERENCE SERVICE_DESCRIPTION ASSIGNMENT_REF INTERFACE_TYPE DTZZTS_QUEUED COMMENTS PREV_ASSIGN_REF The following may contain multiple values PREV_CAPACITY PREV_STATUS PREV_BEGDATETZ PREV_ENDDATETZ PREV_COMMENTS B-20 Use of Query Variables Provider/Customer Want-Ad Posting Request (Input) Input contains the want-ad information to post on the OASIS. Variables TEMPLATE=wantadpost VERSION YEAR Date when message expires MONTH DAY HOUR CUSTOMER (or PROVIDER) CONTACT must be specified PHONE must be specified (if FAX or E-MAIL is blank) FAX must be specified (if PHONE or E-MAIL is blank) E-MAIL must be specified (if PHONE or FAX is blank) KEYWORD SUBJECT must be specified WANT-AD must be specified B-21 Use of Query Variables TSIP Posting of Want-Ad Response Response contains the want-ad information on the OASIS. Variables TEMPLATE=wantadlisting OUTPUT_FORMAT VERSION SUBJECT [optional] WANT-AD [optional] B-22