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

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. Active Contract Matching Service

POST /activecontracts/matchings

4.1.1. Description

Active Contract Matching Service

4.1.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service 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. Get Bid History

POST /bid-history/list

4.2.1. Description

Get Bid History

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. Get Match Bids History List

POST /bid-history/listbymatch

4.3.1. Description

Get Match Bids 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. Bid Match Status List Service

POST /bid-match-status/list

4.4.1. Description

Bid Match Status List Service

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. #{BID_STATUS_LIST_NAME}

POST /bid-status/list

4.5.1. Description

Bid Status List Service

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

Bid Type List Service

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. Bid Update Reason List Service

POST /bid-update-reason/list

4.7.1. Description

Bid Update Reason List Service

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. Bid Get Service

POST /bid/get

4.8.1. Description

Bid Matching Information Service

4.8.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service 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. Bid Get Service By ID

POST /bid/getbyid

4.9.1. Description

Bid Get Service By ID

4.9.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service 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. List Bids By Contract

POST /bid/listbycontract

4.10.1. Description

Returns bid list by given contract name and status

4.10.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service 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. Get Contract Configuration

POST /contract-configuration/get

4.11.1. Description

{CONTRACT_CONFIGURATION_GET_DESCRIPTION}

4.11.2. Parameters

Type Name Description Schema Default

Body

body
optional

contractConfigurationGetServiceRequest

4.11.3. Responses

HTTP Code Description Schema

200

successful operation

contractConfigurationGetServiceResponse

4.11.4. Consumes

  • application/json

  • application/xml

4.11.5. Produces

  • application/json

  • application/xml

4.11.6. Tags

  • contract-configuration

4.12. CONTRACT_GATE_LIST_NAME

POST /contract-gate/list

4.12.1. Description

CONTRACT_GATE_LIST_DESCRIPTION

4.12.2. Parameters

Type Name Description Schema Default

Body

body
optional

contractGateListServiceRequest

4.12.3. Responses

HTTP Code Description Schema

200

successful operation

contractGateListServiceResponse

4.12.4. Consumes

  • application/json

  • application/xml

4.12.5. Produces

  • application/json

  • application/xml

4.12.6. Tags

  • contract-gate

4.13. Get Active Contract Gates

POST /contract-gate/list-active

4.13.1. Description

Get Active Contract Gates With Given Contract Name

4.13.2. Parameters

Type Name Description Schema Default

Body

body
optional

contractGateListActiveServiceRequest

4.13.3. Responses

HTTP Code Description Schema

200

successful operation

contractGateListServiceResponse

4.13.4. Consumes

  • application/json

  • application/xml

4.13.5. Produces

  • application/json

  • application/xml

4.13.6. Tags

  • contract-gate

4.14. #{CONTRACT_STATUS_LIST_NAME}

POST /contract-status/list

4.14.1. Description

{CONTRACT_STATUS_LIST_DESCRIPTION}

1.1. Parameters

Type Name Description Schema Default

Body

body
optional

contractStatusListServiceRequest

1.2. Responses

HTTP Code Description Schema

200

successful operation

contractStatusListServiceResponse

1.3. Consumes

  • application/json

  • application/xml

1.4. Produces

  • application/json

  • application/xml

1.5. Tags

  • contract-status

1.6. List Contract Type Service

POST /contract-type/list

1.6.1. Description

List All Contract Type Rest Service

1.6.2. Parameters

Type Name Description Schema Default

Body

body
optional

contractTypeListServiceRequest

1.6.3. Responses

HTTP Code Description Schema

200

successful operation

contractTypeListServiceResponse

1.6.4. Consumes

  • application/json

  • application/xml

1.6.5. Produces

  • application/json

  • application/xml

1.6.6. Tags

  • contract-type

1.7. Contract Get Service

POST /contract/get

1.7.1. Description

Contract Get Service

1.7.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service ST Header

string

Body

body
optional

contractGetServiceRequest

1.7.3. Responses

HTTP Code Description Schema

200

successful operation

contractGetServiceResponse

1.7.4. Consumes

  • application/json

  • application/xml

1.7.5. Produces

  • application/json

  • application/xml

1.7.6. Tags

  • contract

1.8. Contract List Service

POST /contract/list

1.8.1. Description

Return Contract List for given parameters

1.8.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service ST Header

string

Body

body
optional

contractListServiceRequest

1.8.3. Responses

HTTP Code Description Schema

200

successful operation

contractListServiceResponse

1.8.4. Consumes

  • application/json

  • application/xml

1.8.5. Produces

  • application/json

  • application/xml

1.8.6. Tags

  • contract

1.9. Organization Match Report for Contract

POST /contract/organization-report

1.9.1. Description

Organization Match Report for Contract

1.9.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service ST Header

string

Body

body
optional

organizationMatchReportServiceRequest

1.9.3. Responses

HTTP Code Description Schema

200

successful operation

organizationMatchReportServiceResponse

1.9.4. Consumes

  • application/json

  • application/xml

1.9.5. Produces

  • application/json

  • application/xml

1.9.6. Tags

  • contract

1.10. Current Active Regional Contract List Service

POST /contract/regional

1.10.1. Description

Lists active contracts currently is open or is about to open.

1.10.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service ST Header

string

Body

body
optional

contractListServiceRequest

1.10.3. Responses

HTTP Code Description Schema

200

successful operation

regionalContractResponse

1.10.4. Consumes

  • application/json

  • application/xml

1.10.5. Produces

  • application/json

  • application/xml

1.10.6. Tags

  • contract

1.11. Current Active Contract List Service

POST /contract/standart

1.11.1. Description

Lists active contracts currently is open or is about to open.

1.11.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service ST Header

string

Body

body
optional

contractListServiceRequest

1.11.3. Responses

HTTP Code Description Schema

200

successful operation

contractSummaryResponse

1.11.4. Consumes

  • application/json

  • application/xml

1.11.5. Produces

  • application/json

  • application/xml

1.11.6. Tags

  • contract

1.12. Current Net Status List Service

POST /daily-financial-status/current-status

1.12.1. Description

List current net financial data of organization.

1.12.2. Parameters

Type Name Description Schema Default

Body

body
optional

currentStatusServiceRequest

1.12.3. Responses

HTTP Code Description Schema

200

successful operation

currentStatusServiceResponse

1.12.4. Consumes

  • application/json

  • application/xml

1.12.5. Produces

  • application/json

  • application/xml

1.12.6. Tags

  • daily-financial-status

1.13. Daily Financial Status Process Limit List Service

POST /daily-financial-status/process-limit

1.13.1. Description

Daily Financial Status Process Limit List Service

1.13.2. Parameters

Type Name Description Schema Default

Body

body
optional

dailyFinancialStatusProcessLimitServiceRequest

1.13.3. Responses

HTTP Code Description Schema

200

successful operation

dailyFinancialStatusProcessLimitServiceResponse

1.13.4. Consumes

  • application/json

  • application/xml

1.13.5. Produces

  • application/json

  • application/xml

1.13.6. Tags

  • daily-financial-status

1.14. #{DIRECTION_LIST_NAME}

POST /direction/list

1.14.1. Description

Direction List Service

1.14.2. Parameters

Type Name Description Schema Default

Body

body
optional

directionListServiceRequest

1.14.3. Responses

HTTP Code Description Schema

200

successful operation

directionListServiceResponse

1.14.4. Consumes

  • application/json

  • application/xml

1.14.5. Produces

  • application/json

  • application/xml

1.14.6. Tags

  • direction

1.15. All Gas Days

POST /gas-day/all

1.15.1. Description

Get All Gas Days

1.15.2. Parameters

Type Name Description Schema Default

Body

body
optional

gasDayListServiceRequest

1.15.3. Responses

HTTP Code Description Schema

200

successful operation

gasDayListServiceResponse

1.15.4. Consumes

  • application/json

  • application/xml

1.15.5. Produces

  • application/json

  • application/xml

1.15.6. Tags

  • gas-day

1.16. #{GAS_DAY_GET_NAME}

POST /gas-day/get

1.16.1. Description

Gas Day get

1.16.2. Parameters

Type Name Description Schema Default

Body

body
optional

gasDayGetServiceRequest

1.16.3. Responses

HTTP Code Description Schema

200

successful operation

gasDayGetServiceResponse

1.16.4. Consumes

  • application/json

  • application/xml

1.16.5. Produces

  • application/json

  • application/xml

1.16.6. Tags

  • gas-day

1.17. #{GAS_DAY_LIST_NAME}

POST /gas-day/list

1.17.1. Description

Gas Day List

1.17.2. Parameters

Type Name Description Schema Default

Body

body
optional

gasDayListServiceRequest

1.17.3. Responses

HTTP Code Description Schema

200

successful operation

gasDayListServiceResponse

1.17.4. Consumes

  • application/json

  • application/xml

1.17.5. Produces

  • application/json

  • application/xml

1.17.6. Tags

  • gas-day

1.18. Gas Day Save

POST /gas-day/save

1.18.1. Description

Save Gas Day

1.18.2. Parameters

Type Name Description Schema Default

Body

body
optional

gasDaySaveServiceRequest

1.18.3. Responses

HTTP Code Description Schema

200

successful operation

gasDaySaveServiceResponse

1.18.4. Consumes

  • application/json

  • application/xml

1.18.5. Produces

  • application/json

  • application/xml

1.18.6. Tags

  • gas-day

1.19. Contract Gate State List Service

POST /gate-status/list

1.19.1. Description

Contract Gate State List Service

1.19.2. Parameters

Type Name Description Schema Default

Body

body
optional

contractGateStatusListServiceRequest

1.19.3. Responses

HTTP Code Description Schema

200

successful operation

contractGateStatusListServiceResponse

1.19.4. Consumes

  • application/json

  • application/xml

1.19.5. Produces

  • application/json

  • application/xml

1.19.6. Tags

  • gate-status

1.20. #{MARKET_PRICE_GET_VALUE}

POST /market-price/get

1.20.1. Description

{MARKET_PRICE_GET_NOTES}

1.1. Parameters

Type Name Description Schema Default

Body

body
optional

marketPriceGetRequest

1.2. Responses

HTTP Code Description Schema

200

successful operation

marketPriceGetServiceResponse

1.3. Consumes

  • application/json

  • application/xml

1.4. Produces

  • application/json

  • application/xml

1.5. Tags

  • market-price

1.6. Organizasyon bazında bir kontrata ait aktif eşleşme netleri

POST /match/current-status

1.6.1. Description

Organizasyon bazında bir kontrata ait aktif eşleşme netleri

1.6.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchCurrentStatusServiceRequest

1.6.3. Responses

HTTP Code Description Schema

200

successful operation

matchCurrentStatusServiceResponse

1.6.4. Consumes

  • application/json

  • application/xml

1.6.5. Produces

  • application/json

  • application/xml

1.6.6. Tags

  • match

1.7. Matching List

POST /match/list

1.7.1. Description

Matching List Description

1.7.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchListServiceRequest

1.7.3. Responses

HTTP Code Description Schema

200

successful operation

matchListServiceResponse

1.7.4. Consumes

  • application/json

  • application/xml

1.7.5. Produces

  • application/json

  • application/xml

1.7.6. Tags

  • match

1.8. Matching Detail List

POST /match/list-detail

1.8.1. Description

Matching Detail List Only Called By Exist Users

1.8.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchListServiceRequest

1.8.3. Responses

HTTP Code Description Schema

200

successful operation

matchDetailListServiceResponse

1.8.4. Consumes

  • application/json

  • application/xml

1.8.5. Produces

  • application/json

  • application/xml

1.8.6. Tags

  • exist

  • match

1.9. Match List By Bid Service

POST /match/listbybid

1.9.1. Description

Lists matches by bid service.

1.9.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchListByBidServiceRequest

1.9.3. Responses

HTTP Code Description Schema

200

successful operation

matchListServiceResponse

1.9.4. Consumes

  • application/json

  • application/xml

1.9.5. Produces

  • application/json

  • application/xml

1.9.6. Tags

  • match

1.10. Match List with Contracts Names

POST /match/listbycontract

1.10.1. Description

Match List with Contracts Names.

1.10.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchListByContractServiceRequest

1.10.3. Responses

HTTP Code Description Schema

200

successful operation

matchDetailListServiceResponse

1.10.4. Consumes

  • application/json

  • application/xml

1.10.5. Produces

  • application/json

  • application/xml

1.10.6. Tags

  • match

1.11. Organization Match List

POST /match/listbycontractorg

1.11.1. Description

Organization Match List

1.11.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchListByContractOrgServiceRequest

1.11.3. Responses

HTTP Code Description Schema

200

successful operation

organizationMatchListServiceResponse

1.11.4. Consumes

  • application/json

  • application/xml

1.11.5. Produces

  • application/json

  • application/xml

1.11.6. Tags

  • match

1.12. List Match for Daily Contract

POST /match/listbyperiod

1.12.1. Description

List Match for Daily Contract

1.12.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchListByPeriodServiceRequest

1.12.3. Responses

HTTP Code Description Schema

200

successful operation

matchListByPeriodServiceResponse

1.12.4. Consumes

  • application/json

  • application/xml

1.12.5. Produces

  • application/json

  • application/xml

1.12.6. Tags

  • match

1.13. List Match for Regional Contract

POST /match/listbyregional

1.13.1. Description

List Match for Regional Contract

1.13.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchListByRegionalServiceRequest

1.13.3. Responses

HTTP Code Description Schema

200

successful operation

matchListByRegionalServiceResponse

1.13.4. Consumes

  • application/json

  • application/xml

1.13.5. Produces

  • application/json

  • application/xml

1.13.6. Tags

  • match

1.14. Match List with Contracts Names

POST /match/listbyselfcontract

1.14.1. Description

Match List with Contracts Names

1.14.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchListBySelfContractServiceRequest

1.14.3. Responses

HTTP Code Description Schema

200

successful operation

matchListServiceResponse

1.14.4. Consumes

  • application/json

  • application/xml

1.14.5. Produces

  • application/json

  • application/xml

1.14.6. Tags

  • match

1.15. #{OBJECTION_STATUS_LIST_NAME}

POST /objection-status/list

1.15.1. Description

{OBJECTION_STATUS_LIST_DESCRIPTION}

1.1. Parameters

Type Name Description Schema Default

Body

body
optional

objectionStatusListServiceRequest

1.2. Responses

HTTP Code Description Schema

200

successful operation

objectionStatusListServiceResponse

1.3. Consumes

  • application/json

  • application/xml

1.4. Produces

  • application/json

  • application/xml

1.5. Tags

  • objection-status

1.6. Objection Type List Service

POST /objection-type/list

1.6.1. Description

Retrieves All Objection Types

1.6.2. Parameters

Type Name Description Schema Default

Body

body
optional

objectionTypeListServiceRequest

1.6.3. Responses

HTTP Code Description Schema

200

successful operation

objectionTypeListServiceResponse

1.6.4. Consumes

  • application/json

  • application/xml

1.6.5. Produces

  • application/json

  • application/xml

1.6.6. Tags

  • objection-type

1.7. Objection Create Service

POST /objection/create

1.7.1. Description

Creates an Objection

1.7.2. Parameters

Type Name Description Schema Default

Body

body
optional

objectionCreateServiceRequest

1.7.3. Responses

HTTP Code Description Schema

200

successful operation

objectionCreateServiceResponse

1.7.4. Consumes

  • application/json

  • application/xml

1.7.5. Produces

  • application/json

  • application/xml

1.7.6. Tags

  • objection

1.8. Objection Get Service

POST /objection/get

1.8.1. Description

Retrieves Objections For Given Criteria

1.8.2. Parameters

Type Name Description Schema Default

Body

body
optional

objectionGetServiceRequest

1.8.3. Responses

HTTP Code Description Schema

200

successful operation

objectionGetServiceResponse

1.8.4. Consumes

  • application/json

  • application/xml

1.8.5. Produces

  • application/json

  • application/xml

1.8.6. Tags

  • objection

1.9. Objection Reply Service

POST /objection/reply

1.9.1. Description

Replies an Objection

1.9.2. Parameters

Type Name Description Schema Default

Body

body
optional

objectionReplyServiceRequest

1.9.3. Responses

HTTP Code Description Schema

200

successful operation

objectionReplyServiceResponse

1.9.4. Consumes

  • application/json

  • application/xml

1.9.5. Produces

  • application/json

  • application/xml

1.9.6. Tags

  • objection

5. Definitions

5.1. ActiveContractMatchingRequestBody

Active Contract Matching List Request Body

Name Description Schema

contractNames
required

= {CONTRACT_NAMES}

< string > array

5.2. ActiveContractMatchingResponseBody

Active Contract Matching Response Body

Name Description Schema

matchings
optional

< Match > array

5.3. AmountPrice

Miktar Fiyat Ä°kilisi

Name Description Schema

amount
optional

Miktar

integer(int64)

price
optional

Fiyat

number

5.4. BidByContractServiceRequestBody

Service Request

Name Description Schema

bidId
optional

Bid ID

string

bidStatusNames
optional

BID_STATUS_NAME

< string > array

contractNames
required

= {CONTRACT_STATUS}

< string > array

5.5. BidGetByIdServiceRequestBody

Bid Get Service By ID Request

Name Description Schema

bidId
required

Bid ID

string

5.6. BidGetByIdServiceResponseBody

Bid Get Service By ID Response

Name Description Schema

bid
optional

BidResponse

5.7. BidGetServiceRequestBody

Bid Get Service Request

Name Description Schema

bidEndDate
required

Bid End Date

string(date-time)

bidStartDate
required

Bid Start Date

string(date-time)

marketDayType
required

Market Day Type

enum (GASDAY, GASWEEK, ALL)

5.8. BidGetServiceResponseBody

Bid Get Service Response

Name Description Schema

bidResponses
optional

< BidResponse > array

5.9. BidHistoryListByMatchRequestBody

Get Match Bids History List Service Request

Name Description Schema

matchId
required

Matching ID

string

5.10. BidHistoryListByMatchResponse

Get Match Bids History List Service Response

Name Description Schema

purchaseBidHistoryList
optional

< BidHistoryResponse > array

saleBidHistoryList
optional

< BidHistoryResponse > array

5.11. BidHistoryListRequestBody

Bid History List Request Body

Name Description Schema

bidIds
optional

Bid ID

< string > array

5.12. BidHistoryListResponse

Bid History List Service Response

Name Description Schema

bidHistoryList
optional

< BidHistoryResponse > array

partialMatchAverage
optional

number

5.13. BidHistoryResponse

Bid History Response

Name Description Schema

bidDate
optional

Bid Date

string(date-time)

bidExpiredDate
optional

string(date-time)

bidHistoryId
optional

Bid History id

integer(int64)

bidPointName
optional

Bid Point

string

bidPrice
optional

Bid Price

number

bidQuantity
optional

Bid Quantity

integer(int64)

bidState
optional

Bid State

StringType

bidType
optional

Bid Type

StringType

contractName
optional

Bid Contract

string

direction
optional

Operation

StringType

id
optional

Bid ID

string

matchId
optional

Matching ID

string

matchPrice
optional

Matching Price

number

matchQuantity
optional

Matching Quantity

integer(int64)

matchState
optional

Bid Match Status

StringType

matchStatus
optional

Bid Match Status

StringType

matchVersion
optional

integer(int32)

modifyDate
optional

Bid Date

string(date-time)

organizationName
optional

Organization Name

string

organizationShortName
optional

Organization Short Name

string

purchaseOrgName
optional

Organization Name

string

remainingQuantity
optional

Bid Remaining Quantity

integer(int64)

saleOrgName
optional

Organization Name

string

status
optional

Bid Status

StringType

updateReason
optional

Bid Update Reason

StringType

user
optional

Bid User

string

5.14. BidMatchStatusListRequestBody

Bid Match Status List Service Request

Type : object

5.15. BidMatchStatusListResponse

Bid Match Status List Service Response

Name Description Schema

bidMatchStatusList
optional

< BidMatchStatusResponse > array

5.16. BidMatchStatusResponse

Bid Match Status List Service Response

Name Description Schema

localization
required

Bid Match Status Localizations

LocalizationResponse

name
required

Bid Match Status Name

string

5.17. BidResponse

Bid Get Service Response

Name Description Schema

bidDate
optional

Bid Date

string(date-time)

bidExpiredDate
optional

string(date-time)

bidPointName
optional

Bid Point

string

bidPrice
optional

Bid Price

number

bidProcess
optional

Bid Process

StringType

bidQuantity
optional

Bid Quantity

integer(int64)

bidState
optional

Bid State

StringType

bidType
optional

Bid Type

StringType

contractName
optional

Bid Contract

string

direction
optional

Operation

StringType

id
optional

Bid ID

string

matchingStatus
optional

Bid Match Status

StringType

modifyDate
optional

Bid Date

string(date-time)

organizationEic
optional

= {BID_ORGANIZATION_EIC}

string

organizationInfo
optional

Organization

StringType

remainingQuantity
optional

= {BID_REMANING_QUANTITY}

integer(int64)

status
optional

Bid Status

StringType

updateReason
optional

Bid Update Reason

StringType

user
optional

Bid User

string

version
optional

Bid Version

integer(int32)

5.18. BidStatusListRequestBody

{BID_STATUS_LIST_REQUEST_BODY}

Type : object

1.1. BidStatusListResponseBody

{BID_STATUS_LIST_RESPONSE_BODY}

Name Description Schema

bidStatuses
optional

< StringType > array

1.1. BidTypeListRequestBody

{BID_TYPE_LIST_REQUEST_BODY}

Type : object

1.1. BidTypeListResponseBody

{BID_TYPE_LIST_RESPONSE_BODY}

Name Description Schema

bidTypes
optional

< StringType > array

1.1. BidUpdateReasonListRequestBody

Bid Update Reason List Service Request

Type : object

1.2. BidUpdateReasonListResponse

Bid Update Reason List Service Response

Name Description Schema

bidUpdateReasonList
optional

< BidUpdateReasonResponse > array

1.3. BidUpdateReasonResponse

Bid Update Reason List Service Response

Name Description Schema

localization
required

Bid Update Reason Localizations

LocalizationResponse

name
required

Bid Update Reason Name

string

1.4. BlockingAmount

Blocking Amount

Name Description Schema

amount
required

Amount

number

gasDay
required

Reference Time

string(date-time)

1.5. Collateral

Collateral

Name Description Schema

amount
required

Amount

number

referenceTime
required

Reference Time

string(date-time)

1.6. ContractConfigurationGetRequestBody

Contract Configuration Get Service Request

Name Description Schema

contractName
required

= {CONTRACT_NAME}

string

1.7. ContractConfigurationGetResponseBody

Contract Configuration Get Service Response

Name Description Schema

baseCoefficient
optional

Base Product Coefficient

number

ceilingCoefficient
optional

Ceiling Product Coefficient

number

contractConfId
optional

Contract Configuration Id

integer(int64)

dapFinalDate
optional

Day Ahead Price Finalization Date

string(date-time)

dapScopeDate
optional

Day Ahead Price Scope Date

string(date-time)

grpFinalDate
optional

Gas Reference Price Finalization Date

string(date-time)

grpScopeDate
optional

Gas Reference Price Scope Date

string(date-time)

lpa
optional

Last Price Average

integer(int64)

lqa
optional

Last Quantitiy Average

integer(int64)

marketBasePrice
optional

Market Base Price

number

marketCeilingPrice
optional

Market Ceiling Price

number

marketMaxQuantity
optional

Market Max Quantity

integer(int64)

marketMinQuantity
optional

Market Min Quantity

integer(int64)

nbpOpenTime
optional

National Balancing Point Open Time

number

objectionTime
optional

Objection Time

number

retrospectiveAverage
optional

Gas Reference Price Retrospective Average

number

transmissionBasePrice
optional

Transmission Base Price

number

transmissionBasePriceFormula
optional

Transmission Base Price Formula

string

transmissionCeilingPrice
optional

Transmission Ceiling Price

number

transmissionCeilingPriceFormula
optional

Transmission Ceiling Price Formula

string

transmissionMaxQuantity
optional

Transmission Max Quantity

integer(int64)

transmissionMinQuantity
optional

Transmission Min Quantity

integer(int64)

1.8. ContractGateListActiveRequestBody

Contract Gate List Active Request Body

Name Description Schema

contractName
required

string

1.9. ContractGateListRequestBody

CONTRACT_GATE_LIST_SERVICE_REQUEST

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.10. ContractGateListResponse

{CONTRACT_GET_SERVICE_RESPONSE}

Name Description Schema

contractGateList
optional

< ContractGateResponse > array

1.1. ContractGateResponse

{CONTRACT_GATE_SERVICE_RESPONSE}

Name Description Schema

announcementDate
optional

= {CONTRACT_GATE_ANNOUNCEMENT_DATE}

string(date-time)

contractGateId
optional

= {CONTRACT_GATE_ID}

integer(int64)

contractName
optional

= {CONTRACT_NAME}

string

contractType
optional

= {CONTRACT_TYPE}

ContractTypeResponse

directionResponse
optional

= {DIRECTION_RESPONSE}

DirectionResponse

endDate
optional

= {CONTRACT_GATE_END_DATE}

string(date-time)

gateStatusResponse
optional

= {CONTRACT_GATE_STATUS}

ContractGateStatusResponse

gateTypeResponse
optional

= {CONTRACT_GATE_NAME}

ContractGateTypeResponse

physicalPointIds
optional

= {CONTRACT_GATE_PHYSICAL_POINTS}

< integer(int64) > array

quantity
optional

= {CONTRACT_GATE_QUANTITY}

integer(int64)

startDate
optional

= {CONTRACT_GATE_START_DATE}

string(date-time)

transmissionBidActivate
optional

Transmission Bid Activate Time

string(date-time)

1.2. ContractGateStatusListRequestBody

Contract Gate State List Service Request

Type : object

1.3. ContractGateStatusListResponseBody

Contract Gate State List Service Response

Name Description Schema

contractGateStatuses
optional

< StringType > array

1.4. ContractGateStatusResponse

{CONTRACT_GATE_STATUS_SERVICE_RESPONSE}

Name Description Schema

localization
required

= {CONTRACT_GATE_STATUS_LOCALIZATION}

LocalizationResponse

name
required

= {CONTRACT_GATE_STATUS_NAME}

string

1.1. ContractGateTypeResponse

{CONTRACT_GATE_TYPE_SERVICE_RESPONSE}

Name Description Schema

localization
required

= {CONTRACT_GATE_TYPE_LOCALIZATION}

LocalizationResponse

name
required

= {CONTRACT_GATE_NAME}

string

1.1. ContractGetRequestBody

Contract Get Request Body

Name Description Schema

contractName
required

= {CONTRACT_NAME}

string

1.2. ContractGetResponseBody

Contract Get Response Body

Name Description Schema

contract
optional

ContractResponse

1.3. ContractListRequestBody

{CONTRACT_LIST_SERVICE_REQUEST}

Name Description Schema

contractStatusNames
required

= {CONTRACT_STATUS_NAME}

< string > array

contractTypeName
optional

= {CONTRACT_TYPE_NAME}

string

gasDayDate
optional

Gas Day Date

string(date-time)

1.1. ContractListResponse

{CONTRACT_LIST_SERVICE_RESPONSE}

Name Description Schema

contractList
optional

< ContractResponse > array

1.1. ContractResponse

{CONTRACT_GET_SERVICE_RESPONSE}

Name Description Schema

activationDate
required

= {CONTRACT_ACTIVATION_DATE}

string(date-time)

closeDate
required

= {CONTRACT_CLOSE_DATE}

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_CREATE_DATE}

string(date-time)

gasDays
required

= {CONTRACT_GAS_DAYS}

< GasDay > array

1.1. ContractStatusListRequestBody

{CONTRACT_STATUS_LIST_REQUEST_BODY}

Type : object

1.1. ContractStatusListResponseBody

{CONTRACT_STATUS_LIST_RESPONSE_BODY}

Name Description Schema

contractStatuses
optional

< StringType > array

1.1. ContractStatusResponse

{CONTRACT_STATUS_LIST_SERVICE_RESPONSE}

Name Description Schema

localization
required

= {CONTRACT_STATUS_LOCALIZATION}

LocalizationResponse

name
required

= {CONTRACT_STATUS_NAME}

string

1.1. ContractSummary

{CONTRACT_SUMMARY}

Name Description Schema

bestAmountPriceBuying
required

Best Buying

AmountPrice

bestAmountPriceSelling
required

Best Selling

AmountPrice

closingTime
required

Contract Closing 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 Matching Price

number

lowestMatchingPrice
required

Lowest Matching Price

number

name
required

Contract Name

string

status
required

Contract State

StringType

type
required

Type

StringType

weightedAverage
required

Weighted Average

number

1.1. ContractSummaryResponseBody

Current Active Contract List Service Response

Name Description Schema

contracts
optional

< ContractSummary > array

1.2. ContractTypeListRequestBody

{CONTRACT_TYPE_LIST_REQUEST_BODY}

Type : object

1.1. ContractTypeListResponseBody

{CONTRACT_TYPE_LIST_RESPONSE_BODY}

Name Description Schema

contractTypes
optional

< StringType > array

1.1. ContractTypeResponse

{CONTRACT_TYPE_LIST_SERVICE_RESPONSE}

Name Description Schema

localization
required

= {CONTRACT_TYPE_LOCALIZATION}

LocalizationResponse

name
required

= {CONTRACT_TYPE_NAME}

string

1.2. CurrentNetFinancialStatus

Latest Financial Status

Name Description Schema

advancePaymentDate
optional

Advance Payment Date

string(date-time)

advancePaymentDayNetFinancialStatus
required

Advance Payment Date Net Financial Status

number

financialStatusItems
optional

< NetFinancialStatus > array

gasday
required

= {CONTRACT_GAS_DAY}

string(date-time)

processLimit
required

Process Limit

number

1.3. CurrentStatusServiceRequestBody

Current Net Financial Status Request

Type : object

1.4. CurrentStatusServiceResponseBody

Current Net Financial Status Response

Name Description Schema

blockingAmounts
optional

< BlockingAmount > array

collaterals
optional

< Collateral > array

netstatuses
optional

< CurrentNetFinancialStatus > array

organization
required

Organization Name

StringType

1.5. DailyFinancialStatusProcessLimitRequestBody

Daily Financial Status Process Limit List Request Body

Name Description Schema

contractName
required

= {CONTRACT_NAME}

string

1.6. DailyFinancialStatusProcessLimitResponseBody

Daily Financial Status Process Limit List Response Body

Name Description Schema

processLimit
required

Process Limit

number

1.7. DirectionListRequestBody

{DIRECTION_LIST_REQUEST_BODY}

Type : object

1.1. DirectionListResponseBody

{DIRECTION_LIST_RESPONSE_BODY}

Name Description Schema

directionList
optional

< StringType > array

1.1. DirectionResponse

{DIRECTION_LIST_SERVICE_RESPONSE}

Name Description Schema

localization
required

= {DIRECTION_LOCALIZATION}

LocalizationResponse

name
required

= {DIRECTION_NAME}

string

1.1. GasDay

{CONTRACT_GAS_DAY}

Name Description Schema

advancePaymentDate
optional

Advance Payment Date

string(date-time)

gasDayDate
optional

Gas Day Date

string(date-time)

gasDayId
optional

Gas Day ID

integer(int64)

gasDeliveryEndDate
optional

Gas Day End Date

string(date-time)

gasDeliveryStartDate
optional

Gas Day Start Date

string(date-time)

registrationPeriodId
optional

Gas Day Registration Period ID

integer(int64)

1.1. GasDayGetRequestBody

{GAS_DAY_GET_REQUEST_BODY}

Name Description Schema

gasDayDate
required

Gas Day Date

string(date-time)

1.1. GasDayGetResponseBody

{GAS_DAY_GET_RESPONSE_BODY}

Name Description Schema

gasDayGetResponse
optional

GasDayResponse

1.1. GasDayListRequestBody

{GAS_DAY_LIST_REQUEST_BODY}

Type : object

1.1. GasDayListResponseBody

{GAS_DAY_LIST_RESPONSE_BODY}

Name Description Schema

gasDayListResponse
optional

< GasDayResponse > array

1.1. GasDayResponse

{GAS_DAY_GET_RESPONSE}

Name Description Schema

abpAbsEarlyDate
optional

Additional Balancing Purchase / Sale Early Date

string(date-time)

abpAbsFinalDate
optional

Additional Balancing Purchase / Sale Final Date

string(date-time)

abpFormula
optional

Additional Balancing Purchase Formula

string

abpPrice
optional

Additional Balancing Purchase Price

number

absFormula
optional

Additional Balancing Sale Formula

string

absPrice
optional

Additional Balancing Sale Price

number

advancePaymentDate
optional

Advance Payment Date

string(date-time)

bgpBgsEarlyDate
optional

Balancing Gas Purchase / Sale Early Date

string(date-time)

bgpBgsFinalDate
optional

Balancing Gas Purchase / Sale Final Date

string(date-time)

bgpFormula
optional

Balancing Gas Purchase Formula

string

bgpPrice
optional

Balancing Gas Purchase Price

number

bgsFormula
optional

Balancing Gas Sale Formula

string

bgsPrice
optional

Balancing Gas Sale Price

number

gasDayDate
optional

Gas Day Date

string(date-time)

gasDayId
optional

Gas Day ID

integer(int64)

gasDeliveryEndDate
optional

Gas Day End Date

string(date-time)

gasDeliveryStartDate
optional

Gas Day Start Date

string(date-time)

registrationPeriodId
optional

= {REGISTER_PERIOD_ID}

integer(int64)

1.1. GasDaySaveRequestBody

{GAS_DAY_SAVE_SERVICE_REQUEST}

Name Description Schema

abpAbsEarlyDate
optional

Additional Balancing Purchase / Sale Early Date

string(date-time)

abpAbsFinalDate
optional

Additional Balancing Purchase / Sale Final Date

string(date-time)

abpFormula
optional

Additional Balancing Purchase Formula

string

abpPrice
optional

Additional Balancing Purchase Price

number

absFormula
optional

Additional Balancing Sale Formula

string

absPrice
optional

Additional Balancing Sale Price

number

bgpBgsEarlyDate
optional

Balancing Gas Purchase / Sale Early Date

string(date-time)

bgpBgsFinalDate
optional

Balancing Gas Purchase / Sale Final Date

string(date-time)

bgpFormula
optional

Balancing Gas Purchase Formula

string

bgpPrice
optional

Balancing Gas Purchase Price

number

bgsFormula
optional

Balancing Gas Sale Formula

string

bgsPrice
optional

Balancing Gas Sale Price

number

gasDayDate
required

Gas Day Date

string(date-time)

gasDeliveryEndDate
required

Gas Day End Date

string(date-time)

gasDeliveryStartDate
required

Gas Day Start Date

string(date-time)

registrationPeriodId
required

= {REGISTER_PERIOD_ID}

integer(int64)

1.1. GasDaySaveResponseBody

Gas Day Save Service Response

Type : object

1.2. Header

{HEADER}

Name Description Schema

key
optional

= {HEADER_KEY}
Example : "transactionId"

string

value
optional

= {HEADER_VALUE}
Example : "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"

string

1.1. LocalizationResponse

{LOCALIZATION_SERVICE_RESPONSE}

Name Description Schema

language
required

= {LOCALIZATION_LANGUAGE}

string

text
required

= {LOCALIZATION_TEXT}

string

1.1. LongType

Numerical Type

Name Description Schema

text
required

Description

string

value
required

Value

integer(int64)

1.2. MarketPriceGetRequestBody

{MARKET_PRICE_GET_REQUEST_BODY_DESCRIPTION}

Name Description Schema

gasDayEndDate
optional

= {MARKET_PRICE_GASDAY_NAME}
Example : "2017-02-07T09:31:33.000+03:00"

string(date-time)

gasDayStartDate
required

= {MARKET_PRICE_GASDAY_NAME}
Example : "2017-02-07T09:31:33.000+03:00"

string(date-time)

priceType
optional

= {MARKET_PRICE_PRICE_TYPE_NAME}
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.1. MarketPriceResponse

{MARKET_PRICE_GET_RESPONSE_BODY_DESCRIPTION}

Name Description Schema

price
required

= {MARKET_PRICE_PRICE_NAME}

number

priceType
required

= {MARKET_PRICE_PRICE_TYPE_NAME}
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_STATE_NAME}
Example : "EARLY, FINAL"

enum (EARLY, FINAL)

1.1. Match

Matching

Name Description Schema

contract
required

= {CONTRACT_NAME}

string

matchId
required

Matching Id

string

matchStatus
required

Matching Status

string

matchingTime
required

Matching Time

string(date-time)

myOwnMatching
required

My Own Matching
Default : false

boolean

pointName
optional

Bid Point

string

price
required

Price

number

quantity
required

Quantity

integer(int64)

1.2. MatchByPeriod

Match Response

Name Description Schema

direction
required

= {DIRECTION_RESPONSE}

StringType

matchQuantity
required

Matching Quantity

integer(int64)

organization
required

Organization

StringType

1.3. MatchByPeriodResponse

Match Response

Name Description Schema

period
required

Match Period

StringType

periodMatchResponse
optional

< MatchByPeriod > array

1.4. MatchByRegionalResponse

Match Response

Name Description Schema

contractName
required

= {CONTRACT_NAME}

string

direction
required

= {DIRECTION_RESPONSE}

StringType

matchQuantity
required

Matching Quantity

integer(int64)

organization
required

Organization

StringType

pointName
required

Bid Point

string

1.5. MatchCurrentStatusRequestBody

Match Current Status Request Body

Name Description Schema

contractName
required

= {CONTRACT_NAME}

string

organizationEic
required

= {BID_ORGANIZATION_EIC}

string

1.6. MatchCurrentStatusResponse

Match Current Status Response

Name Description Schema

organizationEic
required

= {BID_ORGANIZATION_EIC}

string

organizationInfo
required

Organization

StringType

totalPurchaseMatchQuantity
required

Total Purchase Match Quantity

integer(int64)

totalSaleMatchQuantity
required

Total Sale Match Quantity

integer(int64)

1.7. MatchCurrentStatusResponseBody

Match Current Status Response Body

Name Description Schema

contractName
required

Matching ID

string

matchCurrentStatusResponses
optional

< MatchCurrentStatusResponse > array

1.8. MatchDetailListResponseBody

Matching Detail List Service Response

Name Description Schema

matchList
optional

< MatchDetailResponse > array

1.9. MatchDetailResponse

{MATCH_DETAIL_RESPONSE}

Name Description Schema

contractName
optional

= {CONTRACT_NAME}

string

createDate
required

Matching Create Date

string(date-time)

createUser
required

Matching Create Date

string

matchId
required

Matching ID

string

matchStatus
required

Matching Status

StringType

pointName
optional

Bid Point

string

price
required

Matching Price

number

purchaseBid
required

Matching Purchase Bid

BidResponse

purchaseBidVersion
required

Matching Purchase Bid Version

integer(int32)

purchaseMatchReason
required

Matching Reason

StringType

quantity
required

Matching Quantity

integer(int64)

saleBid
required

Matching Sale Bid

BidResponse

saleBidVersion
required

Matching Sale Bid Version

integer(int32)

saleMatchReason
required

Matching Reason

StringType

1.1. MatchListByBidRequest

{MATCH_LIST_FOR_BID_REQUEST}

Name Description Schema

bidId
required

string

1.1. MatchListByBidRequestBody

Match List By Bid Request

Name Description Schema

bidIds
required

< MatchListByBidRequest > array

1.2. MatchListByContractOrgRequestBody

Organization Match List Service Request

Name Description Schema

contractName
required

= {CONTRACT_NAME}

string

organizationId
required

Matching Bid Organization ID

integer(int64)

1.3. MatchListByContractRequestBody

Match List with Contracts Names Service Request

Name Description Schema

contractNames
required

= {CONTRACT_NAME}

< string > array

queryType
optional

Match Query Type

enum (ALL, SELF)

1.4. MatchListByPeriodRequestBody

List Match Service Request Body

Name Description Schema

gasDayDate
required

Gas Day Date

string(date-time)

periodName
optional

Request Period Name

string

1.5. MatchListByPeriodResponse

List Match Service Response

Name Description Schema

gasDayDate
optional

Gas Day Date

string(date-time)

periodResponses
optional

< MatchByPeriodResponse > array

1.6. MatchListByRegionalRequestBody

List Match Service Request Body

Name Description Schema

contractName
required

= {CONTRACT_NAME}

string

1.7. MatchListByRegionalResponse

List Match Service Response

Name Description Schema

regionalResponses
optional

< MatchByRegionalResponse > array

1.8. MatchListBySelfContractRequestBody

Match List with Contracts Names Service Request Body

Name Description Schema

contractName
required

= {CONTRACT_NAME}

string

1.9. MatchListRequestBody

{MATCH_LIST_REQUEST_BODY}

Name Description Schema

createDate
required

Matching Create Date

string(date-time)

1.1. MatchListResponse

Matching List Service Response

Name Description Schema

matchList
optional

< MatchResponse > array

1.2. MatchResponse

Matching Response

Name Description Schema

bid
required

= {MATCH_BID}

BidResponse

bidVersion
required

Match Bid Version

integer(int32)

createDate
required

Matching Create Date

string(date-time)

createUser
required

Matching Create Date

string

matchId
required

Matching ID

string

matchReason
required

Matching Reason

StringType

matchStatus
required

Matching Status

StringType

pointName
optional

Bid Point

string

price
required

Matching Price

number

quantity
required

Matching Quantity

integer(int64)

1.3. MatchWithBidListResponse

Matching Response

Name Description Schema

bids
required

= {MATCH_BID}

< BidResponse > array

createDate
required

Matching Create Date

string(date-time)

createUser
required

Matching Create Date

string

matchId
required

Matching ID

string

matchReason
required

Matching Reason

StringType

matchStatus
required

Matching Status

StringType

pointName
optional

Bid Point

string

price
required

Matching Price

number

quantity
required

Matching Quantity

integer(int64)

1.4. NetFinancialStatus

Financial Status

Name Description Schema

contract
required

= {CONTRACT_NAME}

string

datetime
required

Process Time

string(date-time)

direction
required

= {NET_FINANCIAL_STATUS_DIRECTION}

StringType

id
optional

string

netStatusAmount
required

Net Status Amount

number

processAmount
required

Process Amount

number

type
required

Financial Status Type

StringType

1.5. ObjectionCreateRequestBody

{OBJECTION_CREATE_REQUEST_BODY}

Name Description Schema

matchId
optional

Matching ID

string

objectionMessage
required

= {OBJECTION_MESSAGE}

string

objectionTypeName
required

= {OBJECTION_TYPE_NAME}

string

1.1. ObjectionCreateResponseBody

{OBJECTION_CREATE_RESPONSE_BODY}

Name Description Schema

objectionResponse
optional

= {OBJECTION_RESPONSE}

ObjectionResponse

1.1. ObjectionGetRequestBody

{OBJECTION_GET_REQUEST_BODY}

Name Description Schema

endDate
optional

= {OBJECTION_END_DATE}

string(date-time)

matchId
optional

Matching ID

string

objectionStatusNames
optional

= {OBJECTION_STATUS_NAME}

< string > array

startDate
optional

= {OBJECTION_START_DATE}

string(date-time)

1.1. ObjectionGetResponseBody

{OBJECTION_GET_RESPONSE_BODY}

Name Description Schema

objectionResponses
optional

= {OBJECTION_RESPONSE}

< ObjectionResponse > array

1.1. ObjectionReplyRequestBody

{OBJECTION_REPLY_REQUEST_BODY}

Name Description Schema

objectionId
required

= {OBJECTION_ID}

integer(int64)

objectionStatusName
required

= {OBJECTION_STATUS_NAME}

string

replyMessage
required

= {OBJECTION_REPLY_MESSAGE}

string

1.1. ObjectionReplyResponseBody

{OBJECTION_REPLY_RESPONSE_BODY}

Name Description Schema

objectionResponse
optional

= {OBJECTION_RESPONSE}

ObjectionResponse

1.1. ObjectionResponse

{OBJECTION_RESPONSE}

Name Description Schema

createUser
optional

= {OBJECTION_CREATE_USER}

string

createUserMail
optional

= {OBJECTION_CREATE_USER_MAIL}

string

createUserName
optional

= {OBJECTION_CREATE_USER_NAME}

string

createUserPhone
optional

= {OBJECTION_CREATE_USER_PHONE}

string

matchWithBidListResponse
optional

Matching Response

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_ORGANIZATION}

StringType

replyDate
optional

= {OBJECTION_REPLY_DATE}

string(date-time)

replyMessage
optional

= {OBJECTION_REPLY_MESSAGE}

string

replyUser
optional

= {OBJECTION_REPLY_USER}

string

1.1. ObjectionStatusListRequestBody

{OBJECTION_STATUS_LIST_SERVICE_REQUEST}

Type : object

1.1. ObjectionStatusListResponse

{OBJECTION_STATUS_LIST_SERVICE_RESPONSE}

Name Description Schema

objectionStatuses
optional

< StringType > array

1.1. ObjectionTypeListRequestBody

{OBJECTION_TYPE_LIST_SERVICE_REQUEST}

Type : object

1.1. ObjectionTypeListResponse

{OBJECTION_TYPE_LIST_SERVICE_RESPONSE}

Name Description Schema

objectionTypes
optional

< StringType > array

1.1. OrganizationMatchListResponse

Organization Match List Service Response

Name Description Schema

matchList
optional

< OrganizationMatchResponse > array

1.2. OrganizationMatchReport

Organization Match Report Service Response

Name Description Schema

direction
optional

= {DIRECTION_NAME}

StringType

organization
optional

Organization Name

LongType

quantity
optional

Matching Quantity

integer(int64)

1.3. OrganizationMatchReportRequestBody

Organization Match Report Service Request

Name Description Schema

contractNames
required

= {CONTRACT_NAMES}

< string > array

1.4. OrganizationMatchReportResponseBody

Organization Match Report Service Response

Name Description Schema

organizationMatchReports
optional

< OrganizationMatchReport > array

1.5. OrganizationMatchResponse

Organization Match Response

Name Description Schema

contractName
required

= {CONTRACT_NAME}

string

matchDate
required

Matching Create Date

string(date-time)

organizationId
required

Matching Bid Organization ID

integer(int64)

pointName
required

Bid Point

string

purchaseOrganization
required

Organization Name

string

quantity
required

Bid Quantity

integer(int64)

saleOrganization
required

Organization Name

string

1.6. RegionalContractResponseBody

{ACTIVE_CONTRACTS_REG_CONTRACT_RESPONSE}

Name Description Schema

contracts
optional

< RegionalContractSummary > array

1.1. RegionalContractSummary

Regional Contracts

Name Description Schema

bestAmountPriceBuying
required

Best Buying

AmountPrice

bestAmountPriceSelling
required

Best Selling

AmountPrice

closingTime
required

Contract Closing Time

string(date-time)

deliveryDays
required

Gas Delivery Days

< string(date-time) > array

direction
required

Contract 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 Amount

integer(int64)

status
required

Contract State

StringType

totalAmount
required

Total Amount

integer(int64)

type
required

Type

StringType

1.2. StringType

String Type

Name Description Schema

text
required

Description

string

value
required

Value

string

1.3. activeContractMatchingRequest

Active Contract Matching List Request

Name Description Schema

body
optional

ActiveContractMatchingRequestBody

headers
optional

= {HEADER}

< Header > array

1.4. activeContractMatchingResponse

Active Contract Matching Response

Name Description Schema

body
optional

ActiveContractMatchingResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. bidByContractServiceRequest

Service Request

Name Description Schema

body
optional

BidByContractServiceRequestBody

headers
optional

= {HEADER}

< Header > array

1.6. bidGetByIdServiceRequest

Bid Get Service By ID Request

Name Description Schema

body
optional

BidGetByIdServiceRequestBody

headers
optional

= {HEADER}

< Header > array

1.7. bidGetByIdServiceResponse

Bid Get Service By ID Response

Name Description Schema

body
optional

BidGetByIdServiceResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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.8. bidGetServiceRequest

Bid Get Service Request

Name Description Schema

body
optional

BidGetServiceRequestBody

headers
optional

= {HEADER}

< Header > array

1.9. bidGetServiceResponse

Bid Get Service Response

Name Description Schema

body
optional

BidGetServiceResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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.10. bidHistoryListByMatchServiceRequest

Get Match Bids History List Service Request

Name Description Schema

body
optional

BidHistoryListByMatchRequestBody

headers
optional

= {HEADER}

< Header > array

1.11. bidHistoryListByMatchServiceResponse

Get Match Bids History List Service Response

Name Description Schema

body
optional

BidHistoryListByMatchResponse

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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.12. bidHistoryListServiceRequest

Bid History List Service Request

Name Description Schema

body
optional

BidHistoryListRequestBody

headers
optional

= {HEADER}

< Header > array

1.13. bidHistoryListServiceResponse

Bid History List Service Response

Name Description Schema

body
optional

BidHistoryListResponse

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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.14. bidMatchStatusListServiceRequest

Bid Match Status List Service Request

Name Description Schema

body
optional

BidMatchStatusListRequestBody

headers
optional

= {HEADER}

< Header > array

1.15. bidMatchStatusListServiceResponse

Bid Match Status List Service Response

Name Description Schema

body
optional

BidMatchStatusListResponse

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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.16. bidStatusListServiceRequest

{BID_STATUS_LIST_SERVICE_REQUEST}

Name Description Schema

body
optional

BidStatusListRequestBody

headers
optional

= {HEADER}

< Header > array

1.1. bidStatusListServiceResponse

{BID_STATUS_LIST_SERVICE_RESPONSE}

Name Description Schema

body
optional

BidStatusListResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. bidTypeListServiceRequest

{BID_TYPE_LIST_SERVICE_REQUEST}

Name Description Schema

body
optional

BidTypeListRequestBody

headers
optional

= {HEADER}

< Header > array

1.1. bidTypeListServiceResponse

{BID_TYPE_LIST_SERVICE_RESPONSE}

Name Description Schema

body
optional

BidTypeListResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. bidUpdateReasonListServiceRequest

Bid Update Reason List Service Request

Name Description Schema

body
optional

BidUpdateReasonListRequestBody

headers
optional

= {HEADER}

< Header > array

1.2. bidUpdateReasonListServiceResponse

Bid Update Reason List Service Response

Name Description Schema

body
optional

BidUpdateReasonListResponse

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. contractConfigurationGetServiceRequest

Contract Configuration Get Service Request

Name Description Schema

body
optional

ContractConfigurationGetRequestBody

headers
optional

= {HEADER}

< Header > array

1.4. contractConfigurationGetServiceResponse

Contract Configuration Get Service Response

Name Description Schema

body
optional

ContractConfigurationGetResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. contractGateListActiveServiceRequest

Contract Gate List Active Service Request

Name Description Schema

body
optional

ContractGateListActiveRequestBody

headers
optional

= {HEADER}

< Header > array

1.6. contractGateListServiceRequest

CONTRACT_GATE_LIST_SERVICE_REQUEST

Name Description Schema

body
optional

ContractGateListRequestBody

headers
optional

= {HEADER}

< Header > array

1.7. contractGateListServiceResponse

CONTRACT_GATE_LIST_SERVICE_RESPONSE

Name Description Schema

body
optional

ContractGateListResponse

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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.8. contractGateStatusListServiceRequest

Contract Gate State List Service Request

Name Description Schema

body
optional

ContractGateStatusListRequestBody

headers
optional

= {HEADER}

< Header > array

1.9. contractGateStatusListServiceResponse

Contract Gate State List Service Response

Name Description Schema

body
optional

ContractGateStatusListResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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.10. contractGetServiceRequest

Contract Get Service Request

Name Description Schema

body
optional

ContractGetRequestBody

headers
optional

= {HEADER}

< Header > array

1.11. contractGetServiceResponse

{CONTRACT_GET_SERVICE_RESPONSE}

Name Description Schema

body
optional

ContractGetResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. contractListServiceRequest

{CONTRACT_LIST_SERVICE_REQUEST}

Name Description Schema

body
optional

ContractListRequestBody

headers
optional

= {HEADER}

< Header > array

1.1. contractListServiceResponse

{CONTRACT_LIST_SERVICE_RESPONSE}

Name Description Schema

body
optional

ContractListResponse

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. contractStatusListServiceRequest

{CONTRACT_STATUS_LIST_SERVICE_REQUEST}

Name Description Schema

body
optional

ContractStatusListRequestBody

headers
optional

= {HEADER}

< Header > array

1.1. contractStatusListServiceResponse

{CONTRACT_STATUS_LIST_SERVICE_RESPONSE}

Name Description Schema

body
optional

ContractStatusListResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. contractSummaryResponse

Current Active Contract List Service Response

Name Description Schema

body
optional

ContractSummaryResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. contractTypeListServiceRequest

{CONTRACT_TYPE_LIST_SERVICE_REQUEST}

Name Description Schema

body
optional

ContractTypeListRequestBody

headers
optional

= {HEADER}

< Header > array

1.1. contractTypeListServiceResponse

{CONTRACT_TYPE_LIST_SERVICE_RESPONSE}

Name Description Schema

body
optional

ContractTypeListResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. currentStatusServiceRequest

Current Net Financial Status Request

Name Description Schema

body
optional

CurrentStatusServiceRequestBody

headers
optional

= {HEADER}

< Header > array

1.3. currentStatusServiceResponse

Current Net Financial Status Response

Name Description Schema

body
optional

CurrentStatusServiceResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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.4. dailyFinancialStatusProcessLimitServiceRequest

Daily Financial Status Process Limit List Service Request

Name Description Schema

body
optional

DailyFinancialStatusProcessLimitRequestBody

headers
optional

= {HEADER}

< Header > array

1.5. dailyFinancialStatusProcessLimitServiceResponse

Daily Financial Status Process Limit List Service Response

Name Description Schema

body
optional

DailyFinancialStatusProcessLimitResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. directionListServiceRequest

{DIRECTION_LIST_SERVICE_REQUEST}

Name Description Schema

body
optional

DirectionListRequestBody

headers
optional

= {HEADER}

< Header > array

1.1. directionListServiceResponse

{DIRECTION_LIST_SERVICE_RESPONSE}

Name Description Schema

body
optional

DirectionListResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. gasDayGetServiceRequest

{GAS_DAY_GET_SERVICE_REQUEST}

Name Description Schema

body
optional

GasDayGetRequestBody

headers
optional

= {HEADER}

< Header > array

1.1. gasDayGetServiceResponse

{GAS_DAY_SERVICE_RESPONSE}

Name Description Schema

body
optional

GasDayGetResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. gasDayListServiceRequest

{GAS_DAY_LIST_SERVICE_REQUEST}

Name Description Schema

body
optional

GasDayListRequestBody

headers
optional

= {HEADER}

< Header > array

1.1. gasDayListServiceResponse

{GAS_DAY_LIST_SERVICE_RESPONSE}

Name Description Schema

body
optional

GasDayListResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. gasDaySaveServiceRequest

{GAS_DAY_SAVE_SERVICE_REQUEST}

Name Description Schema

body
optional

GasDaySaveRequestBody

headers
optional

= {HEADER}

< Header > array

1.1. gasDaySaveServiceResponse

Gas Day Save Service Response

Name Description Schema

body
optional

GasDaySaveResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. marketPriceGetListResponse

{MARKET_PRICE_GET_RESPONSE_BODY_DESCRIPTION}

Name Description Schema

gasDay
required

= {MARKET_PRICE_GASDAY_NAME}
Example : "2017-02-07T09:31:33.000+03:00"

string(date-time)

marketPriceResponseList
optional

< MarketPriceResponse > array

1.1. marketPriceGetRequest

{MARKET_PRICE_GET_REQUEST_DESCRIPTION}

Name Description Schema

body
optional

MarketPriceGetRequestBody

headers
optional

= {HEADER}

< Header > array

1.1. marketPriceGetResponseBody

{MARKET_PRICE_GET_RESPONSE_DESCRIPTION}

Name Description Schema

marketPriceGetListResponseList
optional

< marketPriceGetListResponse > array

1.1. marketPriceGetServiceResponse

{MARKET_PRICE_SERVICE_RESPONSE_DESCRIPTION}

Name Description Schema

body
optional

marketPriceGetResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. matchCurrentStatusServiceRequest

Match Current Status Service Request

Name Description Schema

body
optional

MatchCurrentStatusRequestBody

headers
optional

= {HEADER}

< Header > array

1.2. matchCurrentStatusServiceResponse

Match Current Status Service Response

Name Description Schema

body
optional

MatchCurrentStatusResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. matchDetailListServiceResponse

Matching Detail List Service Response

Name Description Schema

body
optional

MatchDetailListResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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.4. matchListByBidServiceRequest

Match List By Bid Service Request

Name Description Schema

body
optional

MatchListByBidRequestBody

headers
optional

= {HEADER}

< Header > array

1.5. matchListByContractOrgServiceRequest

Organization Match List Service Request

Name Description Schema

body
optional

MatchListByContractOrgRequestBody

headers
optional

= {HEADER}

< Header > array

1.6. matchListByContractServiceRequest

Match List with Contracts Names Service Response

Name Description Schema

body
optional

MatchListByContractRequestBody

headers
optional

= {HEADER}

< Header > array

1.7. matchListByPeriodServiceRequest

List Match Service Request

Name Description Schema

body
optional

MatchListByPeriodRequestBody

headers
optional

= {HEADER}

< Header > array

1.8. matchListByPeriodServiceResponse

List Match Service Response

Name Description Schema

body
optional

MatchListByPeriodResponse

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. matchListByRegionalServiceRequest

List Match Service Request

Name Description Schema

body
optional

MatchListByRegionalRequestBody

headers
optional

= {HEADER}

< Header > array

1.10. matchListByRegionalServiceResponse

List Match Service Response

Name Description Schema

body
optional

MatchListByRegionalResponse

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. matchListBySelfContractServiceRequest

Match List with Contracts Names Service Request

Name Description Schema

body
optional

MatchListBySelfContractRequestBody

headers
optional

= {HEADER}

< Header > array

1.12. matchListServiceRequest

Matching List Service Request

Name Description Schema

body
optional

MatchListRequestBody

headers
optional

= {HEADER}

< Header > array

1.13. matchListServiceResponse

Matching List Service Response

Name Description Schema

body
optional

MatchListResponse

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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.14. objectionCreateServiceRequest

{OBJECTION_CREATE_SERVICE_REQUEST}

Name Description Schema

body
optional

ObjectionCreateRequestBody

headers
optional

= {HEADER}

< Header > array

1.1. objectionCreateServiceResponse

{OBJECTION_CREATE_SERVICE_RESPONSE}

Name Description Schema

body
optional

ObjectionCreateResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. objectionGetServiceRequest

{OBJECTION_GET_SERVICE_REQUEST}

Name Description Schema

body
optional

ObjectionGetRequestBody

headers
optional

= {HEADER}

< Header > array

1.1. objectionGetServiceResponse

{OBJECTION_GET_SERVICE_RESPONSE}

Name Description Schema

body
optional

ObjectionGetResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. objectionReplyServiceRequest

{OBJECTION_REPLY_SERVICE_REQUEST}

Name Description Schema

body
optional

ObjectionReplyRequestBody

headers
optional

= {HEADER}

< Header > array

1.1. objectionReplyServiceResponse

{OBJECTION_REPLY_SERVICE_RESPONSE}

Name Description Schema

body
optional

ObjectionReplyResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. objectionStatusListServiceRequest

{OBJECTION_STATUS_LIST_SERVICE_REQUEST}

Name Description Schema

body
optional

ObjectionStatusListRequestBody

headers
optional

= {HEADER}

< Header > array

1.1. objectionStatusListServiceResponse

{OBJECTION_STATUS_LIST_SERVICE_RESPONSE}

Name Description Schema

body
optional

ObjectionStatusListResponse

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. objectionTypeListServiceRequest

{OBJECTION_TYPE_LIST_SERVICE_REQUEST}

Name Description Schema

body
optional

ObjectionTypeListRequestBody

headers
optional

= {HEADER}

< Header > array

1.1. objectionTypeListServiceResponse

{OBJECTION_TYPE_LIST_SERVICE_RESPONSE}

Name Description Schema

body
optional

ObjectionTypeListResponse

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. organizationMatchListServiceResponse

Organization Match List Service Response

Name Description Schema

body
optional

OrganizationMatchListResponse

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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. organizationMatchReportServiceRequest

Organization Match Report Service Request

Name Description Schema

body
optional

OrganizationMatchReportRequestBody

headers
optional

= {HEADER}

< Header > array

1.3. organizationMatchReportServiceResponse

Organization Match Report Service Response

Name Description Schema

body
optional

OrganizationMatchReportResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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.4. regionalContractResponse

{ACTIVE_CONTRACTS_REG_CONTRACT_RESPONSE}

Name Description Schema

body
optional

RegionalContractResponseBody

resultCode
required

= {RESULT_CODE}
Example : "0"

string

resultDescription
required

= {RESULT_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"
            }
        ]
    }
}