Overview
Version information
Version : v1
URI scheme
Host : ${deployenv}.epias.com.tr
BasePath : /stp-trade-report-orchestrator/rest
Schemes : HTTPS
Tags
-
active-contracts-match
-
bid
-
bid-history
-
bid-match-status
-
bid-status
-
bid-type
-
bid-update-reason
-
contract
-
contract-configuration
-
contract-gate
-
contract-status
-
contract-type
-
daily-financial-status
-
direction
-
exist
-
gas-day
-
gate-status
-
market-price
-
match
-
objection
-
objection-status
-
objection-type
-
reason-code
About This Document
This document contains application definitions and describes how these services will be invoked.
Since the document is updated in each version, the services in the test and real environment may differ. Follow the release notes.
Changes
1.0.0 Service Definitions
About Application
This application is running on REST services. It consumes JSON and XML requests and produces JSON and XML requests.
You need a authorized user at DGPYS to use these services. Every request needs to be authorize by Central Authentication Server (cas.epias.com.tr).
Generating Clients
Service documentation based on Swagger. You can use following files https://testtys.epias.com.tr/stp-organization-services-rest/test/swagger.json for test environment, https://tys.epias.com.tr/stp-organization-services-rest/test/swagger.json for production environment to generate client. There is a code generator located on https://generator.swagger.io which helps you to build client in any language.
Help and Support
You can send your opinions or support request through Support Platform https://yardim.epias.com.tr.
Application Call Procedure
TGT (Ticket Granting Ticket) controls users session. TGT is active at 45 even if you don’t use it. Each time you use the TGT value, the 45-minute period starts again.
You can not use TGT as token to call rest services. For each call you need to create a token (Called ST - Service Token) using TGT. You should reuse TGT.You don’t need to create TGT for each request. If you do that you may blocked by Central Authentication Server.
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 |
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.
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 |
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.
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 |
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);
}
}
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"]
}
}
{
"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. |
{"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.
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 .
Unresolved directive in helperDataService.adoc - include::examples/json/helper-data-get-request.xml[]
Unresolved directive in helperDataService.adoc - include::examples/json/helper-data-get-response.xml[]
{
"headers": [
{
"key": "application",
"value": "528969ea-d7f6-440a-b020-e78a8d531a32"
},
{
"key": "transactionId",
"value": "d883f25c-413d-41e8-b695-9731186950dd"
}
],
"body": {
"parameter": "city",
"marketType": "NATURAL_GAS"
}
}
{
"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 .
Unresolved directive in parameterService.adoc - include::examples/json/parameter-get-request.xml[]
Unresolved directive in parameterService.adoc - include::examples/json/parameter-get-response.xml[]
{
"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"
}
}
{
"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 .
Unresolved directive in helperParametersService.adoc - include::examples/json/helper-parameters-get-request.xml[]
Unresolved directive in helperParametersService.adoc - include::examples/json/helper-parameters-get-response.xml[]
{
"headers": [
{
"key": "application",
"value": "528969ea-d7f6-440a-b020-e78a8d531a32"
},
{
"key": "transactionId",
"value": "d883f25c-413d-41e8-b695-9731186950dd"
}
],
"body": {
}
}
{
"resultCode": "0",
"resultDescription": "OK",
"resultType": "SUCCESS",
"body": {
"referenceListResponse": [
{
"key": "city",
"description": "Şehir Bilgisi",
"addition": null
},
{
"key": "district",
"description": "İlçe Bilgisi",
"addition": null
}
]
}
}
4. Paths
4.1. Service of Active Contract Match
POST /activecontracts/matchings
4.1.1. Description
Active Contract Match Return
4.1.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
stp-service-ticket |
STP Servis ST Header |
string |
|
Body |
body |
4.1.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
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. Bid Cancel
POST /bid-history/cancel
4.2.1. Description
Bid Cancel
4.2.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
stp-service-ticket |
STP Servis ST Header |
string |
|
Body |
body |
4.2.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
4.2.4. Consumes
-
application/json
-
application/xml
4.2.5. Produces
-
application/json
-
application/xml
4.2.6. Tags
-
bid-history
4.3. Order History List
POST /bid-history/list
4.3.1. Description
Order History List
4.3.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
4.3.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
4.3.4. Consumes
-
application/json
-
application/xml
4.3.5. Produces
-
application/json
-
application/xml
4.3.6. Tags
-
bid-history
4.4. Matched Orders History List
POST /bid-history/listbymatch
4.4.1. Description
Matched Orders History List
4.4.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
4.4.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
4.4.4. Consumes
-
application/json
-
application/xml
4.4.5. Produces
-
application/json
-
application/xml
4.4.6. Tags
-
bid-history
4.5. Service of Order Match Status Listing
POST /bid-match-status/list
4.5.1. Description
Service of Order Match Status Listing
4.5.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
4.5.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
4.5.4. Consumes
-
application/json
-
application/xml
4.5.5. Produces
-
application/json
-
application/xml
4.5.6. Tags
-
bid-match-status
4.6. Order Status Name List
POST /bid-status/list
4.6.1. Description
Order Status Listing
4.6.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
4.6.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
4.6.4. Consumes
-
application/json
-
application/xml
4.6.5. Produces
-
application/json
-
application/xml
4.6.6. Tags
-
bid-status
4.7. #{BID_TYPE_LIST_NAME}
POST /bid-type/list
4.7.1. Description
Order Type Name List
4.7.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
4.7.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
4.7.4. Consumes
-
application/json
-
application/xml
4.7.5. Produces
-
application/json
-
application/xml
4.7.6. Tags
-
bid-type
4.8. Service of Order Update Reason Listing
POST /bid-update-reason/list
4.8.1. Description
Service of Order Update Reason Listing
4.8.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
4.8.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
4.8.4. Consumes
-
application/json
-
application/xml
4.8.5. Produces
-
application/json
-
application/xml
4.8.6. Tags
-
bid-update-reason
4.9. Service of Order
POST /bid/get
4.9.1. Description
Service of Order Match
4.9.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
stp-service-ticket |
STP Servis ST Header |
string |
|
Body |
body |
4.9.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
4.9.4. Consumes
-
application/json
-
application/xml
4.9.5. Produces
-
application/json
-
application/xml
4.9.6. Tags
-
bid
4.10. Service of Order Listing by Order Id
POST /bid/getbyid
4.10.1. Description
Service of Order Listing by Order Id
4.10.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
stp-service-ticket |
STP Servis ST Header |
string |
|
Body |
body |
4.10.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
4.10.4. Consumes
-
application/json
-
application/xml
4.10.5. Produces
-
application/json
-
application/xml
4.10.6. Tags
-
bid
4.11. Service of Order Listing by Contract
POST /bid/listbycontract
4.11.1. Description
Lists contracts by contract name and status.
4.11.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
stp-service-ticket |
STP Servis ST Header |
string |
|
Body |
body |
4.11.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
4.11.4. Consumes
-
application/json
-
application/xml
4.11.5. Produces
-
application/json
-
application/xml
4.11.6. Tags
-
bid
4.12. #{CONTRACT_CONF_DECLARE_EXTRAORDINARY_DAY}
POST /contract-configuration/declareExtraordinaryDay
4.12.1. Description
{CONTRACT_CONF_DECLARE_EXTRAORDINARY_DAY_DESCRIPTION}
1.1. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
ContractConfigurationDeclareExtraOrdinaryDayOrcServiceRequest |
1.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.3. Consumes
-
application/json
-
application/xml
1.4. Produces
-
application/json
-
application/xml
1.5. Tags
-
contract-configuration
1.6. Contract Configuration Query
POST /contract-configuration/get
1.6.1. Description
{CONTRACT_CONFIGURATION_GET_DESCRIPTION}
1.6.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.6.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.6.4. Consumes
-
application/json
-
application/xml
1.6.5. Produces
-
application/json
-
application/xml
1.6.6. Tags
-
contract-configuration
1.7. Contrat Configuration Query
POST /contract-configuration/list-by-extraOrdinary
1.7.1. Description
Contrat Configuration Query
1.7.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.7.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.7.4. Consumes
-
application/json
-
application/xml
1.7.5. Produces
-
application/json
-
application/xml
1.7.6. Tags
-
contract-configuration
1.8. CONTRACT_GATE_LIST_NAME
POST /contract-gate/list
1.8.1. Description
CONTRACT_GATE_LIST_DESCRIPTION
1.8.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.8.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.8.4. Consumes
-
application/json
-
application/xml
1.8.5. Produces
-
application/json
-
application/xml
1.8.6. Tags
-
contract-gate
1.9. Service of Active Gates Listing
POST /contract-gate/list-active
1.9.1. Description
Service of Active Gates Listing (by contract name)
1.9.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.9.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.9.4. Consumes
-
application/json
-
application/xml
1.9.5. Produces
-
application/json
-
application/xml
1.9.6. Tags
-
contract-gate
1.10. Contract Status Name Listing
POST /contract-status/list
1.10.1. Description
Contract Status Name List
1.10.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.10.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.10.4. Consumes
-
application/json
-
application/xml
1.10.5. Produces
-
application/json
-
application/xml
1.10.6. Tags
-
contract-status
1.11. Service of Contract Type Listing
POST /contract-type/list
1.11.1. Description
Service of Contract Type Listing
1.11.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.11.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.11.4. Consumes
-
application/json
-
application/xml
1.11.5. Produces
-
application/json
-
application/xml
1.11.6. Tags
-
contract-type
1.12. Service of Contract Listing
POST /contract/get
1.12.1. Description
Service of Contract Listing
1.12.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
stp-service-ticket |
STP Servis ST Header |
string |
|
Body |
body |
1.12.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.12.4. Consumes
-
application/json
-
application/xml
1.12.5. Produces
-
application/json
-
application/xml
1.12.6. Tags
-
contract
1.13. Service of Contract Listing
POST /contract/list
1.13.1. Description
Service of Contract Listing (by given parameters)
1.13.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
stp-service-ticket |
STP Servis ST Header |
string |
|
Body |
body |
1.13.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.13.4. Consumes
-
application/json
-
application/xml
1.13.5. Produces
-
application/json
-
application/xml
1.13.6. Tags
-
contract
1.14. Service of Contract Listing
POST /contract/list-by-date
1.14.1. Description
Service of Contract Listing (by given parameters)
1.14.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
stp-service-ticket |
STP Servis ST Header |
string |
|
Body |
body |
1.14.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.14.4. Consumes
-
application/json
-
application/xml
1.14.5. Produces
-
application/json
-
application/xml
1.14.6. Tags
-
contract
1.15. Match Report Of Participants Traded In Contract
POST /contract/organization-report
1.15.1. Description
Match Report Of Participants Traded In Contract
1.15.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
stp-service-ticket |
STP Servis ST Header |
string |
|
Body |
body |
1.15.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.15.4. Consumes
-
application/json
-
application/xml
1.15.5. Produces
-
application/json
-
application/xml
1.15.6. Tags
-
contract
1.16. Service of Active N/B Contract Listing
POST /contract/regional
1.16.1. Description
Lists N/B contracts which can be ordered currently or soon.
1.16.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
stp-service-ticket |
STP Servis ST Header |
string |
|
Body |
body |
1.16.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.16.4. Consumes
-
application/json
-
application/xml
1.16.5. Produces
-
application/json
-
application/xml
1.16.6. Tags
-
contract
1.17. Service of Active Contract Listing
POST /contract/standart
1.17.1. Description
Lists daily contracts which can be ordered currently or soon.
1.17.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
stp-service-ticket |
STP Servis ST Header |
string |
|
Body |
body |
1.17.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.17.4. Consumes
-
application/json
-
application/xml
1.17.5. Produces
-
application/json
-
application/xml
1.17.6. Tags
-
contract
1.18. Service of Final Net Position Listing
POST /daily-financial-status/current-status
1.18.1. Description
Lists current net financial position of organization.
1.18.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.18.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.18.4. Consumes
-
application/json
-
application/xml
1.18.5. Produces
-
application/json
-
application/xml
1.18.6. Tags
-
daily-financial-status
1.19. Service of Daily Financial Position Transaction Limit Listing
POST /daily-financial-status/process-limit
1.19.1. Description
Service of Daily Financial Position Transaction Limit Listing
1.19.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.19.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.19.4. Consumes
-
application/json
-
application/xml
1.19.5. Produces
-
application/json
-
application/xml
1.19.6. Tags
-
daily-financial-status
1.20. Direction Name List
POST /direction/list
1.20.1. Description
Order Direction Name List
1.20.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.20.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.20.4. Consumes
-
application/json
-
application/xml
1.20.5. Produces
-
application/json
-
application/xml
1.20.6. Tags
-
direction
1.21. All Gas Days
POST /gas-day/all
1.21.1. Description
Service of All Gas Days Listing
1.21.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.21.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.21.4. Consumes
-
application/json
-
application/xml
1.21.5. Produces
-
application/json
-
application/xml
1.21.6. Tags
-
gas-day
1.22. Gas Day Display
POST /gas-day/get
1.22.1. Description
Gas Day Display
1.22.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.22.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.22.4. Consumes
-
application/json
-
application/xml
1.22.5. Produces
-
application/json
-
application/xml
1.22.6. Tags
-
gas-day
1.23. Gas Day List
POST /gas-day/list
1.23.1. Description
Gas Day List
1.23.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.23.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.23.4. Consumes
-
application/json
-
application/xml
1.23.5. Produces
-
application/json
-
application/xml
1.23.6. Tags
-
gas-day
1.24. Gas Day Save
POST /gas-day/save
1.24.1. Description
Gas Day Save
1.24.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.24.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.24.4. Consumes
-
application/json
-
application/xml
1.24.5. Produces
-
application/json
-
application/xml
1.24.6. Tags
-
gas-day
1.25. Service of Contract Gate Status Listing
POST /gate-status/list
1.25.1. Description
Service of All Contract Status Listing
1.25.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.25.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.25.4. Consumes
-
application/json
-
application/xml
1.25.5. Produces
-
application/json
-
application/xml
1.25.6. Tags
-
gate-status
1.26. Market Price
POST /market-price/get
1.26.1. Description
Market Price Notes
1.26.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.26.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.26.4. Consumes
-
application/json
-
application/xml
1.26.5. Produces
-
application/json
-
application/xml
1.26.6. Tags
-
market-price
1.27. Contract Active Net Match (by organization)
POST /match/current-status
1.27.1. Description
Contract Active Net Match (by organization)
1.27.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.27.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.27.4. Consumes
-
application/json
-
application/xml
1.27.5. Produces
-
application/json
-
application/xml
1.27.6. Tags
-
match
1.28. Match List
POST /match/list
1.28.1. Description
Match Listing Description
1.28.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.28.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.28.4. Consumes
-
application/json
-
application/xml
1.28.5. Produces
-
application/json
-
application/xml
1.28.6. Tags
-
match
1.29. Match Detail List
POST /match/list-detail
1.29.1. Description
Match Detail Listing
1.29.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.29.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.29.4. Consumes
-
application/json
-
application/xml
1.29.5. Produces
-
application/json
-
application/xml
1.29.6. Tags
-
exist
-
match
1.30. Match Listing By Order
POST /match/listbybid
1.30.1. Description
Service of Match Listing By Order
1.30.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.30.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.30.4. Consumes
-
application/json
-
application/xml
1.30.5. Produces
-
application/json
-
application/xml
1.30.6. Tags
-
match
1.31. Matched Order Listing by Contract
POST /match/listbycontract
1.31.1. Description
Service which lists the matching orders by contract.
1.31.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.31.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.31.4. Consumes
-
application/json
-
application/xml
1.31.5. Produces
-
application/json
-
application/xml
1.31.6. Tags
-
match
1.32. Organization Match List
POST /match/listbycontractorg
1.32.1. Description
Organization Matches Listing by Contract
1.32.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.32.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.32.4. Consumes
-
application/json
-
application/xml
1.32.5. Produces
-
application/json
-
application/xml
1.32.6. Tags
-
match
1.33. BOTAS Match Net Position Query (by daily contract)
POST /match/listbyperiod
1.33.1. Description
BOTAS Match Net Position Query (by daily contract)
1.33.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.33.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.33.4. Consumes
-
application/json
-
application/xml
1.33.5. Produces
-
application/json
-
application/xml
1.33.6. Tags
-
match
1.34. BOTAS Match Net Position Query (by regional contract)
POST /match/listbyregional
1.34.1. Description
BOTAS Match Net Position Query (by regional contract)
1.34.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.34.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.34.4. Consumes
-
application/json
-
application/xml
1.34.5. Produces
-
application/json
-
application/xml
1.34.6. Tags
-
match
1.35. Match List
POST /match/listbyselfcontract
1.35.1. Description
Match Listing Description
1.35.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.35.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.35.4. Consumes
-
application/json
-
application/xml
1.35.5. Produces
-
application/json
-
application/xml
1.35.6. Tags
-
match
1.36. Objection Status List
POST /objection-status/list
1.36.1. Description
Lists objection status.
1.36.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.36.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.36.4. Consumes
-
application/json
-
application/xml
1.36.5. Produces
-
application/json
-
application/xml
1.36.6. Tags
-
objection-status
1.37. Objection Type List
POST /objection-type/list
1.37.1. Description
Objection Type Listing
1.37.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.37.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.37.4. Consumes
-
application/json
-
application/xml
1.37.5. Produces
-
application/json
-
application/xml
1.37.6. Tags
-
objection-type
1.38. Objection Create
POST /objection/create
1.38.1. Description
Objection Create
1.38.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.38.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.38.4. Consumes
-
application/json
-
application/xml
1.38.5. Produces
-
application/json
-
application/xml
1.38.6. Tags
-
objection
1.39. Objection Info
POST /objection/get
1.39.1. Description
Objection Info Display
1.39.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.39.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.39.4. Consumes
-
application/json
-
application/xml
1.39.5. Produces
-
application/json
-
application/xml
1.39.6. Tags
-
objection
1.40. Objection Answering
POST /objection/reply
1.40.1. Description
Objection Answering
1.40.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.40.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.40.4. Consumes
-
application/json
-
application/xml
1.40.5. Produces
-
application/json
-
application/xml
1.40.6. Tags
-
objection
1.41. #{REASON_CODE_LIST_NAME}
POST /reason-code/list
1.41.1. Description
{REASON_CODE_LIST_DESCRIPTION}
1.1. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Body |
body |
1.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful operation |
1.3. Consumes
-
application/json
-
application/xml
1.4. Produces
-
application/json
-
application/xml
1.5. Tags
-
reason-code
5. Definitions
5.1. ActiveContractMatchingRequestBody
Request Content of Active Contract Match
Name | Description | Schema |
---|---|---|
contractNames |
Contract Names |
< string > array |
5.2. ActiveContractMatchingResponseBody
Response Content of Active Contract Match
Name | Description | Schema |
---|---|---|
matchings |
< Match > array |
5.3. AmountPrice
Quantity/Price Pair
Name | Description | Schema |
---|---|---|
amount |
Quantity |
integer(int64) |
price |
Price |
number |
5.4. BidByContractServiceRequestBody
Request of Order Listing by Contract Name and Status
Name | Description | Schema |
---|---|---|
bidId |
Order Id |
string |
bidStatusNames |
BID_STATUS_NAME |
< string > array |
contractNames |
Contract Status |
< string > array |
5.5. BidCancelServiceRequestBody
{BID_CANCEL_SERVICE_REQUEST}
Name | Description | Schema |
---|---|---|
bidId |
Order Id |
string |
1.1. BidCancelServiceResponseBody
{BID_CANCEL_SERVICE_RESPONSE}
Name | Description | Schema |
---|---|---|
bid |
1.1. BidGetByIdServiceRequestBody
Request of Order Listing by Order Id Service
Name | Description | Schema |
---|---|---|
bidId |
Order Id |
string |
1.2. BidGetByIdServiceResponseBody
Response of Order Listing by Order Id Service
Name | Description | Schema |
---|---|---|
bid |
1.3. BidGetServiceRequestBody
Request of Order Service
Name | Description | Schema |
---|---|---|
bidEndDate |
Order Finish Date |
string(date-time) |
bidStartDate |
Order Start Date |
string(date-time) |
intervalLimit |
= {LIMIT_INTERVAL} |
boolean |
marketDayType |
Market Day Type |
enum (GASDAY, GASWEEK, ALL) |
1.4. BidGetServiceResponseBody
Response of Order Service
Name | Description | Schema |
---|---|---|
bidResponses |
< BidResponse > array |
1.5. BidHistoryListByMatchRequestBody
Request of Matched Orders History Service
Name | Description | Schema |
---|---|---|
matchId |
Match Id |
string |
1.6. BidHistoryListByMatchResponse
Response of Matched Orders History Service
Name | Description | Schema |
---|---|---|
purchaseBidHistoryList |
< BidHistoryResponse > array |
|
saleBidHistoryList |
< BidHistoryResponse > array |
1.7. BidHistoryListRequestBody
Request of Order History Listing Service
Name | Description | Schema |
---|---|---|
bidIds |
Order Id |
< string > array |
1.8. BidHistoryListResponse
Response of Order History Listing Service
Name | Description | Schema |
---|---|---|
bidHistoryList |
< BidHistoryResponse > array |
|
partialMatchAverage |
number |
1.9. BidHistoryResponse
Response of Order History
Name | Description | Schema |
---|---|---|
bidDate |
Order Date |
string(date-time) |
bidExpiredDate |
string(date-time) |
|
bidHistoryId |
Order History id |
integer(int64) |
bidPointName |
Order Point |
string |
bidPrice |
Order Price |
number |
bidQuantity |
Order Quantity |
integer(int64) |
bidState |
Order Status |
|
bidType |
Order Type |
|
contractName |
Order Contract |
string |
direction |
OPERATION |
|
id |
Order Id |
string |
matchId |
Match Id |
string |
matchPrice |
Match Price |
number |
matchQuantity |
Match Quantity |
integer(int64) |
matchState |
Order Match Status |
|
matchStatus |
Order Match Status |
|
matchVersion |
integer(int32) |
|
modifyDate |
Order Date |
string(date-time) |
organizationName |
Organization Title |
string |
organizationShortName |
Organization Short Title |
string |
purchaseOrgName |
Organization Title |
string |
queueTime |
Order Date |
string(date-time) |
remainingQuantity |
Order Remaining Quantity |
integer(int64) |
saleOrgName |
Organization Title |
string |
status |
Order Status |
|
updateReason |
Order Update Reason |
|
user |
Order User |
string |
1.10. BidMatchStatusListRequestBody
Request of Order Match Status Listing Service
Type : object
1.11. BidMatchStatusListResponse
Response of Order Match Status Listing Service
Name | Description | Schema |
---|---|---|
bidMatchStatusList |
< BidMatchStatusResponse > array |
1.12. BidMatchStatusResponse
Response of Order Match Status Listing Service
Name | Description | Schema |
---|---|---|
localization |
Order Match Status Language Options |
|
name |
Order Match Status Name |
string |
1.13. BidResponse
Response of Order Service
Name | Description | Schema |
---|---|---|
bidDate |
Order Date |
string(date-time) |
bidExpiredDate |
string(date-time) |
|
bidPointName |
Order Point |
string |
bidPrice |
Order Price |
number |
bidProcess |
Order Process |
|
bidQuantity |
Order Quantity |
integer(int64) |
bidState |
Order Status |
|
bidType |
Order Type |
|
contractName |
Order Contract |
string |
direction |
OPERATION |
|
id |
Order Id |
string |
matchingStatus |
Order Match Status |
|
modifyDate |
Order Date |
string(date-time) |
organizationEic |
EIC Code |
string |
organizationInfo |
ORGANIZATION |
|
queueTime |
Order Date |
string(date-time) |
remainingQuantity |
= {BID_REMANING_QUANTITY} |
integer(int64) |
status |
Order Status |
|
updateReason |
Order Update Reason |
|
user |
Order User |
string |
version |
Order Version |
integer(int32) |
1.14. BidStatusListRequestBody
Request Content of Order Status Listing
Type : object
1.15. BidStatusListResponseBody
Response Content of Order Status Listing
Name | Description | Schema |
---|---|---|
bidStatuses |
< StringType > array |
1.16. BidTypeListRequestBody
Request Content of Order Type Listing
Type : object
1.17. BidTypeListResponseBody
Response Content of Order Type Listing
Name | Description | Schema |
---|---|---|
bidTypes |
< StringType > array |
1.18. BidUpdateReasonListRequestBody
Request of Order Update Reason Listing Service
Type : object
1.19. BidUpdateReasonListResponse
Response of Order Update Reason Listing Service
Name | Description | Schema |
---|---|---|
bidUpdateReasonList |
< BidUpdateReasonResponse > array |
1.20. BidUpdateReasonResponse
Response of Order Update Reason Listing Service
Name | Description | Schema |
---|---|---|
localization |
Language Options for Order Update Reason |
|
name |
Order Update Reason Name |
string |
1.21. BlockingAmount
Blocked Amount
Name | Description | Schema |
---|---|---|
amount |
Amount |
number |
gasDay |
Reference Time |
string(date-time) |
1.22. Collateral
Collateral
Name | Description | Schema |
---|---|---|
amount |
Amount |
number |
referenceTime |
Reference Time |
string(date-time) |
1.23. ContractConfigurationDeclareExtraOrdinaryDayOrcRequestBody
{CONTRACT_CONF_DECLARE_EXTRAORDINARY_DAY_SERVICE_REQUEST}
Name | Description | Schema |
---|---|---|
contractName |
Contract Name |
string |
extraOrdinaryReason |
= {CONTRACT_CONF_EXTRAORDINARY_REASON} |
string |
1.1. ContractConfigurationDeclareExtraOrdinaryDayOrcResponse
{CONTRACT_CONF_DECLARE_EXTRAORDINARY_DAY_SERVICE_RESPONSE}
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.1. ContractConfigurationDeclareExtraOrdinaryDayOrcResponseBody
{CONTRACT_CONF_DECLARE_EXTRAORDINARY_DAY_SERVICE_RESPONSE}
Name | Description | Schema |
---|---|---|
beforeDRPDayPrice |
= {CONTRACT_CONF_BEFORE_DRP_DAY_PRICE} |
number |
effectedContractName |
= {CONTRACT_CONF_EFFECTED_CONTRACT_NAME} |
string |
extraOrdinaryReason |
= {CONTRACT_CONF_EXTRAORDINARY_REASON} |
string |
updatedDRP |
= {CONTRACT_CONF_UPDATED_DRP} |
boolean |
1.1. ContractConfigurationDeclareExtraOrdinaryDayOrcServiceRequest
{CONTRACT_CONF_DECLARE_EXTRAORDINARY_DAY_SERVICE_REQUEST}
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.1. ContractConfigurationExtraOrdinaryListOrcRequestBody
{CONTRACT_CONF_LIST_EXTRAORDINARY_SERVICE_REQUEST}
Name | Description | Schema |
---|---|---|
extraOrdinary |
Contract Name |
boolean |
1.1. ContractConfigurationExtraOrdinaryListOrcResponseBody
{CONTRACT_CONF_LIST_EXTRAORDINARY_SERVICE_RESPONSE}
Name | Description | Schema |
---|---|---|
contractConfigurationExtraOrdinaryList |
1.1. ContractConfigurationExtraOrdinaryListOrcServiceRequest
{CONTRACT_CONF_LIST_EXTRAORDINARY_SERVICE_REQUEST}
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.1. ContractConfigurationExtraOrdinaryListOrcServiceResponse
{CONTRACT_CONF_LIST_EXTRAORDINARY_SERVICE_RESPONSE}
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.1. ContractConfigurationExtraOrdinaryOrcResponse
{CONTRACT_CONF_LIST_EXTRAORDINARY_SERVICE_RESPONSE}
Name | Description | Schema |
---|---|---|
beforeDRP |
= {CONTRACT_CONF_BEFORE_DRP} |
number |
contractName |
Contract Name |
string |
extraOrdinary |
= {CONTRACT_CONF_EXTRAORDINARY} |
boolean |
extraordinaryReason |
= {CONTRACT_CONF_EXTRAORDINARY_REASON} |
string |
1.1. ContractConfigurationGetRequestBody
Request of Contract Configuration Query Service
Name | Description | Schema |
---|---|---|
contractName |
Contract Name |
string |
1.2. ContractConfigurationGetResponseBody
Response of Contract Configuration Query Service
Name | Description | Schema |
---|---|---|
baseCoefficient |
Min Price Coefficient |
number |
ceilingCoefficient |
Max Price Coefficient |
number |
contractConfId |
Contract Configuration Id |
integer(int64) |
dapFinalDate |
GOF Finalization Date |
string(date-time) |
dapScopeDate |
GOF Period Date |
string(date-time) |
grpFinalDate |
GRF Finalization Date |
string(date-time) |
grpScopeDate |
GRF Period Date |
string(date-time) |
lpa |
Last Matches Price Average (SFO) |
integer(int64) |
lqa |
Last Matches Quantity Average (SMO) |
integer(int64) |
marketBasePrice |
Market Min Price |
number |
marketCeilingPrice |
Market Max Price |
number |
marketMaxQuantity |
Market Max Quantity |
integer(int64) |
marketMinQuantity |
Market Min Quantity |
integer(int64) |
nbpOpenTime |
National Balancing Point (UDN) Validity Period |
number |
objectionTime |
Objection Time |
number |
retrospectiveAverage |
GRF Retrospective Average |
number |
transmissionBasePrice |
BOTAS Min Price |
number |
transmissionBasePriceFormula |
BOTAS Min Price Formula |
string |
transmissionCeilingPrice |
BOTAS Max Price |
number |
transmissionCeilingPriceFormula |
BOTAS Max Price Formula |
string |
transmissionMaxQuantity |
BOTAS Max Quantity |
integer(int64) |
transmissionMinQuantity |
BOTAS Min Quantity |
integer(int64) |
1.3. ContractGateListActiveRequestBody
Request of Active Contract Gate Listing Service
Name | Description | Schema |
---|---|---|
contractName |
string |
1.4. ContractGateListRequestBody
Request of Contract Gate Listing Service
Name | Description | Schema |
---|---|---|
contractGateTypeName |
CONTRACT_GATE_LIST_REQ_TYPE_NAME |
string |
gasDayDate |
CONTRACT_GATE_LIST_REQ_GAS_DAY_DATE |
string(date-time) |
1.5. ContractGateListResponse
Response of Contract Service
Name | Description | Schema |
---|---|---|
contractGateList |
< ContractGateResponse > array |
1.6. ContractGateResponse
{CONTRACT_GATE_SERVICE_RESPONSE}
Name | Description | Schema |
---|---|---|
announcementDate |
Contract Announcement Time |
string(date-time) |
contractGateId |
Contract Gate Id |
integer(int64) |
contractName |
Contract Name |
string |
contractType |
Contract Type |
|
directionResponse |
Response of Direction |
|
endDate |
Finish Date |
string(date-time) |
gateStatusResponse |
Gate Status |
|
gateTypeResponse |
GATE NAME |
|
physicalPointIds |
Physical Points |
< integer(int64) > array |
quantity |
Quantity |
integer(int64) |
startDate |
Start Date |
string(date-time) |
transmissionBidActivate |
BOTAS Order Activation Time |
string(date-time) |
1.7. ContractGateStatusListRequestBody
Request of Contract Gate Status Listing Service
Type : object
1.8. ContractGateStatusListResponseBody
Response of Contract Gate Status Listing Service
Name | Description | Schema |
---|---|---|
contractGateStatuses |
< StringType > array |
1.9. ContractGateStatusResponse
Response of Gate Status
Name | Description | Schema |
---|---|---|
localization |
Regional Language |
|
name |
Gate Status |
string |
1.10. ContractGateTypeResponse
Response of Contract Gate Type Service
Name | Description | Schema |
---|---|---|
localization |
Regional Language |
|
name |
GATE NAME |
string |
1.11. ContractGetRequestBody
Request Content of Contract Listing
Name | Description | Schema |
---|---|---|
contractName |
Contract Name |
string |
1.12. ContractGetResponseBody
Response Content of Contract Listing
Name | Description | Schema |
---|---|---|
contract |
1.13. ContractListByDateRequestBody
Request of Contract Listing Service
Name | Description | Schema |
---|---|---|
activationDate |
= {ACTIVATION_DATE} |
string(date-time) |
closeDate |
= {CLOSE_DATE} |
string(date-time) |
1.14. ContractListRequestBody
Request of Contract Listing Service
Name | Description | Schema |
---|---|---|
activationDate |
= {ACTIVATION_DATE} |
string(date-time) |
contractStatusNames |
Contract Status |
< string > array |
contractTypeName |
Contract Type |
string |
gasDayDate |
Gas Day |
string(date-time) |
1.15. ContractListResponse
Response of Contract Listing Service
Name | Description | Schema |
---|---|---|
contractList |
< ContractResponse > array |
1.16. ContractResponse
Response of Contract Service
Name | Description | Schema |
---|---|---|
activationDate |
Contract Activation Time |
string(date-time) |
closeDate |
Contract Finish Time |
string(date-time) |
contractGateList |
Contract Gate List |
|
contractName |
Contract Name |
string |
contractStatus |
Contract Status |
|
contractType |
Contract Type |
|
createDate |
Contract Creating Time |
string(date-time) |
gasDays |
= {CONTRACT_GAS_DAYS} |
< GasDay > array |
1.17. ContractStatusListRequestBody
Request Content of Contract Status Listing
Type : object
1.18. ContractStatusListResponseBody
Response of Contract Status Listing Request
Name | Description | Schema |
---|---|---|
contractStatuses |
< StringType > array |
1.19. ContractStatusResponse
Response of Contract Status Listing Service
Name | Description | Schema |
---|---|---|
localization |
Regional Language |
|
name |
Contract Status |
string |
1.20. ContractSummary
{CONTRACT_SUMMARY}
Name | Description | Schema |
---|---|---|
bestAmountPriceBuying |
BEST BUY |
|
bestAmountPriceSelling |
BEST SELL |
|
closingTime |
Contract Finish Time |
string(date-time) |
deliveryDays |
Gas Delivery Days |
< string(date-time) > array |
gasDays |
= {CONTRACT_GAS_DAYS} |
< GasDay > array |
highestMatchingPrice |
HIGHEST MATCHING PRICE |
number |
lastMatchingPrice |
LAST MATCH PRICE |
number |
lowestMatchingPrice |
LOWEST MATCHING PRICE |
number |
name |
Contract Name |
string |
status |
Contract Status |
|
type |
TYPE |
|
weightedAverage |
WEIGHTED AVERAGE |
number |
1.1. ContractSummaryResponseBody
Response of Active Contract Listing Service
Name | Description | Schema |
---|---|---|
contracts |
< ContractSummary > array |
1.2. ContractTypeListRequestBody
Request Content of Contract Type Listing
Type : object
1.3. ContractTypeListResponseBody
Response of Contract Type Listing
Name | Description | Schema |
---|---|---|
contractTypes |
< StringType > array |
1.4. ContractTypeResponse
{CONTRACT_TYPE_LIST_SERVICE_RESPONSE}
Name | Description | Schema |
---|---|---|
localization |
Regional Language |
|
name |
Contract Type |
string |
1.5. CurrentNetFinancialStatus
Last Financial Position
Name | Description | Schema |
---|---|---|
advancePaymentDate |
Advance Payment Day |
string(date-time) |
advancePaymentDayNetFinancialStatus |
Advance Payment Date Net Financial Position |
number |
financialStatusItems |
< NetFinancialStatus > array |
|
gasday |
Contract Gas Day |
string(date-time) |
processLimit |
Transaction Limit |
number |
1.6. CurrentStatusServiceRequestBody
Request of Final Net Financial Position
Type : object
1.7. CurrentStatusServiceResponseBody
Response of Final Net Financial Position
Name | Description | Schema |
---|---|---|
blockingAmounts |
< BlockingAmount > array |
|
collaterals |
< Collateral > array |
|
netstatuses |
< CurrentNetFinancialStatus > array |
|
organization |
Organization Title |
1.8. DailyFinancialStatusProcessLimitRequestBody
Request Content of Daily Financial Position Transaction Limit Listing Service
Name | Description | Schema |
---|---|---|
contractName |
Contract Name |
string |
1.9. DailyFinancialStatusProcessLimitResponseBody
Response Content of Daily Financial Position Transaction Limit Listing Service
Name | Description | Schema |
---|---|---|
processLimit |
Transaction Limit |
number |
1.10. DirectionListRequestBody
Request of Content for Direction Listing
Type : object
1.11. DirectionListResponseBody
Response of Direction Listing
Name | Description | Schema |
---|---|---|
directionList |
< StringType > array |
1.12. DirectionResponse
Response of Direction Listing Service
Name | Description | Schema |
---|---|---|
localization |
Regional Language |
|
name |
Direction Name |
string |
1.13. GasDay
Contract Gas Day
Name | Description | Schema |
---|---|---|
advancePaymentDate |
Advance Payment Day |
string(date-time) |
gasDayDate |
Gas Day |
string(date-time) |
gasDayId |
Gas Day ID |
integer(int64) |
gasDeliveryEndDate |
Gas Delivery Finish Date |
string(date-time) |
gasDeliveryStartDate |
Gas Delivery Start Date |
string(date-time) |
registrationPeriodId |
Gas Day Registration Period Id |
integer(int64) |
1.14. GasDayGetRequestBody
Request Content of Listing Gas Day
Name | Description | Schema |
---|---|---|
gasDayDate |
Gas Day |
string(date-time) |
1.15. GasDayGetResponseBody
Response of Gas Day Display
Name | Description | Schema |
---|---|---|
gasDayGetResponse |
1.16. GasDayListRequestBody
Request Content of Gas Day Listing
Type : object
1.17. GasDayListResponseBody
Response of Gas Day Listing
Name | Description | Schema |
---|---|---|
gasDayListResponse |
< GasDayResponse > array |
1.18. GasDayResponse
Response of Gas Day
Name | Description | Schema |
---|---|---|
abpAbsEarlyDate |
IDAF/IDSF Publication Time |
string(date-time) |
abpAbsFinalDate |
IDAF/IDSF Finalization Time |
string(date-time) |
abpFormula |
IDAF Calculation Formula |
string |
abpPrice |
IDAF Price |
number |
absFormula |
IDSF Calculation Formula |
string |
absPrice |
IDSF Price |
number |
advancePaymentDate |
Advance Payment Day |
string(date-time) |
bgpBgsEarlyDate |
Balancing Gas Buy/Sell Price Publication Time |
string(date-time) |
bgpBgsFinalDate |
Balancing Gas Buy/Sell Price Finalization Time |
string(date-time) |
bgpFormula |
Balancing Gas Buy Price Calculation Formula |
string |
bgpPrice |
Balancing Gas Buy Price |
number |
bgsFormula |
Balancing Gas Sell Price Calculation Formula |
string |
bgsPrice |
Balancing Gas Sell Price |
number |
gasDayDate |
Gas Day |
string(date-time) |
gasDayId |
Gas Day ID |
integer(int64) |
gasDeliveryEndDate |
Gas Delivery Finish Date |
string(date-time) |
gasDeliveryStartDate |
Gas Delivery Start Date |
string(date-time) |
registrationPeriodId |
Registration Period Id |
integer(int64) |
1.19. GasDaySaveRequestBody
Request of Gas Day Save Service
Name | Description | Schema |
---|---|---|
abpAbsEarlyDate |
IDAF/IDSF Publication Time |
string(date-time) |
abpAbsFinalDate |
IDAF/IDSF Finalization Time |
string(date-time) |
abpFormula |
IDAF Calculation Formula |
string |
abpPrice |
IDAF Price |
number |
absFormula |
IDSF Calculation Formula |
string |
absPrice |
IDSF Price |
number |
bgpBgsEarlyDate |
Balancing Gas Buy/Sell Price Publication Time |
string(date-time) |
bgpBgsFinalDate |
Balancing Gas Buy/Sell Price Finalization Time |
string(date-time) |
bgpFormula |
Balancing Gas Buy Price Calculation Formula |
string |
bgpPrice |
Balancing Gas Buy Price |
number |
bgsFormula |
Balancing Gas Sell Price Calculation Formula |
string |
bgsPrice |
Balancing Gas Sell Price |
number |
gasDayDate |
Gas Day |
string(date-time) |
gasDeliveryEndDate |
Gas Delivery Finish Date |
string(date-time) |
gasDeliveryStartDate |
Gas Delivery Start Date |
string(date-time) |
registrationPeriodId |
Registration Period Id |
integer(int64) |
1.20. GasDaySaveResponseBody
Response of Gas Day Service
Type : object
1.21. Header
TITLE
Name | Description | Schema |
---|---|---|
key |
Header Key |
string |
value |
Header Value |
string |
1.22. LocalizationResponse
Response of Regional Service
Name | Description | Schema |
---|---|---|
language |
Regional Language |
string |
text |
Regional Text |
string |
1.23. LongType
Numerical Type
Name | Description | Schema |
---|---|---|
text |
Definition |
string |
value |
VALUE |
integer(int64) |
1.24. MarketPriceGetRequestBody
Request Content of Market Price
Name | Description | Schema |
---|---|---|
gasDayEndDate |
Market Price Gas Day |
string(date-time) |
gasDayStartDate |
Market Price Gas Day |
string(date-time) |
priceType |
Market Price Type |
enum (GAS_REFERENCE, ADDITIONAL_BALANCING_PURCHASE, ADDITIONAL_BALANCING_SALE, BALANCING_GAS_PURCHASE, BALANCING_GAS_SALE, DAY_AHEAD, WEEKLY_GAS_REFERENCE) |
1.25. MarketPriceResponse
Response Content of Market Price
Name | Description | Schema |
---|---|---|
price |
Market Price |
number |
priceType |
Market Price Type |
enum (GAS_REFERENCE, ADDITIONAL_BALANCING_PURCHASE, ADDITIONAL_BALANCING_SALE, BALANCING_GAS_PURCHASE, BALANCING_GAS_SALE, DAY_AHEAD, WEEKLY_GAS_REFERENCE) |
state |
Market Price Status |
enum (EARLY, FINAL) |
1.26. Match
Match
Name | Description | Schema |
---|---|---|
contract |
Contract Name |
string |
matchId |
Match Id |
string |
matchStatus |
Match Status |
string |
matchingTime |
Match Time |
string(date-time) |
myOwnMatching |
My Matches |
boolean |
pointName |
Order Point |
string |
price |
Price |
number |
quantity |
Quantity |
integer(int64) |
1.27. MatchByPeriod
Response of Match
Name | Description | Schema |
---|---|---|
direction |
Response of Direction |
|
matchQuantity |
Match Quantity |
integer(int64) |
organization |
ORGANIZATION |
1.28. MatchByPeriodResponse
Response of Match
Name | Description | Schema |
---|---|---|
period |
Match Period |
|
periodMatchResponse |
< MatchByPeriod > array |
1.29. MatchByRegionalResponse
Response of Match
Name | Description | Schema |
---|---|---|
contractName |
Contract Name |
string |
direction |
Response of Direction |
|
matchQuantity |
Match Quantity |
integer(int64) |
organization |
ORGANIZATION |
|
pointName |
Order Point |
string |
1.30. MatchCurrentStatusRequestBody
Request Content of Match Listing
Name | Description | Schema |
---|---|---|
contractName |
Contract Name |
string |
organizationEic |
EIC Code |
string |
1.31. MatchCurrentStatusResponse
Response of Match Listing
Name | Description | Schema |
---|---|---|
organizationEic |
EIC Code |
string |
organizationInfo |
ORGANIZATION |
|
totalPurchaseMatchQuantity |
Match Total Buy Quantity |
integer(int64) |
totalSaleMatchQuantity |
Match Total Sell Quantity |
integer(int64) |
1.32. MatchCurrentStatusResponseBody
Response Content of Match Listing
Name | Description | Schema |
---|---|---|
contractName |
Match Id |
string |
matchCurrentStatusResponses |
< MatchCurrentStatusResponse > array |
1.33. MatchDetailListResponseBody
Response of Match Detail Listing Service
Name | Description | Schema |
---|---|---|
matchList |
< MatchDetailResponse > array |
1.34. MatchDetailResponse
Response of Match Detail
Name | Description | Schema |
---|---|---|
contractName |
Contract Name |
string |
createDate |
Match Date |
string(date-time) |
createUser |
Match User |
string |
matchId |
Match Id |
string |
matchStatus |
Match Status |
|
pointName |
Order Point |
string |
price |
Match Price |
number |
purchaseBid |
Match for Buy Order |
|
purchaseBidVersion |
Version of Match for Buy Order |
integer(int32) |
purchaseMatchReason |
Match Reason |
|
quantity |
Match Quantity |
integer(int64) |
saleBid |
Match by Sell Order |
|
saleBidVersion |
Version of Match by Sell Order |
integer(int32) |
saleMatchReason |
Match Reason |
1.35. MatchListByBidRequest
Order Match Listing
Name | Description | Schema |
---|---|---|
bidId |
string |
1.36. MatchListByBidRequestBody
Request of Match Listing By Order
Name | Description | Schema |
---|---|---|
bidIds |
< MatchListByBidRequest > array |
1.37. MatchListByContractOrgRequestBody
Request of Organization Match Listing Service
Name | Description | Schema |
---|---|---|
contractName |
Contract Name |
string |
organizationId |
Match Order Organization Id |
integer(int64) |
1.38. MatchListByContractRequestBody
Response of Matched Order by Contract Listing Service
Name | Description | Schema |
---|---|---|
contractNames |
Contract Name |
< string > array |
queryType |
Match Query Type |
enum (ALL, SELF) |
1.39. MatchListByPeriodRequestBody
Request of Match Listing Service
Name | Description | Schema |
---|---|---|
gasDayDate |
Gas Day |
string(date-time) |
periodName |
Request Period |
string |
1.40. MatchListByPeriodResponse
Response of Match Listing Service
Name | Description | Schema |
---|---|---|
gasDayDate |
Gas Day |
string(date-time) |
periodResponses |
< MatchByPeriodResponse > array |
1.41. MatchListByRegionalRequestBody
Request of Match Listing Service
Name | Description | Schema |
---|---|---|
contractName |
Contract Name |
string |
1.42. MatchListByRegionalResponse
Response of Match Listing Service
Name | Description | Schema |
---|---|---|
regionalResponses |
< MatchByRegionalResponse > array |
1.43. MatchListBySelfContractRequestBody
Request Content of Match Listing Service
Name | Description | Schema |
---|---|---|
contractName |
Contract Name |
string |
1.44. MatchListRequestBody
Request Content of Match Listing
Name | Description | Schema |
---|---|---|
createDate |
Match Date |
string(date-time) |
1.45. MatchListResponse
Response of Match Listing Service
Name | Description | Schema |
---|---|---|
matchList |
< MatchResponse > array |
1.46. MatchResponse
Response of Match
Name | Description | Schema |
---|---|---|
bid |
Order |
|
bidVersion |
Match Version |
integer(int32) |
contractName |
Contract Name |
string |
createDate |
Match Date |
string(date-time) |
createUser |
Match User |
string |
matchId |
Match Id |
string |
matchReason |
Match Reason |
|
matchStatus |
Match Status |
|
pointName |
Order Point |
string |
price |
Match Price |
number |
quantity |
Match Quantity |
integer(int64) |
1.47. MatchWithBidListResponse
Response of Match
Name | Description | Schema |
---|---|---|
bids |
Order |
< BidResponse > array |
createDate |
Match Date |
string(date-time) |
createUser |
Match User |
string |
matchId |
Match Id |
string |
matchReason |
Match Reason |
|
matchStatus |
Match Status |
|
pointName |
Order Point |
string |
price |
Match Price |
number |
quantity |
Match Quantity |
integer(int64) |
1.48. NetFinancialStatus
Financial Position
Name | Description | Schema |
---|---|---|
contract |
Contract Name |
string |
datetime |
Transaction Time |
string(date-time) |
direction |
Financial Position Direction |
|
id |
string |
|
netStatusAmount |
Net Position Amount |
number |
processAmount |
Transaction Amount |
number |
type |
Financial Position Type |
1.49. ObjectionCreateRequestBody
Request Content of Objection
Name | Description | Schema |
---|---|---|
matchId |
Match Id |
string |
objectionMessage |
Objection Message |
string |
objectionTypeName |
Objection Type |
string |
1.50. ObjectionCreateResponseBody
Response Content of Objection
Name | Description | Schema |
---|---|---|
objectionResponse |
Objection Answer |
1.51. ObjectionGetRequestBody
Request Content of Objection Listing
Name | Description | Schema |
---|---|---|
endDate |
Objection Finish Time |
string(date-time) |
matchId |
Match Id |
string |
objectionStatusNames |
Objection Status |
< string > array |
startDate |
Objection Start Time |
string(date-time) |
1.52. ObjectionGetResponseBody
Response of Objection Listing
Name | Description | Schema |
---|---|---|
objectionResponses |
Objection Answer |
< ObjectionResponse > array |
1.53. ObjectionReplyRequestBody
Request Content of Objection Answering
Name | Description | Schema |
---|---|---|
objectionId |
OBJECTION ID |
integer(int64) |
objectionStatusName |
Objection Status |
string |
replyMessage |
Objection Answer |
string |
1.54. ObjectionReplyResponseBody
Response of Objection Answering
Name | Description | Schema |
---|---|---|
objectionResponse |
Objection Answer |
1.55. ObjectionResponse
Objection Answer
Name | Description | Schema |
---|---|---|
createUser |
Objection Create User |
string |
createUserMail |
Objection Create User E-mail |
string |
createUserName |
Objection Create User |
string |
createUserPhone |
Objection Create User Phone |
string |
matchWithBidListResponse |
Response of Match |
|
objectionDate |
Objection Date |
string(date-time) |
objectionId |
OBJECTION ID |
integer(int64) |
objectionMessage |
Objection Message |
string |
objectionStatus |
Objection Status |
|
objectionType |
Objection Type |
|
organizationInfo |
Objection Create Organization |
|
replyDate |
Objection Answering Time |
string(date-time) |
replyMessage |
Objection Answer |
string |
replyUser |
Objection Answer User |
string |
1.56. ObjectionStatusListRequestBody
Request of Objection Status Listing Service
Type : object
1.57. ObjectionStatusListResponse
Response of Objection Status Listing Service
Name | Description | Schema |
---|---|---|
objectionStatuses |
< StringType > array |
1.58. ObjectionTypeListRequestBody
Request of Objection Type Listing Service
Type : object
1.59. ObjectionTypeListResponse
Response of Objection Type Listing Service
Name | Description | Schema |
---|---|---|
objectionTypes |
< StringType > array |
1.60. OrganizationMatchListResponse
Response of Organization Match Listing Service
Name | Description | Schema |
---|---|---|
matchList |
< OrganizationMatchResponse > array |
1.61. OrganizationMatchReport
Response of Organization Match Report Service
Name | Description | Schema |
---|---|---|
direction |
Direction Name |
|
organization |
Organization Title |
|
quantity |
Match Quantity |
integer(int64) |
1.62. OrganizationMatchReportRequestBody
Request of Organization Match Report Service
Name | Description | Schema |
---|---|---|
contractNames |
Contract Names |
< string > array |
1.63. OrganizationMatchReportResponseBody
Response of Organization Match Report Service
Name | Description | Schema |
---|---|---|
organizationMatchReports |
< OrganizationMatchReport > array |
1.64. OrganizationMatchResponse
Response of Organization Match
Name | Description | Schema |
---|---|---|
contractName |
Contract Name |
string |
matchDate |
Match Date |
string(date-time) |
organizationId |
Match Order Organization Id |
integer(int64) |
pointName |
Order Point |
string |
purchaseOrganization |
Organization Title |
string |
quantity |
Order Quantity |
integer(int64) |
saleOrganization |
Organization Title |
string |
1.65. ReasonCodeListOrcResponse
{REASON_CODE_LIST_SERVICE_RESPONSE}
Name | Description | Schema |
---|---|---|
reasonCodeTypes |
< StringType > array |
1.1. ReasonCodeListRequestOrcBody
{REASON_CODE_LIST_SERVICE_REQUEST}
1.1. RegionalContractResponseBody
Response of Active Contract Saving
Name | Description | Schema |
---|---|---|
contracts |
< RegionalContractSummary > array |
1.2. RegionalContractSummary
N/B Contracts
Name | Description | Schema |
---|---|---|
bestAmountPriceBuying |
BEST BUY |
|
bestAmountPriceSelling |
BEST SELL |
|
closingTime |
Contract Finish Time |
string(date-time) |
deliveryDays |
Gas Delivery Days |
< string(date-time) > array |
direction |
Transaction Direction |
|
gasDays |
= {CONTRACT_GAS_DAYS} |
< GasDay > array |
highestMatchingPrice |
HIGHEST MATCHING PRICE |
number |
lowestMatchingPrice |
LOWEST MATCHING PRICE |
number |
name |
Contract Name |
string |
points |
Points |
< integer(int64) > array |
remainingAmount |
Remaining Quantity |
integer(int64) |
status |
Contract Status |
|
totalAmount |
TOTAL QUANTITY |
integer(int64) |
type |
TYPE |
1.3. StringType
String Type
Name | Description | Schema |
---|---|---|
text |
Definition |
string |
value |
VALUE |
string |
1.4. activeContractMatchingRequest
Request of Active Contract Match
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.5. activeContractMatchingResponse
Response of Active Contract Match
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.6. bidByContractServiceRequest
Request of Order Listing by Contract Name and Status
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.7. bidCancelServiceRequest
{BID_CANCEL_SERVICE_RESPONSE}
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.1. bidCancelServiceResponse
{BID_CANCEL_SERVICE_RESPONSE}
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.1. bidGetByIdServiceRequest
Request of Order Listing by Order Id Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.2. bidGetByIdServiceResponse
Response of Order Listing by Order Id Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.3. bidGetServiceRequest
Request of Order Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.4. bidGetServiceResponse
Response of Order Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.5. bidHistoryListByMatchServiceRequest
Request of Matched Orders History Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.6. bidHistoryListByMatchServiceResponse
Response of Matched Orders History Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.7. bidHistoryListServiceRequest
Request of Order History Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.8. bidHistoryListServiceResponse
Response of Order History Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.9. bidMatchStatusListServiceRequest
Request of Order Match Status Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.10. bidMatchStatusListServiceResponse
Response of Order Match Status Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.11. bidStatusListServiceRequest
Request of Order Status Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.12. bidStatusListServiceResponse
Response of Order Status Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.13. bidTypeListServiceRequest
Request of Order Type Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.14. bidTypeListServiceResponse
Response of Order Type Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.15. bidUpdateReasonListServiceRequest
Request of Order Update Reason Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.16. bidUpdateReasonListServiceResponse
Response of Order Update Reason Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.17. contractConfigurationGetServiceRequest
Request of Contract Configuration Query Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.18. contractConfigurationGetServiceResponse
Response of Contract Configuration Query Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.19. contractGateListActiveServiceRequest
Request of Active Contract Gate Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.20. contractGateListServiceRequest
Request of Contract Gate Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.21. contractGateListServiceResponse
Response of Contract Gate Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.22. contractGateStatusListServiceRequest
Request of Contract Gate Status Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.23. contractGateStatusListServiceResponse
Response of Contract Gate Status Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.24. contractGetServiceRequest
Request of Contract Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.25. contractGetServiceResponse
Response of Contract Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.26. contractListByDateServiceRequest
Request of Contract Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.27. contractListByDateServiceResponse
Response of Contract Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.28. contractListServiceRequest
Request of Contract Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.29. contractListServiceResponse
Response of Contract Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.30. contractStatusListServiceRequest
{CONTRACT_STATUS_LIST_SERVICE_REQUEST}
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.1. contractStatusListServiceResponse
Response of Contract Status Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.2. contractSummaryResponse
Response of Active Contract Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.3. contractTypeListServiceRequest
Request of Contract Type Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.4. contractTypeListServiceResponse
{CONTRACT_TYPE_LIST_SERVICE_RESPONSE}
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.5. currentStatusServiceRequest
Request of Final Net Financial Position
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.6. currentStatusServiceResponse
Response of Final Net Financial Position
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.7. dailyFinancialStatusProcessLimitServiceRequest
Request of Daily Financial Position Transaction Limit Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.8. dailyFinancialStatusProcessLimitServiceResponse
Response of Daily Financial Position Transaction Limit Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.9. directionListServiceRequest
Request of Direction Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.10. directionListServiceResponse
Response of Direction Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.11. gasDayGetServiceRequest
Service of Gas Day
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.12. gasDayGetServiceResponse
Response of Gas Day Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.13. gasDayListServiceRequest
Request of Gas Day Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.14. gasDayListServiceResponse
Response of Gas Day Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.15. gasDaySaveServiceRequest
Request of Gas Day Save Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.16. gasDaySaveServiceResponse
Response of Gas Day Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.17. marketPriceGetListResponse
Response Content of Market Price
Name | Description | Schema |
---|---|---|
gasDay |
Market Price Gas Day |
string(date-time) |
marketPriceResponseList |
< MarketPriceResponse > array |
1.18. marketPriceGetRequest
Request of Market Price
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.19. marketPriceGetResponseBody
Response of Market Price
Name | Description | Schema |
---|---|---|
marketPriceGetListResponseList |
< marketPriceGetListResponse > array |
1.20. marketPriceGetServiceResponse
Response of Market Price Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.21. matchCurrentStatusServiceRequest
Request of Match Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.22. matchCurrentStatusServiceResponse
Response of Match Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.23. matchDetailListServiceResponse
Response of Match Detail Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.24. matchListByBidServiceRequest
Request of Match Listing By Order Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.25. matchListByContractOrgServiceRequest
Request of Organization Match Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.26. matchListByContractServiceRequest
Response of Matched Order by Contract Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.27. matchListByPeriodServiceRequest
Request of Match Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.28. matchListByPeriodServiceResponse
Response of Match Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.29. matchListByRegionalServiceRequest
Request of Match Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.30. matchListByRegionalServiceResponse
Response of Match Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.31. matchListBySelfContractServiceRequest
Request of Match Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.32. matchListServiceRequest
Request of Match Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.33. matchListServiceResponse
Response of Match Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.34. objectionCreateServiceRequest
Request of Objection Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.35. objectionCreateServiceResponse
Response of Objection Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.36. objectionGetServiceRequest
Request of Objection Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.37. objectionGetServiceResponse
Response of Objection Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.38. objectionReplyServiceRequest
Request of Objection Answering Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.39. objectionReplyServiceResponse
Response of Objection Answering Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.40. objectionStatusListServiceRequest
Request of Objection Status Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.41. objectionStatusListServiceResponse
Response of Objection Status Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.42. objectionTypeListServiceRequest
Request of Objection Type Listing Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.43. objectionTypeListServiceResponse
Response of Objection Type Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.44. organizationMatchListServiceResponse
Response of Organization Match Listing Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.45. organizationMatchReportServiceRequest
Request of Organization Match Report Service
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.46. organizationMatchReportServiceResponse
Response of Organization Match Report Service
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.47. reasonCodeListOrcServiceResponse
{REASON_CODE_LIST_SERVICE_RESPONSE}
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
1.1. reasonCodeListServiceRequest
{REASON_CODE_LIST_SERVICE_REQUEST}
Name | Description | Schema |
---|---|---|
body |
||
headers |
TITLE |
< Header > array |
1.1. regionalContractResponse
Response of Active Contract Saving
Name | Description | Schema |
---|---|---|
body |
||
resultCode |
Result Code |
string |
resultDescription |
Result Code Description |
string |
resultType |
Result Type |
enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR) |
transactionId |
Result Type |
string |
6. OperationCode Get Service
6.1. How to call Operation Code Get Service?
You can check service details from here .
<?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>
<?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>
{
"headers": [
{
"key": "application",
"value": "528969ea-d7f6-440a-b020-e78a8d531a32"
},
{
"key": "transactionId",
"value": "d883f25c-413d-41e8-b695-9731186950dd"
}
],
"body": {
}
}
{
"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 .
<?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>
<?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>
{
"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"
}
}
{
"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 .
<?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>
<?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>
{
"headers": [
{
"key": "transactionId",
"value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
}
],
"body": {
"contractName": "GG20180515"
}
}
{
"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 .
<?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>
<?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>
{
"headers": [
{
"key": "transactionId",
"value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
}
],
"body": {
"contractName": "GG20180222N1"
}
}
{
"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"
}
]
}
}