Overview

Version information

Version : v1

URI scheme

Host : stp.epias.com.tr
BasePath : /stp-trade-report-orchestrator/rest
Schemes : HTTPS

Tags

  • active-contracts-match

  • bid

  • bid-history

  • bid-match-status

  • bid-status

  • bid-type

  • bid-update-reason

  • contract

  • contract-configuration

  • contract-gate

  • contract-status

  • contract-type

  • daily-financial-status

  • direction

  • exist

  • gas-day

  • gate-status

  • market-price

  • match

  • objection

  • objection-status

  • objection-type

  • reason-code

About This Document

This document contains application definitions and describes how these services will be invoked.

Since the document is updated in each version, the services in the test and real environment may differ. Follow the release notes.

Changes

1.0.0 Service Definitions

About Application

This application is running on REST services. It consumes JSON and XML requests and produces JSON and XML requests.

You need a authorized user at DGPYS to use these services. Every request needs to be authorize by Central Authentication Server (cas.epias.com.tr).

Generating Clients

Service documentation based on Swagger. You can use following files https://testtys.epias.com.tr/stp-organization-services-rest/test/swagger.json for test environment, https://tys.epias.com.tr/stp-organization-services-rest/test/swagger.json for production environment to generate client. There is a code generator located on https://generator.swagger.io which helps you to build client in any language.

Help and Support

You can send your opinions or support request through Support Platform https://yardim.epias.com.tr.

Application Call Procedure

TGT (Ticket Granting Ticket) controls users session. TGT is active at 45 even if you don’t use it. Each time you use the TGT value, the 45-minute period starts again.

You can not use TGT as token to call rest services. For each call you need to create a token (Called ST - Service Token) using TGT. You should reuse TGT.You don’t need to create TGT for each request. If you do that you may blocked by Central Authentication Server.

Flow Diagram
Message Creation Diagram

Creating a Ticket Granting Ticket (TGT)

You should post following request to https://cas.epias.com.tr/cas/v1/tickets?format=text (production) or https://cas.epias.com.tr/cas/v1/tickets?format=text (test) url to create TGT. Service accepts only POST requests. format parameters can take following arguments.

parameter value

xml

xml response

json

json response

text

text response

HTTP header should contain Content-Type = application/x-www-form-urlencoded key value pair.

parameter value

username

user

password

password

Raw Http Request
POST /cas/v1/tickets HTTP/1.1
Host: cas.epias.com.tr
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded

username=DGPYSUSER&password=DGPYSPASSWORD

You should wait HTTP 200 status code for successful requests.

Sample Response
TGT-237-U0TU0jUHLyOEIrdoDBEEf3AdRFAXGLifK2ITn4LoY3HfhstGtx-cas02.epias.com.tr

Creating a Service Ticket (ST)

You need to have a valid TGT to create ST. If you have a valid TGT. You need to construct ST request URL. URL should have following format https://cas.epias.com.tr/cas/v1/tickets/{TGT} (production) or https://cas.epias.com.tr/cas/v1/tickets/{TGT} (test)

You can not reuse ST.The ST received for a service can not be used for another service.
ST is valid for 30 seconds.
Service name is for production https://tys.epias.com.tr and https://testtys.epias.com.tr for test
Sample URL
https://cas.epias.com.tr/cas/v1/tickets/TGT-229-2hmcHafszagAAxtCh017nax1en3U9TouWeGvIrq9KbSbeKE9Zk-cas02.epias.com.tr

You should post following parameter as an input using POST method.

parameter value

service

for test environment : https://testtys.epias.com.tr, for production environment https://tys.epias.com.tr

You get following response after you call the operation. If you should wait for HTTP 200 status code for successful requests.

Sample Response
ST-29962-hSwyzWCP0xC0eRi0bmna-cas01.epias.com.tr

Base Message Format

The services have a standard message structure. You should send the appropriate data to this form in all requests you send.

Every http request should contain following HTTP headers.

key value

stp-service-ticket

Service Ticket (ST) e.g. : ST-30247-uNWazHn52sKZU71v5Ar4-cas02.epias.com.tr

Accept

application/json or application/xml

Content-Type

application/json or application/xml

Accept-Language

tr-tr or en-us (english version is in testing stage)

Service messages are splitted in to two parts.

First part is called header which defines your requests. This area is independent from service bussiness logic. header should contain following key value pair.

key value description

transactionId

this should be unique (Universal Unique Identifier)

we will request this value if you have some trouble using rest services.

application

your application name

Second part called body. This part may differ across all other services.

Following request validates delivery day for offer services.

The * header * field must be sent as key (* key ) and value ( value *).
Unless otherwise stated, the date fields in all incoming and outgoing messages are in ISO-8601 format. Format : yyyy-MM-dd’T’HH:mm:ss.SSSXXX. You should use Europe/Istanbul as timezone. Timezone may differ daylight saving days. Sample : 2016-03-25T00:00:00.000+03:00
Example ISO8601 Parser for Java 8
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;

public class DateUtil
{

    public static Date fromISO8601Date(String v)
    {
        if (null == v) return null;
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSXXX");
        try
        {
            return sdf.parse(v);
        } catch (ParseException e)
        {
            throw new RuntimeException(e);
        }
    }

    public static String toISO8601Date(Date v)
    {
        if (null == v) return null;
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSXXX");
        return sdf.format(v);
    }
}
Örnek HTTP Mesajı
POST /stp-organization-service/rest/organization/save HTTP/1.1
Host: {app-production}
Accept: application/json
Content-Type: application/json
stp-service-ticket: ST-31352-VjHOo5iDV4fDkOod3jZc-cas02.epias.com.tr
Cache-Control: no-cache

{
   "header":[
      {
         "key":"transactionId",
         "value":"6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
      },
      {
         "key":"application",
         "value":"UYGULAMA_ADI"
      }
   ],
   "body":{
      "settlementPeriod":"2016-06-01T00:00:00.000+0300",
      "requestStatuses":["WAITING","INVALID_DISTRIBUTION_METER_CODE","INSUFFICENT_LIMIT","APPROVED"]
   }
}
Example JSON Message
{
   "resultCode":"0",
   "resultDescription":"OK",
   "resultType":"SUCCESS",
   "body":{
      "queryInformation":{
         "begin":1,
         "end":10000,
         "count":3
      },
      "unregisteredMeteringPoints":[
         {
            "requestId":1,
            "requestDate":"2016-10-03T13:34:43.000+0300",
            "reportingDate":null,
            "distributionMeterCode":"  M328",
            "eic":"40Z000007531577H",
            "requestStatus":"APPROVED",
            "requestedCompany":{
               "organizationId":9327,
               "eic":"40X000000009327Q",
               "name":"ERZURUM 1.ORGANİZE SANAYİ BÖLGE MÜDÜRLÜĞÜ",
               "shortname":"ERZ.1-OSB"
            },
            "requestingCompany":{
               "organizationId":195,
               "eic":"40X000000000195P",
               "name":"ELEKTRİK ÜRETİM A.Ş.",
               "shortname":"EÜAŞ"
            },
            "recordingUser":"PK195",
            "reportingUser":null
         },
         {
            "requestId":2,
            "requestDate":"2016-10-03T13:34:45.000+0300",
            "reportingDate":null,
            "distributionMeterCode":"uasxprsc",
            "eic":null,
            "requestStatus":"WAITING",
            "requestedCompany":{
               "organizationId":649,
               "eic":"40X000000000649C",
               "name":"1. BÖLGE MÜDÜRLÜĞÜ",
               "shortname":"1 Iletim"
            },
            "requestingCompany":{
               "organizationId":195,
               "eic":"40X000000000195P",
               "name":"ELEKTRİK ÜRETİM A.Ş.",
               "shortname":"EÜAŞ"
            },
            "recordingUser":"PK195",
            "reportingUser":null
         },
         {
            "requestId":3,
            "requestDate":"2016-10-03T13:38:41.000+0300",
            "reportingDate":null,
            "distributionMeterCode":"123123",
            "eic":null,
            "requestStatus":"WAITING",
            "requestedCompany":{
               "organizationId":649,
               "eic":"40X000000000649C",
               "name":"1. BÖLGE MÜDÜRLÜĞÜ",
               "shortname":"1 Iletim"
            },
            "requestingCompany":{
               "organizationId":195,
               "eic":"40X000000000195P",
               "name":"ELEKTRİK ÜRETİM A.Ş.",
               "shortname":"EÜAŞ"
            },
            "recordingUser":"PK195",
            "reportingUser":null
         }
      ]
   }
}

Response contains two section. Fields start with result describes whether your request is valid or not. Section body contains response.

Every response contains following fields.

parameter type value description

resultCode

string

"0" means success other values may differ for each request

if you had a problem we will ask this value.

resultDescription

string

if requests succeed return "OK" otherwise returs error description

.

resultType

string

returns SUCCESS for valid operation, if you violate a business rule you will get BUSINESSERROR , if our system can not process your request, you will get SYSTEMERROR

BUSINESSERROR : This means you send an invalid request. Check your input. if you belive your request is valid contact with us. SYSTEMERROR : This means we can not process your request. You should contact with us.
Sample Success Message
{"resultCode":"0","resultDescription":"OK","body":true,"resultType":"SUCCESS"}

Postman Usage

You can access the postman application from https://www.getpostman.com . You can access collections prepared for you to access TYS Rest Services from the link below. Application https://www.getpostman.com/collections/6fad72db2e9f7f40d2ea and CAS https://www.getpostman.com/collections/b8972a6217c969728613

After importing your Postman collections, you also need to import the environment variables prepared for the postman. This environment prepared in the form of json is as follows. You should change the links here to use the test environment. The following links have been prepared for the real environment.

Postman parametreleri
Unresolved directive in brief.adoc - include::additional_docs/postman_env.json[]

When the TYS services are accessed after the file is uploaded, TYS should be selected from the "Environment" section in the upper right corner of the interface.

Service Details

From this point document contains service description and call details.

1. Helper Orchestrator Service

1.1. How to call Helper Orchestrator Service?

You can check service details from here .

Sample XML Request
Unresolved directive in helperDataService.adoc - include::examples/json/helper-data-get-request.xml[]
Sample XML Response
Unresolved directive in helperDataService.adoc - include::examples/json/helper-data-get-response.xml[]
Sample Json Request
{
  "headers": [
    {
      "key": "application",
      "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
    },
    {
      "key": "transactionId",
      "value": "d883f25c-413d-41e8-b695-9731186950dd"
    }
  ],
  "body": {
    "parameter": "city",
    "marketType": "NATURAL_GAS"
  }
}
Sample Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "referenceListResponse": [
      {
        "key": "1",
        "description": "Tek Devre",
        "addition": null
      },
      {
        "key": "2",
        "description": "Çift Devre",
        "addition": null
      },
      {
        "key": "3",
        "description": "Üç Devre",
        "addition": null
      }
    ]
  }
}

2. Parameter Service

2.1. How to call Parameter Service?

You can check service details from here .

Sample XML Request
Unresolved directive in parameterService.adoc - include::examples/json/parameter-get-request.xml[]
Sample XML Response
Unresolved directive in parameterService.adoc - include::examples/json/parameter-get-response.xml[]
Sample Json Request
{
  "headers": [
    {
      "key": "application",
      "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
    },
    {
      "key": "transactionId",
      "value": "d883f25c-413d-41e8-b695-9731186950dd"
    }
  ],
  "body": {
    "parameterGroupKey": "PARAMETER_GROUP_1",
    "parameterKey": "PARAMETER_KEY_1",
    "effectiveDate": "2017-06-01T00:00:00.000+03:00",
    "marketType": "NATURAL_GAS"
  }
}
Sample Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "parameterGetResponses": [
      {
        "key": "PARAMETER_KEY_1",
        "value": "a"
      }
    ]
  }
}

3. Helper Orchestrator Service

3.1. How to call Helper Orchestrator Parameters Service?

You can check service details from here .

Sample XML Request
Unresolved directive in helperParametersService.adoc - include::examples/json/helper-parameters-get-request.xml[]
Sample XML Response
Unresolved directive in helperParametersService.adoc - include::examples/json/helper-parameters-get-response.xml[]
Sample Json Request
{
  "headers": [
    {
      "key": "application",
      "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
    },
    {
      "key": "transactionId",
      "value": "d883f25c-413d-41e8-b695-9731186950dd"
    }
  ],
  "body": {
  }
}
Sample Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "referenceListResponse": [
      {
        "key": "city",
        "description": "Şehir Bilgisi",
        "addition": null
      },
      {
        "key": "district",
        "description": "İlçe Bilgisi",
        "addition": null
      }
    ]
  }
}

4. Paths

4.1. Service of Active Contract Match

POST /activecontracts/matchings

4.1.1. Description

Active Contract Match Return

4.1.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Servis ST Header

string

Body

body
optional

activeContractMatchingRequest

4.1.3. Responses

HTTP Code Description Schema

200

successful operation

activeContractMatchingResponse

4.1.4. Consumes

  • application/json

  • application/xml

4.1.5. Produces

  • application/json

  • application/xml

4.1.6. Tags

  • active-contracts-match

4.2. Order History List

POST /bid-history/list

4.2.1. Description

Order History List

4.2.2. Parameters

Type Name Description Schema Default

Body

body
optional

bidHistoryListServiceRequest

4.2.3. Responses

HTTP Code Description Schema

200

successful operation

bidHistoryListServiceResponse

4.2.4. Consumes

  • application/json

  • application/xml

4.2.5. Produces

  • application/json

  • application/xml

4.2.6. Tags

  • bid-history

4.3. Matched Orders History List

POST /bid-history/listbymatch

4.3.1. Description

Matched Orders History List

4.3.2. Parameters

Type Name Description Schema Default

Body

body
optional

bidHistoryListByMatchServiceRequest

4.3.3. Responses

HTTP Code Description Schema

200

successful operation

bidHistoryListByMatchServiceResponse

4.3.4. Consumes

  • application/json

  • application/xml

4.3.5. Produces

  • application/json

  • application/xml

4.3.6. Tags

  • bid-history

4.4. Service of Order Match Status Listing

POST /bid-match-status/list

4.4.1. Description

Service of Order Match Status Listing

4.4.2. Parameters

Type Name Description Schema Default

Body

body
optional

bidMatchStatusListServiceRequest

4.4.3. Responses

HTTP Code Description Schema

200

successful operation

bidMatchStatusListServiceResponse

4.4.4. Consumes

  • application/json

  • application/xml

4.4.5. Produces

  • application/json

  • application/xml

4.4.6. Tags

  • bid-match-status

4.5. Order Status Name List

POST /bid-status/list

4.5.1. Description

Order Status Listing

4.5.2. Parameters

Type Name Description Schema Default

Body

body
optional

bidStatusListServiceRequest

4.5.3. Responses

HTTP Code Description Schema

200

successful operation

bidStatusListServiceResponse

4.5.4. Consumes

  • application/json

  • application/xml

4.5.5. Produces

  • application/json

  • application/xml

4.5.6. Tags

  • bid-status

4.6. #{BID_TYPE_LIST_NAME}

POST /bid-type/list

4.6.1. Description

Order Type Name List

4.6.2. Parameters

Type Name Description Schema Default

Body

body
optional

bidTypeListServiceRequest

4.6.3. Responses

HTTP Code Description Schema

200

successful operation

bidTypeListServiceResponse

4.6.4. Consumes

  • application/json

  • application/xml

4.6.5. Produces

  • application/json

  • application/xml

4.6.6. Tags

  • bid-type

4.7. Service of Order Update Reason Listing

POST /bid-update-reason/list

4.7.1. Description

Service of Order Update Reason Listing

4.7.2. Parameters

Type Name Description Schema Default

Body

body
optional

bidUpdateReasonListServiceRequest

4.7.3. Responses

HTTP Code Description Schema

200

successful operation

bidUpdateReasonListServiceResponse

4.7.4. Consumes

  • application/json

  • application/xml

4.7.5. Produces

  • application/json

  • application/xml

4.7.6. Tags

  • bid-update-reason

4.8. Service of Order

POST /bid/get

4.8.1. Description

Service of Order Match

4.8.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Servis ST Header

string

Body

body
optional

bidGetServiceRequest

4.8.3. Responses

HTTP Code Description Schema

200

successful operation

bidGetServiceResponse

4.8.4. Consumes

  • application/json

  • application/xml

4.8.5. Produces

  • application/json

  • application/xml

4.8.6. Tags

  • bid

4.9. Service of Order Listing by Order Id

POST /bid/getbyid

4.9.1. Description

Service of Order Listing by Order Id

4.9.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Servis ST Header

string

Body

body
optional

bidGetByIdServiceRequest

4.9.3. Responses

HTTP Code Description Schema

200

successful operation

bidGetByIdServiceResponse

4.9.4. Consumes

  • application/json

  • application/xml

4.9.5. Produces

  • application/json

  • application/xml

4.9.6. Tags

  • bid

4.10. Service of Order Listing by Contract

POST /bid/listbycontract

4.10.1. Description

Lists contracts by contract name and status.

4.10.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Servis ST Header

string

Body

body
optional

bidByContractServiceRequest

4.10.3. Responses

HTTP Code Description Schema

200

successful operation

bidGetServiceResponse

4.10.4. Consumes

  • application/json

  • application/xml

4.10.5. Produces

  • application/json

  • application/xml

4.10.6. Tags

  • bid

4.11. #{CONTRACT_CONF_DECLARE_EXTRAORDINARY_DAY}

POST /contract-configuration/declareExtraordinaryDay

4.11.1. Description

{CONTRACT_CONF_DECLARE_EXTRAORDINARY_DAY_DESCRIPTION}

1.1. Parameters

Type Name Description Schema Default

Body

body
optional

ContractConfigurationDeclareExtraOrdinaryDayOrcServiceRequest

1.2. Responses

HTTP Code Description Schema

200

successful operation

ContractConfigurationDeclareExtraOrdinaryDayOrcResponse

1.3. Consumes

  • application/json

  • application/xml

1.4. Produces

  • application/json

  • application/xml

1.5. Tags

  • contract-configuration

1.6. Contract Configuration Query

POST /contract-configuration/get

1.6.1. Description

{CONTRACT_CONFIGURATION_GET_DESCRIPTION}

1.6.2. Parameters

Type Name Description Schema Default

Body

body
optional

contractConfigurationGetServiceRequest

1.6.3. Responses

HTTP Code Description Schema

200

successful operation

contractConfigurationGetServiceResponse

1.6.4. Consumes

  • application/json

  • application/xml

1.6.5. Produces

  • application/json

  • application/xml

1.6.6. Tags

  • contract-configuration

1.7. #{CONTRACT_CONF_LIST_EXTRAORDINARY_NAME}

POST /contract-configuration/list-by-extraOrdinary

1.7.1. Description

{CONTRACT_CONF_LIST_EXTRAORDINARY_DESCRIPTION}

1.1. Parameters

Type Name Description Schema Default

Body

body
optional

ContractConfigurationExtraOrdinaryListOrcServiceRequest

1.2. Responses

HTTP Code Description Schema

200

successful operation

ContractConfigurationExtraOrdinaryListOrcServiceResponse

1.3. Consumes

  • application/json

  • application/xml

1.4. Produces

  • application/json

  • application/xml

1.5. Tags

  • contract-configuration

1.6. CONTRACT_GATE_LIST_NAME

POST /contract-gate/list

1.6.1. Description

CONTRACT_GATE_LIST_DESCRIPTION

1.6.2. Parameters

Type Name Description Schema Default

Body

body
optional

contractGateListServiceRequest

1.6.3. Responses

HTTP Code Description Schema

200

successful operation

contractGateListServiceResponse

1.6.4. Consumes

  • application/json

  • application/xml

1.6.5. Produces

  • application/json

  • application/xml

1.6.6. Tags

  • contract-gate

1.7. Service of Active Gates Listing

POST /contract-gate/list-active

1.7.1. Description

Service of Active Gates Listing (by contract name)

1.7.2. Parameters

Type Name Description Schema Default

Body

body
optional

contractGateListActiveServiceRequest

1.7.3. Responses

HTTP Code Description Schema

200

successful operation

contractGateListServiceResponse

1.7.4. Consumes

  • application/json

  • application/xml

1.7.5. Produces

  • application/json

  • application/xml

1.7.6. Tags

  • contract-gate

1.8. Contract Status Name Listing

POST /contract-status/list

1.8.1. Description

Contract Status Name List

1.8.2. Parameters

Type Name Description Schema Default

Body

body
optional

contractStatusListServiceRequest

1.8.3. Responses

HTTP Code Description Schema

200

successful operation

contractStatusListServiceResponse

1.8.4. Consumes

  • application/json

  • application/xml

1.8.5. Produces

  • application/json

  • application/xml

1.8.6. Tags

  • contract-status

1.9. Service of Contract Type Listing

POST /contract-type/list

1.9.1. Description

Service of Contract Type Listing

1.9.2. Parameters

Type Name Description Schema Default

Body

body
optional

contractTypeListServiceRequest

1.9.3. Responses

HTTP Code Description Schema

200

successful operation

contractTypeListServiceResponse

1.9.4. Consumes

  • application/json

  • application/xml

1.9.5. Produces

  • application/json

  • application/xml

1.9.6. Tags

  • contract-type

1.10. Service of Contract Listing

POST /contract/get

1.10.1. Description

Service of Contract Listing

1.10.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Servis ST Header

string

Body

body
optional

contractGetServiceRequest

1.10.3. Responses

HTTP Code Description Schema

200

successful operation

contractGetServiceResponse

1.10.4. Consumes

  • application/json

  • application/xml

1.10.5. Produces

  • application/json

  • application/xml

1.10.6. Tags

  • contract

1.11. Service of Contract Listing

POST /contract/list

1.11.1. Description

Service of Contract Listing (by given parameters)

1.11.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Servis ST Header

string

Body

body
optional

contractListServiceRequest

1.11.3. Responses

HTTP Code Description Schema

200

successful operation

contractListServiceResponse

1.11.4. Consumes

  • application/json

  • application/xml

1.11.5. Produces

  • application/json

  • application/xml

1.11.6. Tags

  • contract

1.12. Match Report Of Participants Traded In Contract

POST /contract/organization-report

1.12.1. Description

Match Report Of Participants Traded In Contract

1.12.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Servis ST Header

string

Body

body
optional

organizationMatchReportServiceRequest

1.12.3. Responses

HTTP Code Description Schema

200

successful operation

organizationMatchReportServiceResponse

1.12.4. Consumes

  • application/json

  • application/xml

1.12.5. Produces

  • application/json

  • application/xml

1.12.6. Tags

  • contract

1.13. Service of Active N/B Contract Listing

POST /contract/regional

1.13.1. Description

Lists N/B contracts which can be ordered currently or soon.

1.13.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Servis ST Header

string

Body

body
optional

contractListServiceRequest

1.13.3. Responses

HTTP Code Description Schema

200

successful operation

regionalContractResponse

1.13.4. Consumes

  • application/json

  • application/xml

1.13.5. Produces

  • application/json

  • application/xml

1.13.6. Tags

  • contract

1.14. Service of Active Contract Listing

POST /contract/standart

1.14.1. Description

Lists daily contracts which can be ordered currently or soon.

1.14.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Servis ST Header

string

Body

body
optional

contractListServiceRequest

1.14.3. Responses

HTTP Code Description Schema

200

successful operation

contractSummaryResponse

1.14.4. Consumes

  • application/json

  • application/xml

1.14.5. Produces

  • application/json

  • application/xml

1.14.6. Tags

  • contract

1.15. Service of Final Net Position Listing

POST /daily-financial-status/current-status

1.15.1. Description

Lists current net financial position of organization.

1.15.2. Parameters

Type Name Description Schema Default

Body

body
optional

currentStatusServiceRequest

1.15.3. Responses

HTTP Code Description Schema

200

successful operation

currentStatusServiceResponse

1.15.4. Consumes

  • application/json

  • application/xml

1.15.5. Produces

  • application/json

  • application/xml

1.15.6. Tags

  • daily-financial-status

1.16. Service of Daily Financial Position Transaction Limit Listing

POST /daily-financial-status/process-limit

1.16.1. Description

Service of Daily Financial Position Transaction Limit Listing

1.16.2. Parameters

Type Name Description Schema Default

Body

body
optional

dailyFinancialStatusProcessLimitServiceRequest

1.16.3. Responses

HTTP Code Description Schema

200

successful operation

dailyFinancialStatusProcessLimitServiceResponse

1.16.4. Consumes

  • application/json

  • application/xml

1.16.5. Produces

  • application/json

  • application/xml

1.16.6. Tags

  • daily-financial-status

1.17. Direction Name List

POST /direction/list

1.17.1. Description

Order Direction Name List

1.17.2. Parameters

Type Name Description Schema Default

Body

body
optional

directionListServiceRequest

1.17.3. Responses

HTTP Code Description Schema

200

successful operation

directionListServiceResponse

1.17.4. Consumes

  • application/json

  • application/xml

1.17.5. Produces

  • application/json

  • application/xml

1.17.6. Tags

  • direction

1.18. All Gas Days

POST /gas-day/all

1.18.1. Description

Service of All Gas Days Listing

1.18.2. Parameters

Type Name Description Schema Default

Body

body
optional

gasDayListServiceRequest

1.18.3. Responses

HTTP Code Description Schema

200

successful operation

gasDayListServiceResponse

1.18.4. Consumes

  • application/json

  • application/xml

1.18.5. Produces

  • application/json

  • application/xml

1.18.6. Tags

  • gas-day

1.19. Gas Day Display

POST /gas-day/get

1.19.1. Description

Gas Day Display

1.19.2. Parameters

Type Name Description Schema Default

Body

body
optional

gasDayGetServiceRequest

1.19.3. Responses

HTTP Code Description Schema

200

successful operation

gasDayGetServiceResponse

1.19.4. Consumes

  • application/json

  • application/xml

1.19.5. Produces

  • application/json

  • application/xml

1.19.6. Tags

  • gas-day

1.20. Gas Day List

POST /gas-day/list

1.20.1. Description

Gas Day List

1.20.2. Parameters

Type Name Description Schema Default

Body

body
optional

gasDayListServiceRequest

1.20.3. Responses

HTTP Code Description Schema

200

successful operation

gasDayListServiceResponse

1.20.4. Consumes

  • application/json

  • application/xml

1.20.5. Produces

  • application/json

  • application/xml

1.20.6. Tags

  • gas-day

1.21. Gas Day Save

POST /gas-day/save

1.21.1. Description

Gas Day Save

1.21.2. Parameters

Type Name Description Schema Default

Body

body
optional

gasDaySaveServiceRequest

1.21.3. Responses

HTTP Code Description Schema

200

successful operation

gasDaySaveServiceResponse

1.21.4. Consumes

  • application/json

  • application/xml

1.21.5. Produces

  • application/json

  • application/xml

1.21.6. Tags

  • gas-day

1.22. Service of Contract Gate Status Listing

POST /gate-status/list

1.22.1. Description

Service of All Contract Status Listing

1.22.2. Parameters

Type Name Description Schema Default

Body

body
optional

contractGateStatusListServiceRequest

1.22.3. Responses

HTTP Code Description Schema

200

successful operation

contractGateStatusListServiceResponse

1.22.4. Consumes

  • application/json

  • application/xml

1.22.5. Produces

  • application/json

  • application/xml

1.22.6. Tags

  • gate-status

1.23. Market Price

POST /market-price/get

1.23.1. Description

Market Price Notes

1.23.2. Parameters

Type Name Description Schema Default

Body

body
optional

marketPriceGetRequest

1.23.3. Responses

HTTP Code Description Schema

200

successful operation

marketPriceGetServiceResponse

1.23.4. Consumes

  • application/json

  • application/xml

1.23.5. Produces

  • application/json

  • application/xml

1.23.6. Tags

  • market-price

1.24. Contract Active Net Match (by organization)

POST /match/current-status

1.24.1. Description

Contract Active Net Match (by organization)

1.24.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchCurrentStatusServiceRequest

1.24.3. Responses

HTTP Code Description Schema

200

successful operation

matchCurrentStatusServiceResponse

1.24.4. Consumes

  • application/json

  • application/xml

1.24.5. Produces

  • application/json

  • application/xml

1.24.6. Tags

  • match

1.25. Match List

POST /match/list

1.25.1. Description

Match Listing Description

1.25.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchListServiceRequest

1.25.3. Responses

HTTP Code Description Schema

200

successful operation

matchListServiceResponse

1.25.4. Consumes

  • application/json

  • application/xml

1.25.5. Produces

  • application/json

  • application/xml

1.25.6. Tags

  • match

1.26. Match Detail List

POST /match/list-detail

1.26.1. Description

Match Detail Listing

1.26.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchListServiceRequest

1.26.3. Responses

HTTP Code Description Schema

200

successful operation

matchDetailListServiceResponse

1.26.4. Consumes

  • application/json

  • application/xml

1.26.5. Produces

  • application/json

  • application/xml

1.26.6. Tags

  • exist

  • match

1.27. Match Listing By Order

POST /match/listbybid

1.27.1. Description

Service of Match Listing By Order

1.27.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchListByBidServiceRequest

1.27.3. Responses

HTTP Code Description Schema

200

successful operation

matchListServiceResponse

1.27.4. Consumes

  • application/json

  • application/xml

1.27.5. Produces

  • application/json

  • application/xml

1.27.6. Tags

  • match

1.28. Matched Order Listing by Contract

POST /match/listbycontract

1.28.1. Description

Service which lists the matching orders by contract.

1.28.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchListByContractServiceRequest

1.28.3. Responses

HTTP Code Description Schema

200

successful operation

matchDetailListServiceResponse

1.28.4. Consumes

  • application/json

  • application/xml

1.28.5. Produces

  • application/json

  • application/xml

1.28.6. Tags

  • match

1.29. Organization Match List

POST /match/listbycontractorg

1.29.1. Description

Organization Matches Listing by Contract

1.29.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchListByContractOrgServiceRequest

1.29.3. Responses

HTTP Code Description Schema

200

successful operation

organizationMatchListServiceResponse

1.29.4. Consumes

  • application/json

  • application/xml

1.29.5. Produces

  • application/json

  • application/xml

1.29.6. Tags

  • match

1.30. BOTAS Match Net Position Query (by daily contract)

POST /match/listbyperiod

1.30.1. Description

BOTAS Match Net Position Query (by daily contract)

1.30.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchListByPeriodServiceRequest

1.30.3. Responses

HTTP Code Description Schema

200

successful operation

matchListByPeriodServiceResponse

1.30.4. Consumes

  • application/json

  • application/xml

1.30.5. Produces

  • application/json

  • application/xml

1.30.6. Tags

  • match

1.31. BOTAS Match Net Position Query (by regional contract)

POST /match/listbyregional

1.31.1. Description

BOTAS Match Net Position Query (by regional contract)

1.31.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchListByRegionalServiceRequest

1.31.3. Responses

HTTP Code Description Schema

200

successful operation

matchListByRegionalServiceResponse

1.31.4. Consumes

  • application/json

  • application/xml

1.31.5. Produces

  • application/json

  • application/xml

1.31.6. Tags

  • match

1.32. Match List

POST /match/listbyselfcontract

1.32.1. Description

Match Listing Description

1.32.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchListBySelfContractServiceRequest

1.32.3. Responses

HTTP Code Description Schema

200

successful operation

matchListServiceResponse

1.32.4. Consumes

  • application/json

  • application/xml

1.32.5. Produces

  • application/json

  • application/xml

1.32.6. Tags

  • match

1.33. Objection Status List

POST /objection-status/list

1.33.1. Description

Lists objection status.

1.33.2. Parameters

Type Name Description Schema Default

Body

body
optional

objectionStatusListServiceRequest

1.33.3. Responses

HTTP Code Description Schema

200

successful operation

objectionStatusListServiceResponse

1.33.4. Consumes

  • application/json

  • application/xml

1.33.5. Produces

  • application/json

  • application/xml

1.33.6. Tags

  • objection-status

1.34. Objection Type List

POST /objection-type/list

1.34.1. Description

Objection Type Listing

1.34.2. Parameters

Type Name Description Schema Default

Body

body
optional

objectionTypeListServiceRequest

1.34.3. Responses

HTTP Code Description Schema

200

successful operation

objectionTypeListServiceResponse

1.34.4. Consumes

  • application/json

  • application/xml

1.34.5. Produces

  • application/json

  • application/xml

1.34.6. Tags

  • objection-type

1.35. Objection Create

POST /objection/create

1.35.1. Description

Objection Create

1.35.2. Parameters

Type Name Description Schema Default

Body

body
optional

objectionCreateServiceRequest

1.35.3. Responses

HTTP Code Description Schema

200

successful operation

objectionCreateServiceResponse

1.35.4. Consumes

  • application/json

  • application/xml

1.35.5. Produces

  • application/json

  • application/xml

1.35.6. Tags

  • objection

1.36. Objection Info

POST /objection/get

1.36.1. Description

Objection Info Display

1.36.2. Parameters

Type Name Description Schema Default

Body

body
optional

objectionGetServiceRequest

1.36.3. Responses

HTTP Code Description Schema

200

successful operation

objectionGetServiceResponse

1.36.4. Consumes

  • application/json

  • application/xml

1.36.5. Produces

  • application/json

  • application/xml

1.36.6. Tags

  • objection

1.37. Objection Answering

POST /objection/reply

1.37.1. Description

Objection Answering

1.37.2. Parameters

Type Name Description Schema Default

Body

body
optional

objectionReplyServiceRequest

1.37.3. Responses

HTTP Code Description Schema

200

successful operation

objectionReplyServiceResponse

1.37.4. Consumes

  • application/json

  • application/xml

1.37.5. Produces

  • application/json

  • application/xml

1.37.6. Tags

  • objection

1.38. #{REASON_CODE_LIST_NAME}

POST /reason-code/list

1.38.1. Description

{REASON_CODE_LIST_DESCRIPTION}

1.1. Parameters

Type Name Description Schema Default

Body

body
optional

reasonCodeListServiceRequest

1.2. Responses

HTTP Code Description Schema

200

successful operation

reasonCodeListOrcServiceResponse

1.3. Consumes

  • application/json

  • application/xml

1.4. Produces

  • application/json

  • application/xml

1.5. Tags

  • reason-code

5. Definitions

5.1. ActiveContractMatchingRequestBody

Request Content of Active Contract Match

Name Description Schema

contractNames
required

Contract Names

< string > array

5.2. ActiveContractMatchingResponseBody

Response Content of Active Contract Match

Name Description Schema

matchings
optional

< Match > array

5.3. AmountPrice

Quantity/Price Pair

Name Description Schema

amount
optional

Quantity

integer(int64)

price
optional

Price

number

5.4. BidByContractServiceRequestBody

Request of Order Listing by Contract Name and Status

Name Description Schema

bidId
optional

Order Id

string

bidStatusNames
optional

BID_STATUS_NAME

< string > array

contractNames
required

Contract Status

< string > array

5.5. BidGetByIdServiceRequestBody

Request of Order Listing by Order Id Service

Name Description Schema

bidId
required

Order Id

string

5.6. BidGetByIdServiceResponseBody

Response of Order Listing by Order Id Service

Name Description Schema

bid
optional

BidResponse

5.7. BidGetServiceRequestBody

Request of Order Service

Name Description Schema

bidEndDate
required

Order Finish Date

string(date-time)

bidStartDate
required

Order Start Date

string(date-time)

marketDayType
required

Market Day Type

enum (GASDAY, GASWEEK, ALL)

5.8. BidGetServiceResponseBody

Response of Order Service

Name Description Schema

bidResponses
optional

< BidResponse > array

5.9. BidHistoryListByMatchRequestBody

Request of Matched Orders History Service

Name Description Schema

matchId
required

Match Id

string

5.10. BidHistoryListByMatchResponse

Response of Matched Orders History Service

Name Description Schema

purchaseBidHistoryList
optional

< BidHistoryResponse > array

saleBidHistoryList
optional

< BidHistoryResponse > array

5.11. BidHistoryListRequestBody

Request of Order History Listing Service

Name Description Schema

bidIds
optional

Order Id

< string > array

5.12. BidHistoryListResponse

Response of Order History Listing Service

Name Description Schema

bidHistoryList
optional

< BidHistoryResponse > array

partialMatchAverage
optional

number

5.13. BidHistoryResponse

Response of Order History

Name Description Schema

bidDate
optional

Order Date

string(date-time)

bidExpiredDate
optional

string(date-time)

bidHistoryId
optional

Order History id

integer(int64)

bidPointName
optional

Order Point

string

bidPrice
optional

Order Price

number

bidQuantity
optional

Order Quantity

integer(int64)

bidState
optional

Order Status

StringType

bidType
optional

Order Type

StringType

contractName
optional

Order Contract

string

direction
optional

OPERATION

StringType

id
optional

Order Id

string

matchId
optional

Match Id

string

matchPrice
optional

Match Price

number

matchQuantity
optional

Match Quantity

integer(int64)

matchState
optional

Order Match Status

StringType

matchStatus
optional

Order Match Status

StringType

matchVersion
optional

integer(int32)

modifyDate
optional

Order Date

string(date-time)

organizationName
optional

Organization Title

string

organizationShortName
optional

Organization Short Title

string

purchaseOrgName
optional

Organization Title

string

queueTime
optional

Order Date

string(date-time)

remainingQuantity
optional

Order Remaining Quantity

integer(int64)

saleOrgName
optional

Organization Title

string

status
optional

Order Status

StringType

updateReason
optional

Order Update Reason

StringType

user
optional

Order User

string

5.14. BidMatchStatusListRequestBody

Request of Order Match Status Listing Service

Type : object

5.15. BidMatchStatusListResponse

Response of Order Match Status Listing Service

Name Description Schema

bidMatchStatusList
optional

< BidMatchStatusResponse > array

5.16. BidMatchStatusResponse

Response of Order Match Status Listing Service

Name Description Schema

localization
required

Order Match Status Language Options

LocalizationResponse

name
required

Order Match Status Name

string

5.17. BidResponse

Response of Order Service

Name Description Schema

bidDate
optional

Order Date

string(date-time)

bidExpiredDate
optional

string(date-time)

bidPointName
optional

Order Point

string

bidPrice
optional

Order Price

number

bidProcess
optional

Order Process

StringType

bidQuantity
optional

Order Quantity

integer(int64)

bidState
optional

Order Status

StringType

bidType
optional

Order Type

StringType

contractName
optional

Order Contract

string

direction
optional

OPERATION

StringType

id
optional

Order Id

string

matchingStatus
optional

Order Match Status

StringType

modifyDate
optional

Order Date

string(date-time)

organizationEic
optional

EIC Code

string

organizationInfo
optional

ORGANIZATION

StringType

queueTime
optional

Order Date

string(date-time)

remainingQuantity
optional

= {BID_REMANING_QUANTITY}

integer(int64)

status
optional

Order Status

StringType

updateReason
optional

Order Update Reason

StringType

user
optional

Order User

string

version
optional

Order Version

integer(int32)

5.18. BidStatusListRequestBody

Request Content of Order Status Listing

Type : object

5.19. BidStatusListResponseBody

Response Content of Order Status Listing

Name Description Schema

bidStatuses
optional

< StringType > array

5.20. BidTypeListRequestBody

Request Content of Order Type Listing

Type : object

5.21. BidTypeListResponseBody

Response Content of Order Type Listing

Name Description Schema

bidTypes
optional

< StringType > array

5.22. BidUpdateReasonListRequestBody

Request of Order Update Reason Listing Service

Type : object

5.23. BidUpdateReasonListResponse

Response of Order Update Reason Listing Service

Name Description Schema

bidUpdateReasonList
optional

< BidUpdateReasonResponse > array

5.24. BidUpdateReasonResponse

Response of Order Update Reason Listing Service

Name Description Schema

localization
required

Language Options for Order Update Reason

LocalizationResponse

name
required

Order Update Reason Name

string

5.25. BlockingAmount

Blocked Amount

Name Description Schema

amount
required

Amount

number

gasDay
required

Reference Time

string(date-time)

5.26. Collateral

Collateral

Name Description Schema

amount
required

Amount

number

referenceTime
required

Reference Time

string(date-time)

5.27. ContractConfigurationDeclareExtraOrdinaryDayOrcRequestBody

{CONTRACT_CONF_DECLARE_EXTRAORDINARY_DAY_SERVICE_REQUEST}

Name Description Schema

contractName
required

Contract Name

string

extraOrdinaryReason
required

= {CONTRACT_CONF_EXTRAORDINARY_REASON}

string

1.1. ContractConfigurationDeclareExtraOrdinaryDayOrcResponse

{CONTRACT_CONF_DECLARE_EXTRAORDINARY_DAY_SERVICE_RESPONSE}

Name Description Schema

body
optional

ContractConfigurationDeclareExtraOrdinaryDayOrcResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.1. ContractConfigurationDeclareExtraOrdinaryDayOrcResponseBody

{CONTRACT_CONF_DECLARE_EXTRAORDINARY_DAY_SERVICE_RESPONSE}

Name Description Schema

beforeDRPDayPrice
optional

= {CONTRACT_CONF_BEFORE_DRP_DAY_PRICE}

number

effectedContractName
optional

= {CONTRACT_CONF_EFFECTED_CONTRACT_NAME}

string

extraOrdinaryReason
optional

= {CONTRACT_CONF_EXTRAORDINARY_REASON}

string

updatedDRP
optional

= {CONTRACT_CONF_UPDATED_DRP}
Default : false

boolean

1.1. ContractConfigurationDeclareExtraOrdinaryDayOrcServiceRequest

{CONTRACT_CONF_DECLARE_EXTRAORDINARY_DAY_SERVICE_REQUEST}

Name Description Schema

body
optional

ContractConfigurationDeclareExtraOrdinaryDayOrcRequestBody

headers
optional

TITLE

< Header > array

1.1. ContractConfigurationExtraOrdinaryListOrcRequestBody

{CONTRACT_CONF_LIST_EXTRAORDINARY_SERVICE_REQUEST}

Name Description Schema

extraOrdinary
optional

Contract Name
Default : false

boolean

1.1. ContractConfigurationExtraOrdinaryListOrcResponseBody

{CONTRACT_CONF_LIST_EXTRAORDINARY_SERVICE_RESPONSE}

Name Description Schema

contractConfigurationExtraOrdinaryList
optional

< ContractConfigurationExtraOrdinaryOrcResponse > array

1.1. ContractConfigurationExtraOrdinaryListOrcServiceRequest

{CONTRACT_CONF_LIST_EXTRAORDINARY_SERVICE_REQUEST}

Name Description Schema

body
optional

ContractConfigurationExtraOrdinaryListOrcRequestBody

headers
optional

TITLE

< Header > array

1.1. ContractConfigurationExtraOrdinaryListOrcServiceResponse

{CONTRACT_CONF_LIST_EXTRAORDINARY_SERVICE_RESPONSE}

Name Description Schema

body
optional

ContractConfigurationExtraOrdinaryListOrcResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.1. ContractConfigurationExtraOrdinaryOrcResponse

{CONTRACT_CONF_LIST_EXTRAORDINARY_SERVICE_RESPONSE}

Name Description Schema

beforeDRP
optional

= {CONTRACT_CONF_BEFORE_DRP}

number

contractName
optional

Contract Name

string

extraOrdinary
optional

= {CONTRACT_CONF_EXTRAORDINARY}
Default : false

boolean

extraordinaryReason
optional

= {CONTRACT_CONF_EXTRAORDINARY_REASON}

string

1.1. ContractConfigurationGetRequestBody

Request of Contract Configuration Query Service

Name Description Schema

contractName
required

Contract Name

string

1.2. ContractConfigurationGetResponseBody

Response of Contract Configuration Query Service

Name Description Schema

baseCoefficient
optional

Min Price Coefficient

number

ceilingCoefficient
optional

Max Price Coefficient

number

contractConfId
optional

Contract Configuration Id

integer(int64)

dapFinalDate
optional

GOF Finalization Date

string(date-time)

dapScopeDate
optional

GOF Period Date

string(date-time)

grpFinalDate
optional

GRF Finalization Date

string(date-time)

grpScopeDate
optional

GRF Period Date

string(date-time)

lpa
optional

Last Matches Price Average (SFO)

integer(int64)

lqa
optional

Last Matches Quantity Average (SMO)

integer(int64)

marketBasePrice
optional

Market Min Price

number

marketCeilingPrice
optional

Market Max Price

number

marketMaxQuantity
optional

Market Max Quantity

integer(int64)

marketMinQuantity
optional

Market Min Quantity

integer(int64)

nbpOpenTime
optional

National Balancing Point (UDN) Validity Period

number

objectionTime
optional

Objection Time

number

retrospectiveAverage
optional

GRF Retrospective Average

number

transmissionBasePrice
optional

BOTAS Min Price

number

transmissionBasePriceFormula
optional

BOTAS Min Price Formula

string

transmissionCeilingPrice
optional

BOTAS Max Price

number

transmissionCeilingPriceFormula
optional

BOTAS Max Price Formula

string

transmissionMaxQuantity
optional

BOTAS Max Quantity

integer(int64)

transmissionMinQuantity
optional

BOTAS Min Quantity

integer(int64)

1.3. ContractGateListActiveRequestBody

Request of Active Contract Gate Listing Service

Name Description Schema

contractName
required

string

1.4. ContractGateListRequestBody

Request of Contract Gate Listing Service

Name Description Schema

contractGateTypeName
required

CONTRACT_GATE_LIST_REQ_TYPE_NAME

string

gasDayDate
required

CONTRACT_GATE_LIST_REQ_GAS_DAY_DATE

string(date-time)

1.5. ContractGateListResponse

Response of Contract Service

Name Description Schema

contractGateList
optional

< ContractGateResponse > array

1.6. ContractGateResponse

{CONTRACT_GATE_SERVICE_RESPONSE}

Name Description Schema

announcementDate
optional

Contract Announcement Time

string(date-time)

contractGateId
optional

Contract Gate Id

integer(int64)

contractName
optional

Contract Name

string

contractType
optional

Contract Type

ContractTypeResponse

directionResponse
optional

Response of Direction

DirectionResponse

endDate
optional

Finish Date

string(date-time)

gateStatusResponse
optional

Gate Status

ContractGateStatusResponse

gateTypeResponse
optional

GATE NAME

ContractGateTypeResponse

physicalPointIds
optional

Physical Points

< integer(int64) > array

quantity
optional

Quantity

integer(int64)

startDate
optional

Start Date

string(date-time)

transmissionBidActivate
optional

BOTAS Order Activation Time

string(date-time)

1.7. ContractGateStatusListRequestBody

Request of Contract Gate Status Listing Service

Type : object

1.8. ContractGateStatusListResponseBody

Response of Contract Gate Status Listing Service

Name Description Schema

contractGateStatuses
optional

< StringType > array

1.9. ContractGateStatusResponse

Response of Gate Status

Name Description Schema

localization
required

Regional Language

LocalizationResponse

name
required

Gate Status

string

1.10. ContractGateTypeResponse

Response of Contract Gate Type Service

Name Description Schema

localization
required

Regional Language

LocalizationResponse

name
required

GATE NAME

string

1.11. ContractGetRequestBody

Request Content of Contract Listing

Name Description Schema

contractName
required

Contract Name

string

1.12. ContractGetResponseBody

Response Content of Contract Listing

Name Description Schema

contract
optional

ContractResponse

1.13. ContractListRequestBody

Request of Contract Listing Service

Name Description Schema

activationDate
optional

= {ACTIVATION_DATE}

string(date-time)

contractStatusNames
required

Contract Status

< string > array

contractTypeName
optional

Contract Type

string

gasDayDate
optional

Gas Day

string(date-time)

1.14. ContractListResponse

Response of Contract Listing Service

Name Description Schema

contractList
optional

< ContractResponse > array

1.15. ContractResponse

Response of Contract Service

Name Description Schema

activationDate
required

Contract Activation Time

string(date-time)

closeDate
required

Contract Finish Time

string(date-time)

contractGateList
required

Contract Gate List

ContractGateListResponse

contractName
required

Contract Name

string

contractStatus
required

Contract Status

ContractStatusResponse

contractType
required

Contract Type

ContractTypeResponse

createDate
required

Contract Creating Time

string(date-time)

gasDays
required

= {CONTRACT_GAS_DAYS}

< GasDay > array

1.16. ContractStatusListRequestBody

Request Content of Contract Status Listing

Type : object

1.17. ContractStatusListResponseBody

Response of Contract Status Listing Request

Name Description Schema

contractStatuses
optional

< StringType > array

1.18. ContractStatusResponse

Response of Contract Status Listing Service

Name Description Schema

localization
required

Regional Language

LocalizationResponse

name
required

Contract Status

string

1.19. ContractSummary

{CONTRACT_SUMMARY}

Name Description Schema

bestAmountPriceBuying
required

BEST BUY

AmountPrice

bestAmountPriceSelling
required

BEST SELL

AmountPrice

closingTime
required

Contract Finish Time

string(date-time)

deliveryDays
required

Gas Delivery Days

< string(date-time) > array

gasDays
required

= {CONTRACT_GAS_DAYS}

< GasDay > array

highestMatchingPrice
required

HIGHEST MATCHING PRICE

number

lastMatchingPrice
required

LAST MATCH PRICE

number

lowestMatchingPrice
required

LOWEST MATCHING PRICE

number

name
required

Contract Name

string

status
required

Contract Status

StringType

type
required

TYPE

StringType

weightedAverage
required

WEIGHTED AVERAGE

number

1.1. ContractSummaryResponseBody

Response of Active Contract Listing Service

Name Description Schema

contracts
optional

< ContractSummary > array

1.2. ContractTypeListRequestBody

Request Content of Contract Type Listing

Type : object

1.3. ContractTypeListResponseBody

Response of Contract Type Listing

Name Description Schema

contractTypes
optional

< StringType > array

1.4. ContractTypeResponse

{CONTRACT_TYPE_LIST_SERVICE_RESPONSE}

Name Description Schema

localization
required

Regional Language

LocalizationResponse

name
required

Contract Type

string

1.5. CurrentNetFinancialStatus

Last Financial Position

Name Description Schema

advancePaymentDate
optional

Advance Payment Day

string(date-time)

advancePaymentDayNetFinancialStatus
required

Advance Payment Date Net Financial Position

number

financialStatusItems
optional

< NetFinancialStatus > array

gasday
required

Contract Gas Day

string(date-time)

processLimit
required

Transaction Limit

number

1.6. CurrentStatusServiceRequestBody

Request of Final Net Financial Position

Type : object

1.7. CurrentStatusServiceResponseBody

Response of Final Net Financial Position

Name Description Schema

blockingAmounts
optional

< BlockingAmount > array

collaterals
optional

< Collateral > array

netstatuses
optional

< CurrentNetFinancialStatus > array

organization
required

Organization Title

StringType

1.8. DailyFinancialStatusProcessLimitRequestBody

Request Content of Daily Financial Position Transaction Limit Listing Service

Name Description Schema

contractName
required

Contract Name

string

1.9. DailyFinancialStatusProcessLimitResponseBody

Response Content of Daily Financial Position Transaction Limit Listing Service

Name Description Schema

processLimit
required

Transaction Limit

number

1.10. DirectionListRequestBody

Request of Content for Direction Listing

Type : object

1.11. DirectionListResponseBody

Response of Direction Listing

Name Description Schema

directionList
optional

< StringType > array

1.12. DirectionResponse

Response of Direction Listing Service

Name Description Schema

localization
required

Regional Language

LocalizationResponse

name
required

Direction Name

string

1.13. GasDay

Contract Gas Day

Name Description Schema

advancePaymentDate
optional

Advance Payment Day

string(date-time)

gasDayDate
optional

Gas Day

string(date-time)

gasDayId
optional

Gas Day Id

integer(int64)

gasDeliveryEndDate
optional

Gas Delivery Finish Date

string(date-time)

gasDeliveryStartDate
optional

Gas Delivery Start Date

string(date-time)

registrationPeriodId
optional

Gas Day Registration Period Id

integer(int64)

1.14. GasDayGetRequestBody

Request Content of Listing Gas Day

Name Description Schema

gasDayDate
required

Gas Day

string(date-time)

1.15. GasDayGetResponseBody

Response of Gas Day Display

Name Description Schema

gasDayGetResponse
optional

GasDayResponse

1.16. GasDayListRequestBody

Request Content of Gas Day Listing

Type : object

1.17. GasDayListResponseBody

Response of Gas Day Listing

Name Description Schema

gasDayListResponse
optional

< GasDayResponse > array

1.18. GasDayResponse

Response of Gas Day

Name Description Schema

abpAbsEarlyDate
optional

IDAF/IDSF Publication Time

string(date-time)

abpAbsFinalDate
optional

IDAF/IDSF Finalization Time

string(date-time)

abpFormula
optional

IDAF Calculation Formula

string

abpPrice
optional

IDAF Price

number

absFormula
optional

IDSF Calculation Formula

string

absPrice
optional

IDSF Price

number

advancePaymentDate
optional

Advance Payment Day

string(date-time)

bgpBgsEarlyDate
optional

Balancing Gas Buy/Sell Price Publication Time

string(date-time)

bgpBgsFinalDate
optional

Balancing Gas Buy/Sell Price Finalization Time

string(date-time)

bgpFormula
optional

Balancing Gas Buy Price Calculation Formula

string

bgpPrice
optional

Balancing Gas Buy Price

number

bgsFormula
optional

Balancing Gas Sell Price Calculation Formula

string

bgsPrice
optional

Balancing Gas Sell Price

number

gasDayDate
optional

Gas Day

string(date-time)

gasDayId
optional

Gas Day Id

integer(int64)

gasDeliveryEndDate
optional

Gas Delivery Finish Date

string(date-time)

gasDeliveryStartDate
optional

Gas Delivery Start Date

string(date-time)

registrationPeriodId
optional

Registration Period Id

integer(int64)

1.19. GasDaySaveRequestBody

Request of Gas Day Save Service

Name Description Schema

abpAbsEarlyDate
optional

IDAF/IDSF Publication Time

string(date-time)

abpAbsFinalDate
optional

IDAF/IDSF Finalization Time

string(date-time)

abpFormula
optional

IDAF Calculation Formula

string

abpPrice
optional

IDAF Price

number

absFormula
optional

IDSF Calculation Formula

string

absPrice
optional

IDSF Price

number

bgpBgsEarlyDate
optional

Balancing Gas Buy/Sell Price Publication Time

string(date-time)

bgpBgsFinalDate
optional

Balancing Gas Buy/Sell Price Finalization Time

string(date-time)

bgpFormula
optional

Balancing Gas Buy Price Calculation Formula

string

bgpPrice
optional

Balancing Gas Buy Price

number

bgsFormula
optional

Balancing Gas Sell Price Calculation Formula

string

bgsPrice
optional

Balancing Gas Sell Price

number

gasDayDate
required

Gas Day

string(date-time)

gasDeliveryEndDate
required

Gas Delivery Finish Date

string(date-time)

gasDeliveryStartDate
required

Gas Delivery Start Date

string(date-time)

registrationPeriodId
required

Registration Period Id

integer(int64)

1.20. GasDaySaveResponseBody

Response of Gas Day Service

Type : object

1.21. Header

TITLE

Name Description Schema

key
optional

Header Key
Example : "transactionId"

string

value
optional

Header Value
Example : "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"

string

1.22. LocalizationResponse

Response of Regional Service

Name Description Schema

language
required

Regional Language

string

text
required

Regional Text

string

1.23. LongType

Numerical Type

Name Description Schema

text
required

Definition

string

value
required

VALUE

integer(int64)

1.24. MarketPriceGetRequestBody

Request Content of Market Price

Name Description Schema

gasDayEndDate
optional

Market Price Gas Day
Example : "2017-02-07T09:31:33.000+03:00"

string(date-time)

gasDayStartDate
required

Market Price Gas Day
Example : "2017-02-07T09:31:33.000+03:00"

string(date-time)

priceType
optional

Market Price Type
Example : "ADDITIONAL_BALANCING, BALANCING_GAS, DAY_AHEAD, GAS_REFERENCE"

enum (GAS_REFERENCE, ADDITIONAL_BALANCING_PURCHASE, ADDITIONAL_BALANCING_SALE, BALANCING_GAS_PURCHASE, BALANCING_GAS_SALE, DAY_AHEAD, WEEKLY_GAS_REFERENCE)

1.25. MarketPriceResponse

Response Content of Market Price

Name Description Schema

price
required

Market Price

number

priceType
required

Market Price Type
Example : "ADDITIONAL_BALANCING, BALANCING_GAS, DAY_AHEAD, GAS_REFERENCE"

enum (GAS_REFERENCE, ADDITIONAL_BALANCING_PURCHASE, ADDITIONAL_BALANCING_SALE, BALANCING_GAS_PURCHASE, BALANCING_GAS_SALE, DAY_AHEAD, WEEKLY_GAS_REFERENCE)

state
required

Market Price Status
Example : "EARLY, FINAL"

enum (EARLY, FINAL)

1.26. Match

Match

Name Description Schema

contract
required

Contract Name

string

matchId
required

Match Id

string

matchStatus
required

Match Status

string

matchingTime
required

Match Time

string(date-time)

myOwnMatching
required

My Matches
Default : false

boolean

pointName
optional

Order Point

string

price
required

Price

number

quantity
required

Quantity

integer(int64)

1.27. MatchByPeriod

Response of Match

Name Description Schema

direction
required

Response of Direction

StringType

matchQuantity
required

Match Quantity

integer(int64)

organization
required

ORGANIZATION

StringType

1.28. MatchByPeriodResponse

Response of Match

Name Description Schema

period
required

Match Period

StringType

periodMatchResponse
optional

< MatchByPeriod > array

1.29. MatchByRegionalResponse

Response of Match

Name Description Schema

contractName
required

Contract Name

string

direction
required

Response of Direction

StringType

matchQuantity
required

Match Quantity

integer(int64)

organization
required

ORGANIZATION

StringType

pointName
required

Order Point

string

1.30. MatchCurrentStatusRequestBody

Request Content of Match Listing

Name Description Schema

contractName
required

Contract Name

string

organizationEic
required

EIC Code

string

1.31. MatchCurrentStatusResponse

Response of Match Listing

Name Description Schema

organizationEic
required

EIC Code

string

organizationInfo
required

ORGANIZATION

StringType

totalPurchaseMatchQuantity
required

Match Total Buy Quantity

integer(int64)

totalSaleMatchQuantity
required

Match Total Sell Quantity

integer(int64)

1.32. MatchCurrentStatusResponseBody

Response Content of Match Listing

Name Description Schema

contractName
required

Match Id

string

matchCurrentStatusResponses
optional

< MatchCurrentStatusResponse > array

1.33. MatchDetailListResponseBody

Response of Match Detail Listing Service

Name Description Schema

matchList
optional

< MatchDetailResponse > array

1.34. MatchDetailResponse

Response of Match Detail

Name Description Schema

contractName
optional

Contract Name

string

createDate
required

Match Date

string(date-time)

createUser
required

Match User

string

matchId
required

Match Id

string

matchStatus
required

Match Status

StringType

pointName
optional

Order Point

string

price
required

Match Price

number

purchaseBid
required

Match for Buy Order

BidResponse

purchaseBidVersion
required

Version of Match for Buy Order

integer(int32)

purchaseMatchReason
required

Match Reason

StringType

quantity
required

Match Quantity

integer(int64)

saleBid
required

Match by Sell Order

BidResponse

saleBidVersion
required

Version of Match by Sell Order

integer(int32)

saleMatchReason
required

Match Reason

StringType

1.35. MatchListByBidRequest

Order Match Listing

Name Description Schema

bidId
required

string

1.36. MatchListByBidRequestBody

Request of Match Listing By Order

Name Description Schema

bidIds
required

< MatchListByBidRequest > array

1.37. MatchListByContractOrgRequestBody

Request of Organization Match Listing Service

Name Description Schema

contractName
required

Contract Name

string

organizationId
required

Match Order Organization Id

integer(int64)

1.38. MatchListByContractRequestBody

Response of Matched Order by Contract Listing Service

Name Description Schema

contractNames
required

Contract Name

< string > array

queryType
optional

Match Query Type

enum (ALL, SELF)

1.39. MatchListByPeriodRequestBody

Request of Match Listing Service

Name Description Schema

gasDayDate
required

Gas Day

string(date-time)

periodName
optional

Request Period

string

1.40. MatchListByPeriodResponse

Response of Match Listing Service

Name Description Schema

gasDayDate
optional

Gas Day

string(date-time)

periodResponses
optional

< MatchByPeriodResponse > array

1.41. MatchListByRegionalRequestBody

Request of Match Listing Service

Name Description Schema

contractName
required

Contract Name

string

1.42. MatchListByRegionalResponse

Response of Match Listing Service

Name Description Schema

regionalResponses
optional

< MatchByRegionalResponse > array

1.43. MatchListBySelfContractRequestBody

Request Content of Match Listing Service

Name Description Schema

contractName
required

Contract Name

string

1.44. MatchListRequestBody

Request Content of Match Listing

Name Description Schema

createDate
required

Match Date

string(date-time)

1.45. MatchListResponse

Response of Match Listing Service

Name Description Schema

matchList
optional

< MatchResponse > array

1.46. MatchResponse

Response of Match

Name Description Schema

bid
required

Order

BidResponse

bidVersion
required

Match Version

integer(int32)

contractName
optional

Contract Name

string

createDate
required

Match Date

string(date-time)

createUser
required

Match User

string

matchId
required

Match Id

string

matchReason
required

Match Reason

StringType

matchStatus
required

Match Status

StringType

pointName
optional

Order Point

string

price
required

Match Price

number

quantity
required

Match Quantity

integer(int64)

1.47. MatchWithBidListResponse

Response of Match

Name Description Schema

bids
required

Order

< BidResponse > array

createDate
required

Match Date

string(date-time)

createUser
required

Match User

string

matchId
required

Match Id

string

matchReason
required

Match Reason

StringType

matchStatus
required

Match Status

StringType

pointName
optional

Order Point

string

price
required

Match Price

number

quantity
required

Match Quantity

integer(int64)

1.48. NetFinancialStatus

Financial Position

Name Description Schema

contract
required

Contract Name

string

datetime
required

Transaction Time

string(date-time)

direction
required

Financial Position Direction

StringType

id
optional

string

netStatusAmount
required

Net Position Amount

number

processAmount
required

Transaction Amount

number

type
required

Financial Position Type

StringType

1.49. ObjectionCreateRequestBody

Request Content of Objection

Name Description Schema

matchId
optional

Match Id

string

objectionMessage
required

Objection Message

string

objectionTypeName
required

Objection Type

string

1.50. ObjectionCreateResponseBody

Response Content of Objection

Name Description Schema

objectionResponse
optional

Objection Answer

ObjectionResponse

1.51. ObjectionGetRequestBody

Request Content of Objection Listing

Name Description Schema

endDate
optional

Objection Finish Time

string(date-time)

matchId
optional

Match Id

string

objectionStatusNames
optional

Objection Status

< string > array

startDate
optional

Objection Start Time

string(date-time)

1.52. ObjectionGetResponseBody

Response of Objection Listing

Name Description Schema

objectionResponses
optional

Objection Answer

< ObjectionResponse > array

1.53. ObjectionReplyRequestBody

Request Content of Objection Answering

Name Description Schema

objectionId
required

OBJECTION ID

integer(int64)

objectionStatusName
required

Objection Status

string

replyMessage
required

Objection Answer

string

1.54. ObjectionReplyResponseBody

Response of Objection Answering

Name Description Schema

objectionResponse
optional

Objection Answer

ObjectionResponse

1.55. ObjectionResponse

Objection Answer

Name Description Schema

createUser
optional

Objection Create User

string

createUserMail
optional

Objection Create User E-mail

string

createUserName
optional

Objection Create User

string

createUserPhone
optional

Objection Create User Phone

string

matchWithBidListResponse
optional

Response of Match

MatchWithBidListResponse

objectionDate
optional

Objection Date

string(date-time)

objectionId
optional

OBJECTION ID

integer(int64)

objectionMessage
optional

Objection Message

string

objectionStatus
optional

Objection Status

StringType

objectionType
optional

Objection Type

StringType

organizationInfo
optional

Objection Create Organization

StringType

replyDate
optional

Objection Answering Time

string(date-time)

replyMessage
optional

Objection Answer

string

replyUser
optional

Objection Answer User

string

1.56. ObjectionStatusListRequestBody

Request of Objection Status Listing Service

Type : object

1.57. ObjectionStatusListResponse

Response of Objection Status Listing Service

Name Description Schema

objectionStatuses
optional

< StringType > array

1.58. ObjectionTypeListRequestBody

Request of Objection Type Listing Service

Type : object

1.59. ObjectionTypeListResponse

Response of Objection Type Listing Service

Name Description Schema

objectionTypes
optional

< StringType > array

1.60. OrganizationMatchListResponse

Response of Organization Match Listing Service

Name Description Schema

matchList
optional

< OrganizationMatchResponse > array

1.61. OrganizationMatchReport

Response of Organization Match Report Service

Name Description Schema

direction
optional

Direction Name

StringType

organization
optional

Organization Title

LongType

quantity
optional

Match Quantity

integer(int64)

1.62. OrganizationMatchReportRequestBody

Request of Organization Match Report Service

Name Description Schema

contractNames
required

Contract Names

< string > array

1.63. OrganizationMatchReportResponseBody

Response of Organization Match Report Service

Name Description Schema

organizationMatchReports
optional

< OrganizationMatchReport > array

1.64. OrganizationMatchResponse

Response of Organization Match

Name Description Schema

contractName
required

Contract Name

string

matchDate
required

Match Date

string(date-time)

organizationId
required

Match Order Organization Id

integer(int64)

pointName
required

Order Point

string

purchaseOrganization
required

Organization Title

string

quantity
required

Order Quantity

integer(int64)

saleOrganization
required

Organization Title

string

1.65. ReasonCodeListOrcResponse

{REASON_CODE_LIST_SERVICE_RESPONSE}

Name Description Schema

reasonCodeTypes
optional

< StringType > array

1.1. ReasonCodeListRequestOrcBody

{REASON_CODE_LIST_SERVICE_REQUEST}

Type : object

1.1. RegionalContractResponseBody

Response of Active Contract Saving

Name Description Schema

contracts
optional

< RegionalContractSummary > array

1.2. RegionalContractSummary

N/B Contracts

Name Description Schema

bestAmountPriceBuying
required

BEST BUY

AmountPrice

bestAmountPriceSelling
required

BEST SELL

AmountPrice

closingTime
required

Contract Finish Time

string(date-time)

deliveryDays
required

Gas Delivery Days

< string(date-time) > array

direction
required

Transaction Direction

StringType

gasDays
required

= {CONTRACT_GAS_DAYS}

< GasDay > array

highestMatchingPrice
required

HIGHEST MATCHING PRICE

number

lowestMatchingPrice
required

LOWEST MATCHING PRICE

number

name
required

Contract Name

string

points
required

Points

< integer(int64) > array

remainingAmount
required

Remaining Quantity

integer(int64)

status
required

Contract Status

StringType

totalAmount
required

TOTAL QUANTITY

integer(int64)

type
required

TYPE

StringType

1.3. StringType

String Type

Name Description Schema

text
required

Definition

string

value
required

VALUE

string

1.4. activeContractMatchingRequest

Request of Active Contract Match

Name Description Schema

body
optional

ActiveContractMatchingRequestBody

headers
optional

TITLE

< Header > array

1.5. activeContractMatchingResponse

Response of Active Contract Match

Name Description Schema

body
optional

ActiveContractMatchingResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.6. bidByContractServiceRequest

Request of Order Listing by Contract Name and Status

Name Description Schema

body
optional

BidByContractServiceRequestBody

headers
optional

TITLE

< Header > array

1.7. bidGetByIdServiceRequest

Request of Order Listing by Order Id Service

Name Description Schema

body
optional

BidGetByIdServiceRequestBody

headers
optional

TITLE

< Header > array

1.8. bidGetByIdServiceResponse

Response of Order Listing by Order Id Service

Name Description Schema

body
optional

BidGetByIdServiceResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.9. bidGetServiceRequest

Request of Order Service

Name Description Schema

body
optional

BidGetServiceRequestBody

headers
optional

TITLE

< Header > array

1.10. bidGetServiceResponse

Response of Order Service

Name Description Schema

body
optional

BidGetServiceResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.11. bidHistoryListByMatchServiceRequest

Request of Matched Orders History Service

Name Description Schema

body
optional

BidHistoryListByMatchRequestBody

headers
optional

TITLE

< Header > array

1.12. bidHistoryListByMatchServiceResponse

Response of Matched Orders History Service

Name Description Schema

body
optional

BidHistoryListByMatchResponse

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.13. bidHistoryListServiceRequest

Request of Order History Listing Service

Name Description Schema

body
optional

BidHistoryListRequestBody

headers
optional

TITLE

< Header > array

1.14. bidHistoryListServiceResponse

Response of Order History Listing Service

Name Description Schema

body
optional

BidHistoryListResponse

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.15. bidMatchStatusListServiceRequest

Request of Order Match Status Listing Service

Name Description Schema

body
optional

BidMatchStatusListRequestBody

headers
optional

TITLE

< Header > array

1.16. bidMatchStatusListServiceResponse

Response of Order Match Status Listing Service

Name Description Schema

body
optional

BidMatchStatusListResponse

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.17. bidStatusListServiceRequest

Request of Order Status Listing Service

Name Description Schema

body
optional

BidStatusListRequestBody

headers
optional

TITLE

< Header > array

1.18. bidStatusListServiceResponse

Response of Order Status Listing Service

Name Description Schema

body
optional

BidStatusListResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.19. bidTypeListServiceRequest

Request of Order Type Listing Service

Name Description Schema

body
optional

BidTypeListRequestBody

headers
optional

TITLE

< Header > array

1.20. bidTypeListServiceResponse

Response of Order Type Listing Service

Name Description Schema

body
optional

BidTypeListResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.21. bidUpdateReasonListServiceRequest

Request of Order Update Reason Listing Service

Name Description Schema

body
optional

BidUpdateReasonListRequestBody

headers
optional

TITLE

< Header > array

1.22. bidUpdateReasonListServiceResponse

Response of Order Update Reason Listing Service

Name Description Schema

body
optional

BidUpdateReasonListResponse

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.23. contractConfigurationGetServiceRequest

Request of Contract Configuration Query Service

Name Description Schema

body
optional

ContractConfigurationGetRequestBody

headers
optional

TITLE

< Header > array

1.24. contractConfigurationGetServiceResponse

Response of Contract Configuration Query Service

Name Description Schema

body
optional

ContractConfigurationGetResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.25. contractGateListActiveServiceRequest

Request of Active Contract Gate Listing Service

Name Description Schema

body
optional

ContractGateListActiveRequestBody

headers
optional

TITLE

< Header > array

1.26. contractGateListServiceRequest

Request of Contract Gate Listing Service

Name Description Schema

body
optional

ContractGateListRequestBody

headers
optional

TITLE

< Header > array

1.27. contractGateListServiceResponse

Response of Contract Gate Listing Service

Name Description Schema

body
optional

ContractGateListResponse

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.28. contractGateStatusListServiceRequest

Request of Contract Gate Status Listing Service

Name Description Schema

body
optional

ContractGateStatusListRequestBody

headers
optional

TITLE

< Header > array

1.29. contractGateStatusListServiceResponse

Response of Contract Gate Status Listing Service

Name Description Schema

body
optional

ContractGateStatusListResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.30. contractGetServiceRequest

Request of Contract Listing Service

Name Description Schema

body
optional

ContractGetRequestBody

headers
optional

TITLE

< Header > array

1.31. contractGetServiceResponse

Response of Contract Service

Name Description Schema

body
optional

ContractGetResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.32. contractListServiceRequest

Request of Contract Listing Service

Name Description Schema

body
optional

ContractListRequestBody

headers
optional

TITLE

< Header > array

1.33. contractListServiceResponse

Response of Contract Listing Service

Name Description Schema

body
optional

ContractListResponse

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.34. contractStatusListServiceRequest

{CONTRACT_STATUS_LIST_SERVICE_REQUEST}

Name Description Schema

body
optional

ContractStatusListRequestBody

headers
optional

TITLE

< Header > array

1.1. contractStatusListServiceResponse

Response of Contract Status Listing Service

Name Description Schema

body
optional

ContractStatusListResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.2. contractSummaryResponse

Response of Active Contract Listing Service

Name Description Schema

body
optional

ContractSummaryResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.3. contractTypeListServiceRequest

Request of Contract Type Listing Service

Name Description Schema

body
optional

ContractTypeListRequestBody

headers
optional

TITLE

< Header > array

1.4. contractTypeListServiceResponse

{CONTRACT_TYPE_LIST_SERVICE_RESPONSE}

Name Description Schema

body
optional

ContractTypeListResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.5. currentStatusServiceRequest

Request of Final Net Financial Position

Name Description Schema

body
optional

CurrentStatusServiceRequestBody

headers
optional

TITLE

< Header > array

1.6. currentStatusServiceResponse

Response of Final Net Financial Position

Name Description Schema

body
optional

CurrentStatusServiceResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.7. dailyFinancialStatusProcessLimitServiceRequest

Request of Daily Financial Position Transaction Limit Listing Service

Name Description Schema

body
optional

DailyFinancialStatusProcessLimitRequestBody

headers
optional

TITLE

< Header > array

1.8. dailyFinancialStatusProcessLimitServiceResponse

Response of Daily Financial Position Transaction Limit Listing Service

Name Description Schema

body
optional

DailyFinancialStatusProcessLimitResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.9. directionListServiceRequest

Request of Direction Listing Service

Name Description Schema

body
optional

DirectionListRequestBody

headers
optional

TITLE

< Header > array

1.10. directionListServiceResponse

Response of Direction Listing Service

Name Description Schema

body
optional

DirectionListResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.11. gasDayGetServiceRequest

Service of Gas Day

Name Description Schema

body
optional

GasDayGetRequestBody

headers
optional

TITLE

< Header > array

1.12. gasDayGetServiceResponse

Response of Gas Day Service

Name Description Schema

body
optional

GasDayGetResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.13. gasDayListServiceRequest

Request of Gas Day Listing Service

Name Description Schema

body
optional

GasDayListRequestBody

headers
optional

TITLE

< Header > array

1.14. gasDayListServiceResponse

Response of Gas Day Listing Service

Name Description Schema

body
optional

GasDayListResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.15. gasDaySaveServiceRequest

Request of Gas Day Save Service

Name Description Schema

body
optional

GasDaySaveRequestBody

headers
optional

TITLE

< Header > array

1.16. gasDaySaveServiceResponse

Response of Gas Day Service

Name Description Schema

body
optional

GasDaySaveResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.17. marketPriceGetListResponse

Response Content of Market Price

Name Description Schema

gasDay
required

Market Price Gas Day
Example : "2017-02-07T09:31:33.000+03:00"

string(date-time)

marketPriceResponseList
optional

< MarketPriceResponse > array

1.18. marketPriceGetRequest

Request of Market Price

Name Description Schema

body
optional

MarketPriceGetRequestBody

headers
optional

TITLE

< Header > array

1.19. marketPriceGetResponseBody

Response of Market Price

Name Description Schema

marketPriceGetListResponseList
optional

< marketPriceGetListResponse > array

1.20. marketPriceGetServiceResponse

Response of Market Price Service

Name Description Schema

body
optional

marketPriceGetResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.21. matchCurrentStatusServiceRequest

Request of Match Listing Service

Name Description Schema

body
optional

MatchCurrentStatusRequestBody

headers
optional

TITLE

< Header > array

1.22. matchCurrentStatusServiceResponse

Response of Match Listing Service

Name Description Schema

body
optional

MatchCurrentStatusResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.23. matchDetailListServiceResponse

Response of Match Detail Listing Service

Name Description Schema

body
optional

MatchDetailListResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.24. matchListByBidServiceRequest

Request of Match Listing By Order Service

Name Description Schema

body
optional

MatchListByBidRequestBody

headers
optional

TITLE

< Header > array

1.25. matchListByContractOrgServiceRequest

Request of Organization Match Listing Service

Name Description Schema

body
optional

MatchListByContractOrgRequestBody

headers
optional

TITLE

< Header > array

1.26. matchListByContractServiceRequest

Response of Matched Order by Contract Listing Service

Name Description Schema

body
optional

MatchListByContractRequestBody

headers
optional

TITLE

< Header > array

1.27. matchListByPeriodServiceRequest

Request of Match Listing Service

Name Description Schema

body
optional

MatchListByPeriodRequestBody

headers
optional

TITLE

< Header > array

1.28. matchListByPeriodServiceResponse

Response of Match Listing Service

Name Description Schema

body
optional

MatchListByPeriodResponse

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.29. matchListByRegionalServiceRequest

Request of Match Listing Service

Name Description Schema

body
optional

MatchListByRegionalRequestBody

headers
optional

TITLE

< Header > array

1.30. matchListByRegionalServiceResponse

Response of Match Listing Service

Name Description Schema

body
optional

MatchListByRegionalResponse

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.31. matchListBySelfContractServiceRequest

Request of Match Listing Service

Name Description Schema

body
optional

MatchListBySelfContractRequestBody

headers
optional

TITLE

< Header > array

1.32. matchListServiceRequest

Request of Match Listing Service

Name Description Schema

body
optional

MatchListRequestBody

headers
optional

TITLE

< Header > array

1.33. matchListServiceResponse

Response of Match Listing Service

Name Description Schema

body
optional

MatchListResponse

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.34. objectionCreateServiceRequest

Request of Objection Service

Name Description Schema

body
optional

ObjectionCreateRequestBody

headers
optional

TITLE

< Header > array

1.35. objectionCreateServiceResponse

Response of Objection Service

Name Description Schema

body
optional

ObjectionCreateResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.36. objectionGetServiceRequest

Request of Objection Listing Service

Name Description Schema

body
optional

ObjectionGetRequestBody

headers
optional

TITLE

< Header > array

1.37. objectionGetServiceResponse

Response of Objection Listing Service

Name Description Schema

body
optional

ObjectionGetResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.38. objectionReplyServiceRequest

Request of Objection Answering Service

Name Description Schema

body
optional

ObjectionReplyRequestBody

headers
optional

TITLE

< Header > array

1.39. objectionReplyServiceResponse

Response of Objection Answering Service

Name Description Schema

body
optional

ObjectionReplyResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.40. objectionStatusListServiceRequest

Request of Objection Status Listing Service

Name Description Schema

body
optional

ObjectionStatusListRequestBody

headers
optional

TITLE

< Header > array

1.41. objectionStatusListServiceResponse

Response of Objection Status Listing Service

Name Description Schema

body
optional

ObjectionStatusListResponse

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.42. objectionTypeListServiceRequest

Request of Objection Type Listing Service

Name Description Schema

body
optional

ObjectionTypeListRequestBody

headers
optional

TITLE

< Header > array

1.43. objectionTypeListServiceResponse

Response of Objection Type Listing Service

Name Description Schema

body
optional

ObjectionTypeListResponse

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.44. organizationMatchListServiceResponse

Response of Organization Match Listing Service

Name Description Schema

body
optional

OrganizationMatchListResponse

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.45. organizationMatchReportServiceRequest

Request of Organization Match Report Service

Name Description Schema

body
optional

OrganizationMatchReportRequestBody

headers
optional

TITLE

< Header > array

1.46. organizationMatchReportServiceResponse

Response of Organization Match Report Service

Name Description Schema

body
optional

OrganizationMatchReportResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.47. reasonCodeListOrcServiceResponse

{REASON_CODE_LIST_SERVICE_RESPONSE}

Name Description Schema

body
optional

ReasonCodeListOrcResponse

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

1.1. reasonCodeListServiceRequest

{REASON_CODE_LIST_SERVICE_REQUEST}

Name Description Schema

body
optional

ReasonCodeListRequestOrcBody

headers
optional

TITLE

< Header > array

1.1. regionalContractResponse

Response of Active Contract Saving

Name Description Schema

body
optional

RegionalContractResponseBody

resultCode
required

Result Code
Example : "0"

string

resultDescription
required

Result Code Description
Example : "OK"

string

resultType
required

Result Type
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

Result Type
Example : "#{TRANSACTIONID}"

string

6. OperationCode Get Service

6.1. How to call Operation Code Get Service?

You can check service details from here .

Sample XML Request
<?xml version="1.0" encoding="UTF-8" ?>
<operationCodeGetRequest>
    <headers>
        <key>transactionId</key>
        <value>57a064d5-2eb3-4a0b-bc71-7679d68e5961</value>
    </headers>
    <headers>
        <key>application</key>
        <value>demoIstemci</value>
    </headers>
    <body>
    </body>
</operationCodeGetRequest>
Sample XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<operationCodeGetServiceResponse>
    <resultCode>0</resultCode>
    <resultDescription>OK</resultDescription>
    <resultType>SUCCESS</resultType>
    <body>
        <operationCodes>
            <id>PARAMETER_KEY_1</id>
            <description>Operasyon Tarih Kayıt</description>
        </operationCodes>
    </body>
</operationCodeGetServiceResponse>
Sample Json Request
{
        "headers": [
                {
                        "key": "application",
                        "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
                },
                {
                        "key": "transactionId",
                        "value": "d883f25c-413d-41e8-b695-9731186950dd"
                }
        ],
        "body": {
        }
}
Sample Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "operationCodes": [
      {
        "id": 1,
        "description": "Operasyon Tarih Kayıt"
      }
    ]
  }
}

7. OperationHistory Get Service

7.1. How to call Operation History Get Service?

You can check service details from here .

Sample XML Request
<?xml version="1.0" encoding="UTF-8" ?>
<operationHistoryGetRequest>
        <headers>
                <key>transactionId</key>
                <value>57a064d5-2eb3-4a0b-bc71-7679d68e5961</value>
        </headers>
        <headers>
                <key>application</key>
                <value>demoIstemci</value>
        </headers>
        <body>
                <userName>demo</userName>
                <operationCode>1</operationCode>
                <operationType>USER</operationType>
                <organizationEic>23</organizationEic>
        </body>
</operationHistoryGetRequest>
Sample XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<operationHistoryGetServiceResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS</resultType>
        <body>
                <operationHistoryListResponse>
                        <id>1</id>
                        <organizationEic>23</organizationEic>
                        <priority>INFO</priority>
                        <operationType>USER</operationType>
                        <operationCode>1</operationCode>
                        <description>YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir.</description>
                </operationHistoryListResponse>
                <operationHistoryListResponse>
                        <id>2</id>
                        <organizationEic>23</organizationEic>
                        <priority>INFO</priority>
                        <operationType>USER</operationType>
                        <operationCode>1</operationCode>
                        <description>YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir.</description>
                </operationHistoryListResponse>
                <operationHistoryListResponse>
                        <id>3</id>
                        <organizationEic>23</organizationEic>
                        <priority>INFO</priority>
                        <operationType>USER</operationType>
                        <operationCode>1</operationCode>
                        <description>YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir.</description>
                </operationHistoryListResponse>
                <operationHistoryListResponse>
                        <id>4</id>
                        <organizationEic>23</organizationEic>
                        <priority>INFO</priority>
                        <operationType>USER</operationType>
                        <operationCode>1</operationCode>
                        <description>YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir.</description>
                </operationHistoryListResponse>
                <operationHistoryListResponse>
                        <id>5</id>
                        <organizationEic>23</organizationEic>
                        <priority>INFO</priority>
                        <operationType>USER</operationType>
                        <operationCode>1</operationCode>
                        <description>YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir.</description>
                </operationHistoryListResponse>
        </body>
</operationHistoryGetServiceResponse>
Sample Json Request
{
  "headers": [
    {
      "key": "application",
      "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
    },
    {
      "key": "transactionId",
      "value": "d883f25c-413d-41e8-b695-9731186950dd"
    }
  ],
  "body": {
                                  "startDate": null,
                        "endDate": null,
                "userName": "demo",
                "operationCode": "1",
                "operationType": "USER",
                "organizationEic": "23"
  }
}
Sample Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "operationHistoryListResponse": [
      {
        "id": 5,
        "organizationEic": "23",
        "priority": "INFO",
        "operationType": "USER",
        "referenceId": null,
        "operationCode": 1,
        "description": "YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir."
      },
      {
        "id": 4,
        "organizationEic": "23",
        "priority": "INFO",
        "operationType": "USER",
        "referenceId": null,
        "operationCode": 1,
        "description": "YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir."
      },
      {
        "id": 3,
        "organizationEic": "23",
        "priority": "INFO",
        "operationType": "USER",
        "referenceId": null,
        "operationCode": 1,
        "description": "YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir."
      },
      {
        "id": 2,
        "organizationEic": "23",
        "priority": "INFO",
        "operationType": "USER",
        "referenceId": null,
        "operationCode": 1,
        "description": "YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir."
      },
      {
        "id": 1,
        "organizationEic": "23",
        "priority": "INFO",
        "operationType": "USER",
        "referenceId": null,
        "operationCode": 1,
        "description": "YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir."
      }
    ]
  }
}

8. Match Service

8.1. How to call Match List By Period Service?

Only Daily Contract. PeriodName parameter is optional You can check service details from here .

Sample XML Request
<?xml version="1.0" encoding="UTF-8" ?>
<matchListByPeriodServiceRequest>
    <headers>
        <key>transactionId</key>
        <value>57a064d5-2eb3-4a0b-bc71-7679d68e5961</value>
    </headers>
    <headers>
        <key>application</key>
        <value>demoIstemci</value>
    </headers>
    <body>
        <contractName>GG20180504N2</contractName>
    </body>
</matchListByPeriodServiceRequest>
Sample XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<matchListByPeriodServiceResponse>
    <resultCode>0</resultCode>
    <resultDescription>OK</resultDescription>
    <resultType>SUCCESS</resultType>
    <transactionId>57a064d5-2eb3-4a0b-bc71-7679d68e5961</transactionId>
    <body>
        <contractName>GG20180515</contractName>
        <periodResponses>
            <period>
                <value>P1</value>
                <text>Between G-1 hour 08:00 and G-1 hour 16:00</text>
            </period>
            <periodMatchResponse>
                <organization>
                    <value>40X000000011355I</value>
                    <text>11355 Kısa ad</text>
                </organization>
                <direction>
                    <value>BUY</value>
                    <text>Buy</text>
                </direction>
                <matchQuantity>174</matchQuantity>
            </periodMatchResponse>
            <periodMatchResponse>
                <organization>
                    <value>40X000000011635C</value>
                    <text>DPK-Test29 Firması</text>
                </organization>
                <direction>
                    <value>BUY</value>
                    <text>Buy</text>
                </direction>
                <matchQuantity>124</matchQuantity>
            </periodMatchResponse>
            <periodMatchResponse>
                <organization>
                    <value>40X000000011634E</value>
                    <text>DPK-Test30 Firması</text>
                </organization>
                <direction>
                    <value>SELL</value>
                    <text>Sell</text>
                </direction>
                <matchQuantity>169</matchQuantity>
            </periodMatchResponse>
            <periodMatchResponse>
                <organization>
                    <value>40X0000000117447</value>
                    <text>BOTAŞ İLETİM KISA</text>
                </organization>
                <direction>
                    <value>SELL</value>
                    <text>Sell</text>
                </direction>
                <matchQuantity>129</matchQuantity>
            </periodMatchResponse>
        </periodResponses>
        <periodResponses>
            <period>
                <value>P2</value>
                <text>Between G-1 hour 16:01 and G hour 16:45</text>
            </period>
            <periodMatchResponse>
                <organization>
                    <value>40X000000011355I</value>
                    <text>11355 Kısa ad</text>
                </organization>
                <direction>
                    <value>BUY</value>
                    <text>Buy</text>
                </direction>
                <matchQuantity>741</matchQuantity>
            </periodMatchResponse>
            <periodMatchResponse>
                <organization>
                    <value>40X000000011634E</value>
                    <text>DPK-Test30 Firması</text>
                </organization>
                <direction>
                    <value>SELL</value>
                    <text>Sell</text>
                </direction>
                <matchQuantity>686</matchQuantity>
            </periodMatchResponse>
            <periodMatchResponse>
                <organization>
                    <value>40X0000000117447</value>
                    <text>BOTAŞ İLETİM KISA</text>
                </organization>
                <direction>
                    <value>SELL</value>
                    <text>Sell</text>
                </direction>
                <matchQuantity>55</matchQuantity>
            </periodMatchResponse>
        </periodResponses>
    </body>
</matchListByPeriodServiceResponse>
Sample Json Request
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {
    "contractName": "GG20180515"
  }
}
Sample Json Response
{
    "resultCode": "0",
    "resultDescription": "OK",
    "resultType": "SUCCESS",
    "transactionId": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac",
    "body": {
        "contractName": "GG20180515",
        "periodResponses": [
            {
                "period": {
                    "value": "P1",
                    "text": "Between G-1 hour 08:00 and G-1 hour 16:00"
                },
                "periodMatchResponse": [
                    {
                        "organization": {
                            "value": "40X000000011355I",
                            "text": "11355 Kısa ad"
                        },
                        "direction": {
                            "value": "BUY",
                            "text": "Buy"
                        },
                        "matchQuantity": 174
                    },
                    {
                        "organization": {
                            "value": "40X000000011635C",
                            "text": "DPK-Test29 Firması"
                        },
                        "direction": {
                            "value": "BUY",
                            "text": "Buy"
                        },
                        "matchQuantity": 124
                    },
                    {
                        "organization": {
                            "value": "40X000000011634E",
                            "text": "DPK-Test30 Firması"
                        },
                        "direction": {
                            "value": "SELL",
                            "text": "Sell"
                        },
                        "matchQuantity": 169
                    },
                    {
                        "organization": {
                            "value": "40X0000000117447",
                            "text": "BOTAŞ İLETİM KISA"
                        },
                        "direction": {
                            "value": "SELL",
                            "text": "Sell"
                        },
                        "matchQuantity": 129
                    }
                ]
            },
            {
                "period": {
                    "value": "P2",
                    "text": "Between G-1 hour 16:01 and G hour 16:45"
                },
                "periodMatchResponse": [
                    {
                        "organization": {
                            "value": "40X000000011355I",
                            "text": "11355 Kısa ad"
                        },
                        "direction": {
                            "value": "BUY",
                            "text": "Buy"
                        },
                        "matchQuantity": 741
                    },
                    {
                        "organization": {
                            "value": "40X000000011634E",
                            "text": "DPK-Test30 Firması"
                        },
                        "direction": {
                            "value": "SELL",
                            "text": "Sell"
                        },
                        "matchQuantity": 686
                    },
                    {
                        "organization": {
                            "value": "40X0000000117447",
                            "text": "BOTAŞ İLETİM KISA"
                        },
                        "direction": {
                            "value": "SELL",
                            "text": "Sell"
                        },
                        "matchQuantity": 55
                    }
                ]
            }
        ]
    }
}

8.2. How to call Match List By Regional Service?

Only Regional Contract. You can check service details from here .

Sample XML Request
<?xml version="1.0" encoding="UTF-8"?>
<matchListByRegionalServiceRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
                <contractName>GG20180222N1</contractName>
        </body>
</matchListByRegionalServiceRequest>
Sample XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<matchListByRegionalServiceResponse>
    <resultCode>0</resultCode>
    <resultDescription>OK</resultDescription>
    <resultType>SUCCESS</resultType>
    <transactionId>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</transactionId>
    <body>
        <regionalResponses>
            <organization>
                <value>40X0000000117447</value>
                <text>BOTAŞ İLETİM KISA</text>
            </organization>
            <direction>
                <value>SELL</value>
                <text>Sell</text>
            </direction>
            <matchQuantity>4500</matchQuantity>
            <contractName>GG20180222N1</contractName>
            <pointName>TRKG</pointName>
        </regionalResponses>
        <regionalResponses>
            <organization>
                <value>40X000000011598T</value>
                <text>STP RED</text>
            </organization>
            <direction>
                <value>BUY</value>
                <text>Buy</text>
            </direction>
            <matchQuantity>4500</matchQuantity>
            <contractName>GG20180222N1</contractName>
            <pointName>TRKG</pointName>
        </regionalResponses>
    </body>
</matchListByRegionalServiceResponse>
Sample Json Request
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {
    "contractName": "GG20180222N1"
  }
}
Sample Json Response
{
    "resultCode": "0",
    "resultDescription": "OK",
    "resultType": "SUCCESS",
    "transactionId": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac",
    "body": {
        "regionalResponses": [
            {
                "organization": {
                    "value": "40X0000000117447",
                    "text": "BOTAŞ İLETİM KISA"
                },
                "direction": {
                    "value": "SELL",
                    "text": "Sell"
                },
                "matchQuantity": 4500,
                "contractName": "GG20180222N1",
                "pointName": "TRKG"
            },
            {
                "organization": {
                    "value": "40X000000011598T",
                    "text": "STP RED"
                },
                "direction": {
                    "value": "BUY",
                    "text": "Buy"
                },
                "matchQuantity": 4500,
                "contractName": "GG20180222N1",
                "pointName": "TRKG"
            }
        ]
    }
}