{ "swagger" : "2.0", "info" : { "version" : "v1", "title" : "Metering Point Services" }, "host" : "tys-qa.epias.com.tr", "basePath" : "/ecms-consumption-metering-point/rest", "tags" : [ { "name" : "cmp" }, { "name" : "ecms-metering-data" }, { "name" : "evacuation-request" }, { "name" : "meter-configuration" }, { "name" : "metering_data_total" }, { "name" : "metering_info" }, { "name" : "metering_point_demand" }, { "name" : "profile" }, { "name" : "profilefactors" }, { "name" : "registration" } ], "schemes" : [ "https" ], "paths" : { "/cmp/list-changed-supplier-meters" : { "post" : { "tags" : [ "cmp" ], "summary" : "List Meters whose supplier has changed", "description" : "Returns the list of meters whose supplier has changed.", "operationId" : "/cmp/list-changed-supplier-meters", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/GetChangedSupplierMetersRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/ChangedSupplierMeterServiceResponse" } } } } }, "/cmp/list-deducted-meters" : { "post" : { "tags" : [ "cmp" ], "summary" : "Portföye Giren Tenzil Sayaç Listeleme Servisi", "description" : "Verilen dönemde portföye giren tenzil sayaçları listeler.", "operationId" : "/cmp/list-deducted-meters", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/GetDeductedMetersRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/DeductedMeterServiceResponse" } } } } }, "/cmp/list-meter-count" : { "post" : { "tags" : [ "cmp" ], "summary" : "List Meter Counts", "description" : "Returns the list of meter counts with the reading type.", "operationId" : "/cmp/list-meter-count", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/GetMeterCountRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/MeterCountServiceResponse" } } } } }, "/cmp/list-meter-eic" : { "post" : { "tags" : [ "cmp" ], "summary" : "Meter EIC Querying Service", "description" : "This service returns EIC info a meter.", "operationId" : "/cmp/list-meter-eic", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/MeteringPointEICQueryRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/MeteringPointEICQueryResponse" } } } } }, "/cmp/list-meter-eic-range" : { "post" : { "tags" : [ "cmp" ], "summary" : "List Meter Eic List Service", "description" : "Returns the list of meter eic's", "operationId" : "/cmp/list-meter-eic-range", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/GetMeterEicRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/MeterEicInfoServiceResponse" } } } } }, "/cmp/listall" : { "post" : { "tags" : [ "cmp" ], "summary" : "Metering Point Listing Service", "description" : "This service returns list of metering point.", "operationId" : "/cmp/listall", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/GetMeteringPointsRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/MeteringPointServiceResponse" } } } } }, "/cmp/new-meters-to-be-read" : { "post" : { "tags" : [ "cmp" ], "summary" : "List New Metering Points To Be Read Service", "description" : "If meter eic is given, it returns info of that metering point. If range is given, it returns all metering points info in that range.", "operationId" : "/cmp/new-meters-to-be-read", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/GetNewMeteringPointsRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/ReadingMeteringPointServiceResponse" } } } } }, "/cmp/nonobligatory-to-read" : { "post" : { "tags" : [ "cmp" ], "summary" : "List Non-obligatory To Read Metering Points Service", "description" : "If meter eic is given, it returns info of that metering point. If range is given, it returns all metering points info in that range.", "operationId" : "/cmp/nonobligatory-to-read", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/GetNonobligatoryToReadMetersRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/ReadingMeteringPointServiceResponse" } } } } }, "/cmp/report" : { "post" : { "tags" : [ "cmp" ], "summary" : "Free Consumer's Portfolio List", "description" : "Service that returns free consumers' pre/final list that goes in and out to suppliers' portfolio.", "operationId" : "/cmp/report", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/EligibleCustomerReportRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/EligibleCustomerReportResponse" } } } } }, "/cmp/returned-to-supplier-meters" : { "post" : { "tags" : [ "cmp" ], "summary" : "List Meters which returned to its own supplier company.", "description" : "Returns the list of meters which returned to its own supplier company.", "operationId" : "/returned-to-supplier-meters", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/GetReturnedToSupplierMetersRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/ReturnedToSupplierMeterServiceResponse" } } } } }, "/cmp/save" : { "post" : { "tags" : [ "cmp" ], "summary" : "Save / Update Metering Points Service", "description" : "If meterEic and meteringPointUpdateDate is given, existed record is updated. If not, a new one is created.", "operationId" : "/cmp/save", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/MeteringPointRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/MeteringPointSaveListResponse" } } } } }, "/cmp/supplier/list-meter-info" : { "post" : { "tags" : [ "cmp" ], "summary" : "Service for Querying Supplier Meter EIC.", "description" : "It returns meter EIC info of given interval for suppliers.", "operationId" : "/supplier/list-meter-info", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/MeterInformationForSupplierRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/MeterInformationListForSupplierResponse" } } } } }, "/ecms-metering-data/list/hourly" : { "post" : { "tags" : [ "ecms-metering-data" ], "summary" : "Meter Supply / Withdrawal Service", "description" : "This service lists supply and withdrawal info of a meter.", "operationId" : "/ecms-metering-data/list/hourly", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Criterias for listing supply and withdrawal info", "required" : true, "schema" : { "$ref" : "#/definitions/QueryMeteringHourlyRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/QueryMeteringHourlyResponse" } } } } }, "/ecms-metering-data/save/bulk/hourly" : { "post" : { "tags" : [ "ecms-metering-data" ], "summary" : "Saatlik Sayaç Verisi Yükleme (Çoklu)", "description" : "Okuma tipi saatlik olan sayaçların üretim/tüketim değerlerinin yüklemesini yapan servisdir.", "operationId" : "/ecms-metering-data/save/bulk/hourly", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/MeteringHourlyBulkDataRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/MeteringDataBulkResponse" } } } } }, "/ecms-metering-data/save/bulk/profile" : { "post" : { "tags" : [ "ecms-metering-data" ], "summary" : "Üç ve Tek Zamanlı Sayaç Verisi Yükleme (Çoklu)", "description" : "Okuma tipi üç ve tek zamanlı olan sayaçların tüketim değerlerinin yüklemesini yapan servisdir", "operationId" : "/ecms-metering-data/save/bulk/profile", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/MeteringProfileBulkDataRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/MeteringDataBulkResponse" } } } } }, "/ecms-metering-data/save/hourly" : { "post" : { "tags" : [ "ecms-metering-data" ], "summary" : "Hourly Meter Saving Service", "description" : "Service for saving generation and consumption values of hourly meters.", "operationId" : "ecms-metering-data/save/hourly", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/MeteringHourlyDataRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/MeteringDataResponse" } } } } }, "/ecms-metering-data/save/profile" : { "post" : { "tags" : [ "ecms-metering-data" ], "summary" : "Single or Three Tariffs Meters Saving Service", "description" : "The service which saves monthly consumption values of single or three tariffs meters.", "operationId" : "ecms-metering-data/save/profile", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/MeteringProfileDataRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/MeteringDataResponse" } } } } }, "/evacuation-request/cancel" : { "post" : { "tags" : [ "evacuation-request" ], "summary" : "Metering Point Evacuation Request Cancellation Service", "description" : "Service method that cancels metering point evacuation request.", "operationId" : "Evacuation Request Cancellation", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Request of Evacuation Request Cancellation", "required" : true, "schema" : { "$ref" : "#/definitions/EvacuationCancelRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/EvacuationCancelResponse" } } } } }, "/evacuation-request/cancel-deny" : { "post" : { "tags" : [ "evacuation-request" ], "summary" : "Metering Point Cancellation of Rejection of Evacuation Request Service", "description" : "Service method that cancels metering point evacuation request.", "operationId" : "Cancellation of Rejection of Evacuation Request", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Request of Cancellation of Rejection of Evacuation Request", "required" : true, "schema" : { "$ref" : "#/definitions/EvacuationCancelRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/EvacuationCancelResponse" } } } } }, "/evacuation-request/deny" : { "post" : { "tags" : [ "evacuation-request" ], "summary" : "Metering Point Rejection of Evacuation Request Service", "description" : "Service methods that rejects Evacuation Request.", "operationId" : "Rejection of Evacuation Request", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Request of Rejection of Evacuation Request", "required" : true, "schema" : { "$ref" : "#/definitions/EvacuationCancelRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/EvacuationCancelResponse" } } } } }, "/meter-configuration/deduc/save" : { "post" : { "tags" : [ "meter-configuration" ], "summary" : "", "description" : "", "operationId" : "/meter-configuration-deduc-save", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/MeterDeducSettlementPointRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/MeterDeducSettlementPointResponse" } } } } }, "/metering/data/total/list" : { "post" : { "tags" : [ "metering_data_total" ], "summary" : "Total Metering Data List Service", "description" : "This service lists total metering consumption & generation information.", "operationId" : "/metering/data/total/list", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Total Metering Data List Request", "required" : true, "schema" : { "$ref" : "#/definitions/MeteringDataTotalQueryRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/MeteringDataTotalQueryResponse" } } } } }, "/metering/data/total/list-meter-data-configuration" : { "post" : { "tags" : [ "metering_data_total" ], "summary" : "Service to control meter is read or not and Listing past meters", "description" : "With this service, users can learn if the meters are read or not and can list past meters if exists and how are the meters attached in terms of configuration. ", "operationId" : "/metering/data/total/list-meter-data-configuration", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : true, "schema" : { "$ref" : "#/definitions/MeteringDataConfigurationQueryRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/MeteringDataAndConfigurationQueryResponse" } } } } }, "/metering/info/get" : { "post" : { "tags" : [ "metering_info" ], "summary" : "Metering Info Service (Single)", "description" : "This service returns meter info whose EIC is given in the request parameter.", "operationId" : "/metering/info/get", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Criteria for meter info listing.", "required" : true, "schema" : { "$ref" : "#/definitions/QueryMeteringInfoRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/QueryMeteringInfoResponse" } } } } }, "/metering/info/list" : { "post" : { "tags" : [ "metering_info" ], "summary" : "Listing Metering Info Service", "description" : "This service list meter info.", "operationId" : "/metering/info/list", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Criteria for meter info listing.", "required" : true, "schema" : { "$ref" : "#/definitions/QueryMeteringInfoListRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/QueryMeteringInfoListResponse" } } } } }, "/metering/point/demand/create" : { "post" : { "tags" : [ "metering_point_demand" ], "summary" : "Metering Point Saving Address", "description" : "Saves demand of a metering point.", "operationId" : "/metering/point/demand/create", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/MeteringPointDemandCreateRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/MeteringPointDemandCreateResponse" } } } } }, "/metering/point/demand/customer/update" : { "post" : { "tags" : [ "metering_point_demand" ], "summary" : "Demand Customer Update Service", "description" : "This service update customer informations of demand", "operationId" : "/metering/point/demand/customer/update", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/UpdateDemandCustomerRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/UpdateDemandCustomerResponse" } } } } }, "/metering/point/demand/form/download" : { "post" : { "tags" : [ "metering_point_demand" ], "summary" : "Form Download Service", "description" : "This service downloads the IABF form of the multiple demand for the active demand period", "operationId" : "/metering/point/demand/form/download", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/DownloadFormRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/DownloadFormResponse" } } } } }, "/metering/point/demand/form/upload" : { "post" : { "tags" : [ "metering_point_demand" ], "summary" : "Form Upload Service", "description" : "This service uploads the IABF form of the multiple demand for the active demand period", "operationId" : "/metering/point/demand/form/upload", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/UploadFormRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/UploadFormResponse" } } } } }, "/metering/point/demand/list" : { "post" : { "tags" : [ "metering_point_demand" ], "summary" : "Metering Point Listing Service", "description" : "Lists demands of a metering point.", "operationId" : "/metering/point/demand/list", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/MeteringPointDemandQueryRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/MeteringPointDemandQueryResponse" } } } } }, "/metering/point/demand/validate" : { "post" : { "tags" : [ "metering_point_demand" ], "summary" : "Metering Point Demand Validation Service", "description" : "Validates the metering point demand.", "operationId" : "/metering/point/demand/validate", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/MeteringPointDemandCreateRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/MeteringPointDemandValidateResponse" } } } } }, "/profile/consumption/list" : { "post" : { "tags" : [ "profile" ], "summary" : "Profile Consumption Service", "description" : "This service lists profile consumption informations of specified meters.", "operationId" : "/profile/consumption/get", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Profile Consumption Request", "required" : true, "schema" : { "$ref" : "#/definitions/ProfileConsumptionGetRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/ProfileConsumptionResponse" } } } } }, "/profilefactors/list" : { "post" : { "tags" : [ "profilefactors" ], "summary" : "Profile Factor Listing Service", "description" : "This service returns profile factors by period.", "operationId" : "/profilefactors/list", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/ProfileFactorsQueryRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/ProfileFactorsQueryResponse" } } } } }, "/registration/customer/deactivate" : { "post" : { "tags" : [ "registration" ], "summary" : "Deactivate Customer Activity Service", "description" : "This service is used to deactivate customer activity.", "operationId" : "/registration/customer/deactivate", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/CustomerDeactiveRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/CustomerDeactiveResponse" } } } } }, "/registration/customer/get" : { "post" : { "tags" : [ "registration" ], "summary" : "Get Active Customer Service", "description" : "This service finds active customer based on specified metering point.", "operationId" : "/registration/customer/get/", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/CustomerGetRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/CustomerGetResponse" } } } } }, "/registration/customer/list" : { "post" : { "tags" : [ "registration" ], "summary" : "List Customer Service", "description" : "This service is used to list customer informations.", "operationId" : "/registration/customer/list/", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/CustomerQueryRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/CustomerQueryResponse" } } } } }, "/registration/customer/save" : { "post" : { "tags" : [ "registration" ], "summary" : "Save Customer Service", "description" : "This service is used to save customer informations.", "operationId" : "/registration/customer/save/", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/CustomerCreateRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/CustomerCreateResponse" } } } } }, "/registration/customer/search" : { "post" : { "tags" : [ "registration" ], "summary" : "Search Customer Service", "description" : "This service is used to list search customer informations by metering point information.", "operationId" : "/registration/customer/search/", "produces" : [ "application/json", "application/xml" ], "parameters" : [ { "in" : "body", "name" : "body", "required" : false, "schema" : { "$ref" : "#/definitions/CustomerSearchRequest" } }, { "name" : "ecms-service-ticket", "in" : "header", "description" : "CMS Service Ticket Header", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/CustomerSearchResponse" } } } } } }, "definitions" : { "Meter is read or not and past meter info" : { "type" : "object", "required" : [ "confVersion", "dataVersion", "isConfSupplyDeducSettlement", "isConfSupplySettlement", "isConfWithdDeducSettlement", "isConfWithdrawalSettlement", "isRead", "meterCity", "meterConsumption", "meterEic", "meterGeneration", "meterId", "meterLossyConsumption", "meterLossyGeneration", "meterName", "meterReadingCompany", "meterReadingCompanyEic", "readingType", "supplierOrganization", "supplierOrganizationEic", "term" ], "properties" : { "meterId" : { "type" : "integer", "format" : "int64", "description" : "Meter Id" }, "meterEic" : { "type" : "string", "description" : "Meter EIC" }, "meterName" : { "type" : "string", "description" : "Meter name" }, "meterCity" : { "type" : "string", "description" : "Meter's city" }, "term" : { "type" : "string", "format" : "date-time", "description" : "Meter term" }, "dataVersion" : { "type" : "string", "format" : "date-time", "description" : "Meter data version" }, "confVersion" : { "type" : "string", "format" : "date-time", "description" : "Meter configuration version" }, "meterConsumption" : { "type" : "number", "description" : "Meter's consumption value" }, "meterGeneration" : { "type" : "number", "description" : "Meter's generation value" }, "meterLossyConsumption" : { "type" : "number", "description" : "Meter's lossy consumption value" }, "meterLossyGeneration" : { "type" : "number", "description" : "Meter's lossy generation value" }, "readingType" : { "type" : "string", "description" : "Meter reading type", "enum" : [ "THREE_RATE", "HOURLY", "SINGLE_RATE" ] }, "supplierOrganization" : { "type" : "string", "description" : "Meter supplier" }, "meterReadingCompany" : { "type" : "string", "description" : "Meter reading company" }, "isConfWithdrawalSettlement" : { "type" : "boolean", "description" : "Info of If meter is attached to the related supplier's withdrawal settlement point", "default" : false }, "isConfSupplySettlement" : { "type" : "boolean", "description" : "Info of If meter is attached to the related supplier's supply settlement point", "default" : false }, "isConfWithdDeducSettlement" : { "type" : "boolean", "description" : "Info of If meter is attached to the related supplier's deducted withdrawal settlement point", "default" : false }, "isConfSupplyDeducSettlement" : { "type" : "boolean", "description" : "Info of If meter is attached to the related supplier's deducted supply settlement point", "default" : false }, "isRead" : { "type" : "boolean", "description" : "Meter is read or not", "default" : false }, "meterReadingCompanyEic" : { "type" : "string", "description" : "Meter reading company EIC" }, "supplierOrganizationEic" : { "type" : "string", "description" : "Meter supplier company EIC" } }, "description" : "Meter data configuration response" }, "QueryMeteringHourlyResponseData" : { "type" : "object", "required" : [ "consumption", "consumptionLineLF", "consumptionTransformerLF", "dataEffectiveDate", "generation", "generationLineLF", "generationTransformerLF", "lastVersion", "lossyConsumption", "lossyGeneration", "meterEffectiveDate", "meterEic", "version" ], "properties" : { "consumptionLineLF" : { "type" : "number", "description" : "Consumption value with line loss factor." }, "generationLineLF" : { "type" : "number", "description" : "Generation value with line loss factor." }, "consumptionTransformerLF" : { "type" : "number", "description" : "Consumption value with transformer line loss factor." }, "generationTransformerLF" : { "type" : "number", "description" : "Generation value with transformer line loss factor." }, "meterEic" : { "type" : "string", "example" : "40Z0000000007034", "description" : "Meter EIC" }, "meterEffectiveDate" : { "type" : "string", "format" : "date-time", "example" : "2016-05-01T00:00:00.000+0300", "description" : "Meter effective date." }, "dataEffectiveDate" : { "type" : "string", "format" : "date-time", "example" : "2016-05-01T00:00:00.000+0300", "description" : "Settlement effective date." }, "recordTime" : { "type" : "string", "format" : "date-time", "example" : "2016-05-01T00:00:00.000+0300", "description" : "Record Time." }, "generation" : { "type" : "number", "description" : "Meter's generation value." }, "consumption" : { "type" : "number", "description" : "Meter's consumption value." }, "lossyConsumption" : { "type" : "number", "description" : "Meter's lossy consumption value." }, "lossyGeneration" : { "type" : "number", "description" : "Meter's lossy generation value." }, "version" : { "type" : "string", "format" : "date-time", "description" : "Meter version." }, "lastVersion" : { "type" : "string", "format" : "date-time", "description" : "Meter's last version." } }, "description" : "It keeps hourly meter info." }, "MeteringDataTotal" : { "type" : "object", "required" : [ "consumption", "generation", "lossyConsumption", "lossyGeneration", "meterEffectiveDate", "meterEic", "version" ], "properties" : { "meterEic" : { "type" : "string", "example" : "40Z0000000007034", "description" : "Meter EIC" }, "meterEffectiveDate" : { "type" : "string", "format" : "date-time", "example" : "2016-05-01T00:00:00.000+0300", "description" : "Meter effective date." }, "consumption" : { "type" : "number", "description" : "Meter's consumption value." }, "generation" : { "type" : "number", "description" : "Meter's generation value." }, "lossyConsumption" : { "type" : "number", "description" : "Meter's lossy consumption value." }, "lossyGeneration" : { "type" : "number", "description" : "Meter's lossy generation value." }, "version" : { "type" : "string", "format" : "date-time", "description" : "Meter version" } }, "description" : "Meter Info List", "xml" : { "name" : "meteringDataTotal" } }, "ProfileConsumption" : { "type" : "object", "properties" : { "profileDataId" : { "type" : "integer", "format" : "int64", "description" : "Consumption information Id." }, "meterId" : { "type" : "integer", "format" : "int64", "description" : "Meter Id." }, "meterEic" : { "type" : "string", "description" : "Meter EIC." }, "meterEffectiveDate" : { "type" : "string", "format" : "date-time", "description" : "Meter Date Period." }, "dayTimeConsumption" : { "type" : "number", "description" : "Day time consumption value." }, "peakConsumption" : { "type" : "number", "description" : "Peak time consumption value." }, "nightTimeConsumption" : { "type" : "number", "description" : "night time consumption value." }, "dataEffectiveDate" : { "type" : "string", "format" : "date-time", "description" : "Meter Date Period. Same with meterEffectiveDate." }, "generaldistributionLossFactor" : { "type" : "number", "description" : "Distribution loss factor applied to all consumption values." }, "dayTimeLineLossFactor" : { "type" : "number", "description" : "Line loss factor applied to day time consumption value." }, "peakTimeLineLossFactor" : { "type" : "number", "description" : "Line loss factor applied to peak time consumption value." }, "nightTimeLineLossFactor" : { "type" : "number", "description" : "Line loss factor applied to night time consumption value." }, "dayTimeLossyConsumption" : { "type" : "number", "description" : "Lossy net value after all lossfactors applied to day time consumption value(KWH)." }, "peakTimeLossyConsumption" : { "type" : "number", "description" : "Lossy net value after all lossfactors applied to peak time consumption value(KWH)." }, "nightTimeLossyConsumption" : { "type" : "number", "description" : "Lossy net value after all lossfactors applied to night time consumption value(KWH)." }, "profileDataVersion" : { "type" : "string", "format" : "date-time", "description" : "Version information." }, "lastVersion" : { "type" : "string", "format" : "date-time", "description" : "In case of multiple meter records for same period this field is used to find latest record. (If lastVersion is 01/01/2100 it means these are incorrect datas)" }, "dayTimeTransformerLossFactor" : { "type" : "number", "description" : "Transformer loss factor applied to day time consumption value." }, "peakTimeTransformerLossFactor" : { "type" : "number", "description" : "Transformer loss factor applied to peak time consumption value." }, "nightTimeTransformerLossFactor" : { "type" : "number", "description" : "Transformer loss factor applied to night time consumption value." } }, "description" : "Consumption informations.", "xml" : { "name" : "profileConsumption" } }, "ActiveCustomer" : { "type" : "object", "required" : [ "eic" ], "properties" : { "eic" : { "type" : "string", "description" : "It keeps meter EIC." }, "category" : { "type" : "string", "description" : "Customer category", "enum" : [ "NATURAL", "PUBLIC", "PRIVATE", "CORPORATION", "FOREIGN" ] }, "customerNo" : { "type" : "string", "description" : "Customer no" }, "title" : { "type" : "string", "description" : "Customer title" }, "authorizedPersonName" : { "type" : "string", "description" : "Authorized Person name" }, "authorizedPersonNo" : { "type" : "string", "description" : "Authorized Person no" }, "authorizedPersonName2" : { "type" : "string", "description" : "Authorized Person2 name" }, "authorizedPersonNo2" : { "type" : "string", "description" : "Authorized Person2 no" }, "resultType" : { "type" : "string", "description" : "Operation Result type", "enum" : [ "SUCCESS", "FAILED" ] }, "resultDescription" : { "type" : "string", "description" : "Operation Result description" } }, "description" : "Get Active Customer Service Response Body" }, "BooleanResponse" : { "type" : "object" }, "ChangedSupplierMeterListResponse" : { "type" : "object", "properties" : { "queryInformation" : { "description" : "Keeps how many record exist in the service response and range values.", "$ref" : "#/definitions/QueryInformation" }, "changedSupplierMeterListResponse" : { "type" : "array", "items" : { "$ref" : "#/definitions/ChangedSupplierMeterResponse" } } } }, "ChangedSupplierMeterResponse" : { "type" : "object", "properties" : { "newMeterId" : { "type" : "integer", "format" : "int64", "description" : "New Meter's Id" }, "newMeterEic" : { "type" : "string", "description" : "New Meter's EIC" }, "newOrganizationEic" : { "type" : "string", "description" : "New Meter's Organization EIC" }, "oldOrganizationEic" : { "type" : "string", "description" : "Old Meter's Organization EIC" }, "newCustomerNo" : { "type" : "string", "description" : "New Customer No" }, "newMeterName" : { "type" : "string", "description" : "New Meter's Name" }, "newMeterAddress" : { "type" : "string", "description" : "New Meter's Address" }, "newMeterCountyId" : { "type" : "integer", "format" : "int64", "description" : "New Meter's Country Id" }, "newMeterReadingType" : { "type" : "integer", "format" : "int64", "description" : "New Meter's Reading Type" }, "newMeterReadingTypeEnum" : { "type" : "string", "example" : "THREE_RATE(1L), HOURLY(2L), SINGLE_RATE(3L)", "description" : "New Meter' s Reading Type as Enum", "enum" : [ "THREE_RATE", "HOURLY", "SINGLE_RATE" ] }, "newProfileSubscriptionGroup" : { "type" : "integer", "format" : "int64", "description" : "New Meter's Subscription Group" }, "newAverageAnnualConsumption" : { "type" : "number", "description" : "New Meter's Average Annual Consumption" }, "newDistributionMeterCode" : { "type" : "string", "description" : "New Meter's Distribution Meter Code" }, "newprofileSubscriptionGroupName" : { "type" : "string", "description" : "New Meter's Subscription Group Name" }, "newCity" : { "type" : "string", "description" : "New Meter's City" }, "oldOrganizationCode" : { "type" : "string", "description" : "Old Meter's Organization Code" }, "newOrganizationCode" : { "type" : "string", "description" : "New Meter's Organization Code" } } }, "ChangedSupplierMeterServiceResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "It keeps the response body info of meters whose supplier is changed.", "$ref" : "#/definitions/ChangedSupplierMeterListResponse" } }, "description" : "It keeps the response info of meters whose supplier is changed." }, "Customer" : { "type" : "object", "required" : [ "category", "customerNo", "title" ], "properties" : { "customerId" : { "type" : "integer", "format" : "int64", "description" : "Customer id" }, "category" : { "type" : "string", "description" : "Customer category", "enum" : [ "NATURAL", "PUBLIC", "PRIVATE", "CORPORATION", "FOREIGN" ] }, "customerNo" : { "type" : "string", "description" : "Customer no" }, "organization" : { "type" : "string", "description" : "Organization" }, "title" : { "type" : "string", "description" : "Customer title" }, "actions" : { "type" : "array", "description" : "Customer activities", "items" : { "$ref" : "#/definitions/CustomerAction" } } }, "description" : "Queried Customer informations" }, "CustomerAction" : { "type" : "object", "properties" : { "moveId" : { "type" : "integer", "format" : "int64", "description" : "Customer move id" }, "meteringPointId" : { "type" : "integer", "format" : "int64", "description" : "Metering Point id" }, "meteringPointEic" : { "type" : "string", "description" : "Metering Point Eic" }, "startDate" : { "type" : "string", "format" : "date", "example" : "2016-09-01", "description" : "Customer activity start date" }, "endDate" : { "type" : "string", "format" : "date", "example" : "2016-09-01", "description" : "Customer activity end date" }, "status" : { "type" : "string", "description" : "Abone activity status.", "enum" : [ "ACTIVE", "PASSIVE", "ALL" ] }, "authorizedPersonName" : { "type" : "string", "description" : "Authorized Person name" }, "authorizedPersonNo" : { "type" : "string", "description" : "Authorized Person no" }, "authorizedPersonName2" : { "type" : "string", "description" : "Authorized Person2 name" }, "authorizedPersonNo2" : { "type" : "string", "description" : "Authorized Person2 no" }, "addedUser" : { "type" : "string", "description" : "Customer activity added user" }, "addedTime" : { "type" : "string", "format" : "date-time", "description" : "Customer activity added time" } }, "description" : "Customer activities" }, "CustomerCreate" : { "type" : "object", "required" : [ "category", "customerNo", "title" ], "properties" : { "meteringPointId" : { "type" : "integer", "format" : "int64", "description" : "Metering Point id" }, "meterEic" : { "type" : "string", "example" : "40Z0000000007034", "description" : "It keeps meter EIC." }, "customerNo" : { "type" : "string", "description" : "Customer no" }, "category" : { "type" : "string", "description" : "Customer category", "enum" : [ "NATURAL", "PUBLIC", "PRIVATE", "CORPORATION", "FOREIGN" ] }, "moveId" : { "type" : "integer", "format" : "int64", "description" : "Customer move id" }, "startDate" : { "type" : "string", "format" : "date", "example" : "2016-09-01", "description" : "Customer activity start date" }, "endDate" : { "type" : "string", "format" : "date", "example" : "2016-09-01", "description" : "Customer activity end date" }, "title" : { "type" : "string", "description" : "Customer title" }, "authorizedPersonName" : { "type" : "string", "description" : "Authorized Person name" }, "authorizedPersonNo" : { "type" : "string", "description" : "Authorized Person no" }, "authorizedPersonName2" : { "type" : "string", "description" : "Authorized Person2 name" }, "authorizedPersonNo2" : { "type" : "string", "description" : "Authorized Person2 no" }, "formStatus" : { "type" : "boolean", "description" : "It keeps bilateral declaration form status. false: not approved, true: approved.", "default" : false } }, "description" : "Customer informations which will be saved." }, "CustomerCreateDataList" : { "type" : "object", "properties" : { "customers" : { "type" : "array", "description" : "Customer informations which will be saved.", "items" : { "$ref" : "#/definitions/CustomerCreate" } } } }, "CustomerCreateRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/CustomerCreateDataList" } }, "description" : "Customer Create Service Request." }, "CustomerCreateResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "Customer Create Service Response body.", "$ref" : "#/definitions/CustomerCreateResponseDataList" } }, "description" : "Customer Create Service Response." }, "CustomerCreateResponseDataList" : { "type" : "object", "properties" : { "results" : { "type" : "array", "description" : "Saved Customer informations.", "items" : { "$ref" : "#/definitions/CustomerCreateResult" } } } }, "CustomerCreateResult" : { "type" : "object", "required" : [ "category", "customerNo" ], "properties" : { "customerNo" : { "type" : "string", "description" : "Customer no" }, "category" : { "type" : "string", "description" : "Customer category", "enum" : [ "NATURAL", "PUBLIC", "PRIVATE", "CORPORATION", "FOREIGN" ] }, "meteringPointId" : { "type" : "integer", "format" : "int64", "description" : "Metering Point id" }, "resultStatus" : { "type" : "string", "description" : "Operation Result", "enum" : [ "SUCCESS", "FAILED", "DUPLICATE" ] }, "moveId" : { "type" : "integer", "format" : "int64", "description" : "Customer move id" }, "description" : { "type" : "string", "description" : "Operations Failure Result Reason" } }, "description" : "Saved Customer informations." }, "CustomerDeactiveDataList" : { "type" : "object", "properties" : { "moveIds" : { "type" : "array", "description" : "Customer Activites which will be deactivated.", "items" : { "$ref" : "#/definitions/Move" } } } }, "CustomerDeactiveRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/CustomerDeactiveDataList" } }, "description" : "Customer Activity Deactivate Service Request " }, "CustomerDeactiveResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "Customer Deactivate Service Response body", "$ref" : "#/definitions/CustomerDeactiveResponseDataList" } }, "description" : "Customer Deactivate Service Response" }, "CustomerDeactiveResponseDataList" : { "type" : "object", "properties" : { "results" : { "type" : "array", "description" : "Deactivated Customer activities.", "items" : { "$ref" : "#/definitions/CustomerDeactiveResult" } } } }, "CustomerDeactiveResult" : { "type" : "object", "required" : [ "category", "customerNo" ], "properties" : { "moveId" : { "type" : "integer", "format" : "int64", "description" : "Customer move id" }, "customerNo" : { "type" : "string", "description" : "Customer no" }, "category" : { "type" : "string", "description" : "Customer category", "enum" : [ "NATURAL", "PUBLIC", "PRIVATE", "CORPORATION", "FOREIGN" ] }, "meteringPointId" : { "type" : "integer", "format" : "int64", "description" : "Metering Point id" }, "startDate" : { "type" : "string", "format" : "date", "example" : "2016-09-01", "description" : "Customer activity start date" }, "endDate" : { "type" : "string", "format" : "date", "example" : "2016-09-01", "description" : "Customer activity end date" }, "resultStatus" : { "type" : "string", "description" : "Operation Result", "enum" : [ "SUCCESS", "FAILED", "DUPLICATE" ] }, "description" : { "type" : "string", "description" : "Operations Failure Result Reason" } }, "description" : "Customer Activites which will be deactivated." }, "CustomerGet" : { "type" : "object", "required" : [ "eic" ], "properties" : { "eic" : { "type" : "string", "description" : "Metering Point EIC" } }, "description" : "Get Active Customer Service Request Informations" }, "CustomerGetDataList" : { "type" : "object", "required" : [ "eics" ], "properties" : { "eics" : { "type" : "array", "description" : "Get Active Customer Service Request Informations", "items" : { "$ref" : "#/definitions/CustomerGet" } } } }, "CustomerGetRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/CustomerGetDataList" } }, "description" : "Get Active Customer Service Request Informations" }, "CustomerGetResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "Listed customer informations", "$ref" : "#/definitions/CustomerGetResponseDataList" } }, "description" : "Get Active Customer Service Response Informations" }, "CustomerGetResponseDataList" : { "type" : "object", "properties" : { "customers" : { "type" : "array", "description" : "Listed customer informations", "items" : { "$ref" : "#/definitions/ActiveCustomer" } } } }, "CustomerQuery" : { "type" : "object", "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "meteringPointId" : { "type" : "integer", "format" : "int64", "description" : "Metering Point id" }, "meterEic" : { "type" : "string", "example" : "40Z0000000007034", "description" : "It keeps meter EIC." }, "customerNo" : { "type" : "string", "description" : "Customer no" }, "category" : { "type" : "string", "description" : "Customer category", "enum" : [ "NATURAL", "PUBLIC", "PRIVATE", "CORPORATION", "FOREIGN" ] }, "status" : { "type" : "string", "description" : "Abone activity status.", "enum" : [ "ACTIVE", "PASSIVE", "ALL" ] }, "moveId" : { "type" : "integer", "format" : "int64", "description" : "Customer move id" } }, "description" : "Customer List Service Request" }, "CustomerQueryRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/CustomerQuery" } }, "description" : "Customer List Service Request" }, "CustomerQueryResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "Customer List Service Response body.", "$ref" : "#/definitions/CustomerQueryResponseDataList" } }, "description" : "Customer List Service Response" }, "CustomerQueryResponseDataList" : { "type" : "object", "properties" : { "queryInformation" : { "description" : "Keeps how many record exist in the service response and range values.", "$ref" : "#/definitions/QueryInformation" }, "customers" : { "type" : "array", "description" : "Queried Customer informations", "items" : { "$ref" : "#/definitions/Customer" } } } }, "CustomerSearch" : { "type" : "object", "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "meteringPointId" : { "type" : "integer", "format" : "int64", "description" : "Metering Point id" }, "meteringPointEic" : { "type" : "string", "description" : "It keeps meter EIC." }, "meteringPointUid" : { "type" : "string", "description" : "Distribution Meter Code" }, "registrationStartDate" : { "type" : "string", "format" : "date", "example" : "2016-09-01", "description" : "Customer activity start date" }, "registrationEndDate" : { "type" : "string", "format" : "date", "example" : "2016-09-01", "description" : "Customer activity end date" }, "registrationActivityRecordDate" : { "type" : "string", "format" : "date", "example" : "2016-09-01", "description" : "Customer activity added time" }, "registrationActivityRecordStartDate" : { "type" : "string", "format" : "date", "example" : "2016-09-01", "description" : "Customer activity added start time" }, "registrationActivityRecordEndDate" : { "type" : "string", "format" : "date", "example" : "2016-09-01", "description" : "Customer activity added end time" }, "isRegistrationEndDateNull" : { "type" : "boolean", "description" : "to query null customer activity end date", "default" : false } }, "description" : "Customer List Service Request" }, "CustomerSearchModel" : { "type" : "object", "properties" : { "customerMovementId" : { "type" : "integer", "format" : "int64", "description" : "#{CUSTOMER_MOVEMENTID}" }, "meteringPointId" : { "type" : "integer", "format" : "int64", "description" : "Metering Point id" }, "meteringPointEic" : { "type" : "string", "description" : "Metering Point Eic" }, "meteringPointUid" : { "type" : "string", "description" : "#{CUSTOMER_METERINGPOINTUID}" }, "registrationStartDate" : { "type" : "string", "format" : "date", "example" : "2016-09-01", "description" : "Customer activity start date" }, "registrationEndDate" : { "type" : "string", "format" : "date", "example" : "2016-09-01", "description" : "Customer activity end date" }, "registrationStatus" : { "type" : "string", "description" : "Abone activity status.", "enum" : [ "ACTIVE", "PASSIVE" ] }, "registrationTitle" : { "type" : "string", "description" : "Customer title" }, "registrationActivityRecordDate" : { "type" : "string", "format" : "date", "example" : "2016-09-01", "description" : "Customer activity added time" }, "customerNo" : { "type" : "string", "description" : "Customer no" }, "category" : { "type" : "string", "description" : "Customer category", "enum" : [ "NATURAL", "PUBLIC", "PRIVATE", "CORPORATION", "FOREIGN" ] }, "authorizedPersonName" : { "type" : "string", "description" : "Authorized Person name" }, "authorizedPersonNo" : { "type" : "string", "description" : "Authorized Person no" }, "authorizedPersonName2" : { "type" : "string", "description" : "Authorized Person2 name" }, "authorizedPersonNo2" : { "type" : "string", "description" : "Authorized Person2 no" } }, "description" : "Searched Customer informations" }, "CustomerSearchRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/CustomerSearch" } }, "description" : "Customer List Service Request" }, "CustomerSearchResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "Customer Search Service Response body.", "$ref" : "#/definitions/CustomerSearchResponseDataList" } }, "description" : "Customer Search Service Response" }, "CustomerSearchResponseDataList" : { "type" : "object", "properties" : { "queryInformation" : { "description" : "Keeps how many record exist in the service response and range values.", "$ref" : "#/definitions/QueryInformation" }, "customers" : { "type" : "array", "description" : "Searched Customer informations", "items" : { "$ref" : "#/definitions/CustomerSearchModel" } } } }, "DeductedMeterListResponse" : { "type" : "object", "properties" : { "queryInformation" : { "description" : "Keeps how many record exist in the service response and range values.", "$ref" : "#/definitions/QueryInformation" }, "deductedMeterListResponse" : { "type" : "array", "items" : { "$ref" : "#/definitions/DeductedMeterResponse" } } } }, "DeductedMeterResponse" : { "type" : "object", "properties" : { "meterId" : { "type" : "integer", "format" : "int64", "description" : "Meter Id" }, "meterEffectiveDate" : { "type" : "string", "format" : "date-time", "description" : "Meter Effective Date" }, "meterEic" : { "type" : "string", "description" : "Meter EIC" }, "city" : { "type" : "string", "description" : "City" }, "meterSerialNo" : { "type" : "string", "description" : "Meter Serial No" }, "customerNo" : { "type" : "string", "description" : "Customer No" }, "meterName" : { "type" : "string", "description" : "Meter Name" }, "settlementPointId" : { "type" : "integer", "format" : "int64", "description" : "Settlement Point Id" }, "settlementPointName" : { "type" : "string", "description" : "Settlement Point Name" } } }, "DeductedMeterServiceResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "Portföye giren tenzil sayaçların response body bilgisini tutar.", "$ref" : "#/definitions/DeductedMeterListResponse" } }, "description" : "Portföye giren tenzil sayaçların response bilgisini tutar." }, "DemandResponseData" : { "type" : "object", "required" : [ "meteringPointId" ], "properties" : { "eic" : { "type" : "string", "description" : "It keeps meter EIC." }, "meteringPointId" : { "type" : "integer", "format" : "int64", "description" : "Meter Id" }, "demandPeriod" : { "type" : "string", "format" : "date-time", "description" : "It keeps term info." }, "demandType" : { "type" : "string", "description" : "It keeps demand type.", "enum" : [ "NEW", "SUPPLIER_CHANGED", "PORTFOLIO_OUT", "EVACUATION", "NEW_PRE_DECLARATION", "SUPPLIER_CHANGED_PRE_DECLARATION", "PORTFOLIO_OUT_PRE_DECLARATION", "NEW_DEFINITE_DECLARATION", "SUPPLIER_CHANGED_DEFINITE_DECLARATION", "PORTFOLIO_OUT_DEFINITE_DECLARATION", "EVACUATION_DEFINITE_DECLARATION", "NEW_MULTIPLE", "SUPPLIER_CHANGED_MULTIPLE", "METERING_POINT_PASSIVE", "AUTO" ] }, "demandStatus" : { "type" : "string", "description" : "It keeps demand's status. ACTIVE, PASSIVE.", "enum" : [ "ACTIVE", "PASSIVE" ] }, "demandAddingDate" : { "type" : "string", "format" : "date-time", "description" : "#{METERING_POINT_DEMAND_ADDING_DATE}" }, "demandOrganization" : { "type" : "string", "description" : "#{METERING_POINT_DEMAND_ORGANIZATION}" }, "description" : { "type" : "string", "description" : "Ölçüm noktas?n?n kaydedilmemesi durumunda ald??? hatan?n aç?klama bilgisini tutar." }, "status" : { "type" : "string", "description" : "Ölçüm noktas?n?n kaydedilme durum bilgisini tutar.", "enum" : [ "SUCCESS", "VALIDATION_ERROR", "DUPLICATE", "FAILED" ] } }, "description" : "Metering Point Demand Informations", "xml" : { "name" : "demandResponseData" } }, "DemandResponseDataList" : { "type" : "object", "properties" : { "demands" : { "type" : "array", "description" : "Metering Point Demand Informations", "items" : { "$ref" : "#/definitions/DemandResponseData" } } } }, "DownloadFormRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/DownloadFormRequestModel" } }, "description" : "Form Download Request" }, "DownloadFormRequestModel" : { "type" : "object", "required" : [ "demandPeriod", "meteringPointEic" ], "properties" : { "meteringPointEic" : { "type" : "string", "description" : "It keeps meter EIC." }, "demandPeriod" : { "type" : "string", "format" : "date-time", "example" : "2016-05-01T00:00:00.000+0300", "description" : "It keeps term info." } }, "description" : "Form Download Request Body" }, "DownloadFormResponse" : { "type" : "object", "required" : [ "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "$ref" : "#/definitions/DownloadFormResponseModel" } } }, "DownloadFormResponseModel" : { "type" : "object", "properties" : { "meteringPointEic" : { "type" : "string", "description" : "It keeps meter EIC." }, "demandPeriod" : { "type" : "string", "format" : "date-time", "description" : "It keeps term info." }, "fileName" : { "type" : "string", "description" : "File Name" }, "fileContent" : { "type" : "string", "description" : "File Content as Base64 Format" } }, "description" : "Form Download Response Data", "xml" : { "name" : "downloadFormResponseModel" } }, "EligibleCustomerReportList" : { "type" : "object", "required" : [ "averageAnnualConsumption", "customerNo", "distributionMeterCode", "meterEic", "meterId", "meterName" ], "properties" : { "meterId" : { "type" : "integer", "format" : "int64", "description" : "Meter Id" }, "meterEic" : { "type" : "string", "description" : "Meter EIC" }, "distributionMeterCode" : { "type" : "string", "description" : "Distribution Meter Code" }, "customerNo" : { "type" : "string", "description" : "Customer No" }, "meterName" : { "type" : "string", "description" : "Meter Name" }, "averageAnnualConsumption" : { "type" : "number", "description" : "Average Annual Consumption" }, "category" : { "type" : "string", "enum" : [ "NATURAL", "PUBLIC", "PRIVATE", "CORPORATION", "FOREIGN" ] }, "title" : { "type" : "string" }, "authorizedPersonName" : { "type" : "string" }, "authorizedPersonNo" : { "type" : "string" }, "authorizedPersonName2" : { "type" : "string" }, "authorizedPersonNo2" : { "type" : "string" }, "profileSubscriptionGroup" : { "type" : "string" }, "readingTypeId" : { "type" : "integer", "format" : "int64" }, "tariffClass" : { "type" : "string", "enum" : [ "SINGLE_TERM", "DOUBLE_TERM" ] }, "meterReadingCompany" : { "type" : "string" }, "city" : { "type" : "string" }, "demandType" : { "type" : "string" }, "demandTypeEnum" : { "type" : "string", "enum" : [ "NEW", "SUPPLIER_CHANGED", "PORTFOLIO_OUT", "EVACUATION", "NEW_PRE_DECLARATION", "SUPPLIER_CHANGED_PRE_DECLARATION", "PORTFOLIO_OUT_PRE_DECLARATION", "NEW_DEFINITE_DECLARATION", "SUPPLIER_CHANGED_DEFINITE_DECLARATION", "PORTFOLIO_OUT_DEFINITE_DECLARATION", "EVACUATION_DEFINITE_DECLARATION", "NEW_MULTIPLE", "SUPPLIER_CHANGED_MULTIPLE", "METERING_POINT_PASSIVE", "AUTO" ] }, "readingType" : { "type" : "string", "enum" : [ "THREE_RATE", "HOURLY", "SINGLE_RATE" ] }, "profileSubscriptionGroupId" : { "type" : "integer", "format" : "int64" } } }, "EligibleCustomerReportRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/GetEligibileCustomerReport" } } }, "EligibleCustomerReportResponse" : { "type" : "object", "required" : [ "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "$ref" : "#/definitions/EligibleCustomerReportResponseBody" } }, "description" : "Free Consumer's Portfolio List" }, "EligibleCustomerReportResponseBody" : { "type" : "object", "required" : [ "eligibleCustomerReportLists", "listType", "reportType" ], "properties" : { "queryInformation" : { "description" : "Keeps how many record exist in the service response and range values.", "$ref" : "#/definitions/QueryInformation" }, "eligibleCustomerReportLists" : { "type" : "array", "description" : "Free consumers info that goes in and out to portfolio.", "items" : { "$ref" : "#/definitions/EligibleCustomerReportList" } }, "reportType" : { "type" : "string", "description" : "Portfolio status (Goes In / Goes Out) of the free consumer that returns as a response..", "enum" : [ "ENTERING_PORTFOLIO_ELIGIBLE_CUSTOMER", "OUTGOING_PORTFOLIO_ELIGIBLE_CUSTOMER", "PORTFOLIO_ELIGIBLE_CUSTOMER" ] }, "listType" : { "type" : "string", "description" : "Pre/Final List Status of a free consumer that returns as a response.", "enum" : [ "PRE_LIST", "EXACT_LIST" ] } } }, "EvacuationCancelRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Request Body of Evacuation Request Cancellation", "$ref" : "#/definitions/EvacuationCancelRequestBody" } }, "description" : "Request of Evacuation Request Cancellation" }, "EvacuationCancelRequestBody" : { "type" : "object", "properties" : { "evacuationCancelRequestKeys" : { "type" : "array", "description" : "List of Evacuation Requests that is going to be updated.", "items" : { "$ref" : "#/definitions/EvacuationCancelRequestKey" } } }, "description" : "Request Body of Evacuation Request Cancellation" }, "EvacuationCancelRequestKey" : { "type" : "object", "properties" : { "meteringPointId" : { "type" : "integer", "format" : "int64", "description" : "Meter Id for updating evacuation request." } }, "description" : "Info of the Evacuation Request that is going to be updated." }, "EvacuationCancelResponse" : { "type" : "object", "required" : [ "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "Response body of evacuation request update.", "$ref" : "#/definitions/EvacuationCancelResponseBody" } }, "description" : "Response of evacuation request update." }, "EvacuationCancelResponseBody" : { "type" : "object", "properties" : { "evacuationCancelResponseResults" : { "type" : "array", "description" : "List of records which evacuation request has been made.", "items" : { "$ref" : "#/definitions/EvacuationCancelResponseResult" } } }, "description" : "Response body of evacuation request update." }, "EvacuationCancelResponseResult" : { "type" : "object", "properties" : { "meteringPointId" : { "type" : "integer", "format" : "int64", "description" : "Meter Id for updating evacuation request." }, "state" : { "type" : "string", "description" : "Description text for result of evacuation request update." } }, "description" : "Result of evacuation request update." }, "FactorByPeriod" : { "type" : "object", "properties" : { "period" : { "type" : "integer", "format" : "int32", "description" : "Period" }, "factor" : { "type" : "number", "description" : "Factor" } }, "description" : "Contains period and factor information." }, "GetChangedSupplierMetersRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Changed-Supplier Meters Request Model", "$ref" : "#/definitions/ListChangedSupplierMeters" } }, "description" : "Wrapper Request Model for Changed-Supplier Meters" }, "GetDeductedMetersRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Portföye Giren Tenzil Sayaçları Getiren İstek", "$ref" : "#/definitions/ListDeductedMetersRequest" } }, "description" : "Portföye Giren Sayaçların Kapsayıcı İstek Modeli" }, "GetEligibileCustomerReport" : { "type" : "object", "required" : [ "date", "listType", "reportType" ], "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "date" : { "type" : "string", "format" : "date-time", "description" : "The term that you want to query." }, "reportType" : { "type" : "string", "description" : "List of free consumers that goes in and out to portfolio.", "enum" : [ "ENTERING_PORTFOLIO_ELIGIBLE_CUSTOMER", "OUTGOING_PORTFOLIO_ELIGIBLE_CUSTOMER", "PORTFOLIO_ELIGIBLE_CUSTOMER" ] }, "listType" : { "type" : "string", "description" : "Pre/Final List Status of a free consumer.", "enum" : [ "PRE_LIST", "EXACT_LIST" ] } } }, "GetMeterCountRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Meter Count Request Model", "$ref" : "#/definitions/ListMeterCountRequest" } }, "description" : "Wrapper Request Model for Meter Count" }, "GetMeterEicRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Meter EIC Request Model", "$ref" : "#/definitions/ListMeterEicRequest" } }, "description" : "Wrapper Request Model for Listing Meter EIC With Range" }, "GetMeteringPointsRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Metering Point Request Model (Fill either meter id or meter eic)", "$ref" : "#/definitions/ListMeteringPointsRequest" } }, "description" : "Wrapper Request Model for Listing Meters" }, "GetNewMeteringPointsRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "New Metering Points To Be Read Request Model", "$ref" : "#/definitions/ListNewMeteringPointsToBeRead" } }, "description" : "Wrapper Request Model for New Metering Points To Be Read" }, "GetNonobligatoryToReadMetersRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Non-obligatory To Read Meters Request Model", "$ref" : "#/definitions/ListNonobligatoryToReadMetersRequest" } }, "description" : "Wrapper Request Model for Non-obligatory To Read Meters" }, "GetReturnedToSupplierMetersRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Returned-To-Supplier Meters Request Model", "$ref" : "#/definitions/ListReturnedToSupplierMeters" } }, "description" : "Wrapper Request Model for Returned-To-Supplier Meters" }, "Header" : { "type" : "object", "properties" : { "key" : { "type" : "string", "example" : "transactionId", "description" : "Keeps header key information." }, "value" : { "type" : "string", "example" : "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac", "description" : "Keeps header value information." } }, "description" : "Keeps request header informations." }, "ListChangedSupplierMeters" : { "type" : "object", "required" : [ "listType", "term" ], "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "term" : { "type" : "string", "format" : "date-time", "description" : "Meter Term" }, "listType" : { "type" : "string", "description" : "Ön liste veya kesin liste durumunu belirtir. PRE_LIST:Ön Liste , EXACT_LIST = Kesin Liste", "enum" : [ "PRE_LIST", "EXACT_LIST" ] } }, "description" : "Changed-Supplier Meters Request Model" }, "ListDeductedMetersRequest" : { "type" : "object", "required" : [ "term" ], "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "term" : { "type" : "string", "format" : "date-time", "description" : "Meter Term" } }, "description" : "Portföye Giren Tenzil Sayaçları Getiren İstek" }, "ListMeterCountRequest" : { "type" : "object", "required" : [ "countType", "term" ], "properties" : { "term" : { "type" : "string", "format" : "date-time", "description" : "Meter Term" }, "countType" : { "type" : "string", "description" : "Meter Count Type Request Model", "enum" : [ "RELATED", "PORTFOLIO" ] } }, "description" : "Meter Count Request Model" }, "ListMeterEicRequest" : { "type" : "object", "required" : [ "term" ], "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "term" : { "type" : "string", "format" : "date-time", "description" : "Meter Term" } }, "description" : "Meter EIC Request Model" }, "ListMeteringPointsRequest" : { "type" : "object", "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "meterId" : { "type" : "integer", "format" : "int64", "description" : "Meter Id." }, "meterEIC" : { "type" : "string", "description" : "Meter EIC." }, "meterDistributionCode" : { "type" : "string", "description" : "Distribution Meter Code." }, "eligibleConsumptionType" : { "type" : "string", "description" : "Eligible Consumption Type", "enum" : [ "ELIGIBLE_CONSUMER", "NO_ELIGIBLE_CONSUMER", "ORGANIZED_INDUSTRIAL_ZONE_EC" ] }, "meterUsageState" : { "type" : "string", "description" : "Meter usage state", "enum" : [ "NO_CONSUMER", "IN_USE" ] }, "supplierType" : { "type" : "string", "description" : "Ölçüm noktası tedarik tipi.", "enum" : [ "END_USE_SUPPLIER", "BILATERAL_CONTRACT", "RETAIL_SALE", "NONE" ] }, "meterEffectiveDate" : { "type" : "string", "format" : "date-time", "example" : "2016-05-01T00:00:00.000+0300", "description" : "Eligible Consumption Type effective period" } }, "description" : "Metering Point Request Model (Fill either meter id or meter eic)" }, "ListNewMeteringPointsToBeRead" : { "type" : "object", "required" : [ "listType", "meterEic", "term" ], "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "listType" : { "type" : "string", "description" : "Ön liste veya kesin liste durumunu belirtir. PRE_LIST:Ön Liste , EXACT_LIST = Kesin Liste", "enum" : [ "PRE_LIST", "EXACT_LIST" ] }, "term" : { "type" : "string", "format" : "date-time", "description" : "Meter Term" }, "meterEic" : { "type" : "string", "description" : "Meter EIC" } }, "description" : "New Metering Points To Be Read Request Model" }, "ListNonobligatoryToReadMetersRequest" : { "type" : "object", "required" : [ "listType", "meterEic", "term" ], "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "term" : { "type" : "string", "format" : "date-time", "description" : "Meter Term" }, "meterEic" : { "type" : "string", "description" : "Meter EIC" }, "listType" : { "type" : "string", "description" : "Ön liste veya kesin liste durumunu belirtir. PRE_LIST:Ön Liste , EXACT_LIST = Kesin Liste", "enum" : [ "PRE_LIST", "EXACT_LIST" ] } }, "description" : "Non-obligatory To Read Meters Request Model" }, "ListReturnedToSupplierMeters" : { "type" : "object", "required" : [ "listType", "term" ], "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "term" : { "type" : "string", "format" : "date-time", "description" : "Meter Term" }, "listType" : { "type" : "string", "description" : "Ön liste veya kesin liste durumunu belirtir. PRE_LIST:Ön Liste , EXACT_LIST = Kesin Liste", "enum" : [ "PRE_LIST", "EXACT_LIST" ] } }, "description" : "Returned-To-Supplier Meters Request Model" }, "MeterCountListResponse" : { "type" : "object", "properties" : { "meterCountResponseList" : { "type" : "array", "items" : { "$ref" : "#/definitions/MeterCountResponse" } } } }, "MeterCountResponse" : { "type" : "object", "properties" : { "meterEffectiveDate" : { "type" : "string", "format" : "date-time", "description" : "It keeps Meter Effective Date." }, "readingType" : { "type" : "string", "description" : "It keeps Meter Reading Type.", "enum" : [ "THREE_RATE", "HOURLY", "SINGLE_RATE" ] }, "meterCount" : { "type" : "integer", "format" : "int32", "description" : "It keeps Meter Count." } } }, "MeterCountServiceResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "Service Response Body for Listing Meter Counts", "$ref" : "#/definitions/MeterCountListResponse" } }, "description" : "Service Response for Listing Meter Counts" }, "MeterDeducSettlementPoint" : { "type" : "object", "required" : [ "meterId", "period", "supplyDeductionSettlementPoint", "withDrawalDeducSettlementPoint" ], "properties" : { "meterId" : { "type" : "string", "description" : "Sayaç ETSO/ID Bilgisi" }, "period" : { "type" : "string", "format" : "date-time", "description" : "Sayaç Güncelleme Dönemi" }, "withDrawalDeducSettlementPoint" : { "type" : "string", "description" : "Çekiş UEVCB ID Bilgisi" }, "supplyDeductionSettlementPoint" : { "type" : "string", "description" : "Veriş UEVCB ID Bilgisi" } } }, "MeterDeducSettlementPointList" : { "type" : "object", "properties" : { "deducSettlementPoints" : { "type" : "array", "items" : { "$ref" : "#/definitions/MeterDeducSettlementPoint" } } } }, "MeterDeducSettlementPointListResponseBody" : { "type" : "object", "properties" : { "meterDeducSettlementPointResponses" : { "type" : "array", "items" : { "$ref" : "#/definitions/MeterDeducSettlementPointResponseBody" } } } }, "MeterDeducSettlementPointRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/MeterDeducSettlementPointList" } } }, "MeterDeducSettlementPointResponse" : { "type" : "object", "required" : [ "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "$ref" : "#/definitions/MeterDeducSettlementPointListResponseBody" } } }, "MeterDeducSettlementPointResponseBody" : { "type" : "object", "properties" : { "succes" : { "type" : "boolean", "default" : false }, "meterId" : { "type" : "string" }, "description" : { "type" : "string" } } }, "MeterEicInfoListResponse" : { "type" : "object", "properties" : { "queryInformation" : { "description" : "Keeps how many record exist in the service response and range values.", "$ref" : "#/definitions/QueryInformation" }, "meterEicInfoListResponse" : { "type" : "array", "items" : { "$ref" : "#/definitions/MeterEicInfoResponse" } } } }, "MeterEicInfoResponse" : { "type" : "object", "properties" : { "meterEic" : { "type" : "string", "description" : "Meter EIC" }, "readingType" : { "type" : "string", "description" : "Meter Reading Type", "enum" : [ "THREE_RATE", "HOURLY", "SINGLE_RATE" ] }, "meterId" : { "type" : "integer", "format" : "int64", "description" : "Meter Id" } } }, "MeterEicInfoServiceResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "It keeps the response body info of meter eic.", "$ref" : "#/definitions/MeterEicInfoListResponse" } }, "description" : "It keeps the response info of meter eic." }, "MeterInformationDataForSupplier" : { "type" : "object", "properties" : { "rn" : { "type" : "integer", "format" : "int32", "description" : "It keeps order number." }, "meterEic" : { "type" : "string", "description" : "It keeps Meter EIC info." }, "meterId" : { "type" : "integer", "format" : "int64", "description" : "It keeps meter Id info." }, "oldSupplierEic" : { "type" : "string", "description" : "Meter's supplier info at previous settlement term." }, "customerNo" : { "type" : "string", "description" : "It keeps Meter's Customer No." } }, "description" : "Response data for supplier meters EIC." }, "MeterInformationForSupplier" : { "type" : "object", "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "settlementPeriod" : { "type" : "string", "format" : "date-time", "example" : "2016-06-01T00:00:00.000+0300", "description" : "Settlement term that querying will be made." } }, "description" : "Request model for supplier Meter EIC." }, "MeterInformationForSupplierRequest" : { "type" : "object", "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "The field that keeps interval and settlement terms of requested meters. ", "$ref" : "#/definitions/MeterInformationForSupplier" } }, "description" : "Request model for querying meter EIC info for suppliers." }, "MeterInformationListForSupplier" : { "type" : "object", "properties" : { "queryInformation" : { "description" : "Keeps how many record exist in the service response and range values.", "$ref" : "#/definitions/QueryInformation" }, "datasForSupplier" : { "type" : "array", "description" : "Field that contains query response.", "items" : { "$ref" : "#/definitions/MeterInformationDataForSupplier" } } }, "description" : "Response Container Model for Supplier Meters EIC" }, "MeterInformationListForSupplierResponse" : { "type" : "object", "required" : [ "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "It keeps order no, EIC, id, old supplier and customer no of requested meters.", "$ref" : "#/definitions/MeterInformationListForSupplier" } }, "description" : "Response model for supplier meters EIC. " }, "MeteringDataAndConfigurationList" : { "type" : "object", "properties" : { "queryInformation" : { "description" : "Keeps how many record exist in the service response and range values.", "$ref" : "#/definitions/QueryInformation" }, "meterDatas" : { "type" : "array", "description" : "It keeps withdrawal/supply values and Past Meter info.", "items" : { "$ref" : "#/definitions/Meter is read or not and past meter info" } } } }, "MeteringDataAndConfigurationQueryResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "It keeps withdrawal/supply values and Past Meter info.", "$ref" : "#/definitions/MeteringDataAndConfigurationList" } }, "description" : "It keeps withdrawal/supply values and Past Meter info." }, "MeteringDataBulkResponse" : { "type" : "object", "required" : [ "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "$ref" : "#/definitions/MeteringDataBulkResponseBody" } }, "description" : "Çoklu yapılan saatlik sayaçların servisden dönen cevap bilgisini tutar." }, "MeteringDataBulkResponseBody" : { "type" : "object", "properties" : { "dataSaveResponse" : { "type" : "array", "items" : { "$ref" : "#/definitions/MeteringDataSaveResponse" } } } }, "MeteringDataConfigurationQuery" : { "type" : "object", "required" : [ "term" ], "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "term" : { "type" : "string", "format" : "date-time", "example" : "2016-05-01T00:00:00.000+0300", "description" : "Meter term" }, "meteringReadingType" : { "type" : "string", "description" : "Meter reading type (if all meters wanted, this field should be null)", "enum" : [ "THREE_RATE", "HOURLY", "SINGLE_RATE" ] }, "pastVersion" : { "type" : "boolean", "description" : "If past meters are going to be listed or not", "default" : false } }, "description" : "Request for Total Meter Withdrawal / Supply Service" }, "MeteringDataConfigurationQueryRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/MeteringDataConfigurationQuery" } }, "description" : "Request for listing meter's withdrawal/supply and past meters " }, "MeteringDataResponse" : { "type" : "object", "required" : [ "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "$ref" : "#/definitions/BooleanResponse" } } }, "MeteringDataSaveResponse" : { "type" : "object", "properties" : { "meterEic" : { "type" : "string", "description" : "Yükleme yapılan saatlik sayacın ETSO kodu." }, "description" : { "type" : "string", "description" : "Yükleme sırasında hata oluşmuş ise hatanın açıklaması." }, "status" : { "type" : "string", "description" : "Yapılan çoklu yüklemelerde işlemin başarılı olup olmadığı bilgisini tutar.", "enum" : [ "SUCCESS", "VALIDATION_ERROR", "DUPLICATE", "FAILED" ] }, "measurementUnit" : { "type" : "string", "description" : "Yükleme yapılan sayacın üretim/tüketim değerlerinin birimini gösterir.", "enum" : [ "KWH", "MWH" ] } } }, "MeteringDataTotalDataList" : { "type" : "object", "properties" : { "queryInformation" : { "description" : "Keeps how many record exist in the service response and range values.", "$ref" : "#/definitions/QueryInformation" }, "meteringDatas" : { "type" : "array", "description" : "Meter Info List", "items" : { "$ref" : "#/definitions/MeteringDataTotal" } } } }, "MeteringDataTotalQuery" : { "type" : "object", "required" : [ "date" ], "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "date" : { "type" : "string", "format" : "date-time", "example" : "2016-05-01T00:00:00.000+0300", "description" : "The date that meter info belongs to." }, "meterEics" : { "type" : "array", "example" : "40Z0000000007034", "description" : "Verisi istenen sayaçlara ait etso kod bilgisi.", "items" : { "type" : "string" } } }, "description" : "Request for Total Meter Withdrawal / Supply Service" }, "MeteringDataTotalQueryRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/MeteringDataTotalQuery" } }, "description" : "Request for Total Meter Withdrawal / Supply Service" }, "MeteringDataTotalQueryResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "Response Body for Total Meter Withdrawal / Supply Service", "$ref" : "#/definitions/MeteringDataTotalDataList" } }, "description" : "Response for Total Meter Withdrawal / Supply Service" }, "MeteringHourlyBulkDataList" : { "type" : "object", "properties" : { "hourlyDatas" : { "type" : "array", "items" : { "$ref" : "#/definitions/MeteringHourlyDataList" } } } }, "MeteringHourlyBulkDataRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/MeteringHourlyBulkDataList" } } }, "MeteringHourlyData" : { "type" : "object", "required" : [ "consumption", "generation", "period" ], "properties" : { "period" : { "type" : "integer", "format" : "int64", "description" : "Settlement term which meter info will be saved at. You can save new meter info for only open settlement term." }, "generation" : { "type" : "number", "description" : "Meter Generation Value" }, "consumption" : { "type" : "number", "description" : "Meter Consumption Value" } } }, "MeteringHourlyDataList" : { "type" : "object", "required" : [ "datas", "eic", "settlementPeriod" ], "properties" : { "settlementPeriod" : { "type" : "string", "format" : "date-time", "description" : "Settlement term which meter info will be saved at. You can save new meter info for only open settlement term." }, "eic" : { "type" : "string", "description" : "Meter EIC" }, "datas" : { "type" : "array", "description" : "Consumption and generation values which belongs to open settlement term.", "items" : { "$ref" : "#/definitions/MeteringHourlyData" } } } }, "MeteringHourlyDataRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/MeteringHourlyDataList" } } }, "MeteringInfo" : { "type" : "object", "properties" : { "meterId" : { "type" : "integer", "format" : "int64", "description" : "Meter Id." }, "meterEic" : { "type" : "string", "description" : "Meter EIC." }, "validityDate" : { "type" : "string", "format" : "date-time", "description" : "#{METERING_INFO_VALIDITY_DATE}" }, "version" : { "type" : "string", "format" : "date-time", "description" : "#{METERING_INFO_VERSION}" }, "customerNo" : { "type" : "string", "description" : "Meter Customer No." }, "serialNumber" : { "type" : "string", "description" : "Meter Serial No." }, "manufacturer" : { "type" : "string", "description" : "Meter Manufacturer Info." }, "meterName" : { "type" : "string", "description" : "Meter Name." }, "meterAddress" : { "type" : "string", "description" : "Meter Address." }, "cityId" : { "type" : "integer", "format" : "int64", "description" : "City Id." }, "county" : { "type" : "string", "description" : "County Id." }, "meteringType" : { "type" : "integer", "format" : "int64", "description" : "Metering Type." }, "transformerInputVoltage" : { "type" : "number", "description" : "Transformer Input Voltage." }, "transformerOutputVoltage" : { "type" : "number", "description" : "Transformer Output Voltage." }, "substation" : { "type" : "integer", "format" : "int64", "description" : "Transformer That Meter Belongs To." }, "connectionPointLocation" : { "type" : "integer", "format" : "int64", "description" : "Location info of metering point based on the transformer." }, "connectionPointLocationOther" : { "type" : "string", "description" : "Other location info of metering point based on the transformer." }, "meterReadingCompanyEic" : { "type" : "string", "description" : "Meter Reading Company EIC." }, "meteringVoltage" : { "type" : "integer", "format" : "int64", "description" : "Meter Connection Point Voltage." }, "meterUsageOfType" : { "type" : "integer", "format" : "int64", "description" : "Meter Usage Type." }, "profileType" : { "type" : "integer", "format" : "int64", "description" : "Meter Profile Type." }, "profileSubscriptionGroup" : { "type" : "integer", "format" : "int64", "description" : "Meter Subscription Group." }, "readingType" : { "type" : "integer", "format" : "int64", "description" : "Meter Reading Type." }, "busbarVoltage" : { "type" : "integer", "format" : "int64", "description" : "Meter's Busbar Voltage." }, "transmissionLossFactorStatus" : { "type" : "boolean", "description" : "Transmission Loss Factor Status.", "default" : false }, "withdrawalSettlementPointEic" : { "type" : "string", "description" : "Withdrawal Settlement Point EIC." }, "supplySettlementPointEic" : { "type" : "string", "description" : "Supply Settlement Point EIC." }, "tnzlWithdSettlementPointEic" : { "type" : "string", "description" : "Withdrawal Reduced Settlement Point EIC." }, "tnzlSupplySettlementPointEic" : { "type" : "string", "description" : "Supply Reduced Settlement Point EIC." }, "organizationEic" : { "type" : "string", "description" : "Meter's Organization EIC." }, "transformerPower" : { "type" : "number", "description" : "Transformer Power." }, "meterLossesType" : { "type" : "integer", "format" : "int64", "description" : "Meter Losses Type." }, "transformerLossFactorStatus" : { "type" : "boolean", "description" : "Transfer Loss Factor Status.", "default" : false }, "transLossFactorStatus" : { "type" : "boolean", "description" : "Line Loss Factor Status.", "default" : false }, "noLoadLoss" : { "type" : "number", "description" : "Loss On No-load." }, "loadLoss" : { "type" : "number", "description" : "Loss On Load." }, "lineLength" : { "type" : "number", "description" : "Meter's Line Length." }, "lineSection" : { "type" : "number", "description" : "Meter's Line Section." }, "lineCircuit" : { "type" : "integer", "format" : "int64", "description" : "Meter's Number of Circuits in Line." }, "temperatureCoefficient" : { "type" : "integer", "format" : "int64", "description" : "Meter's Conductor Resistance." }, "supplyPosition" : { "type" : "string", "description" : "Meter's Supply Position Name." }, "withdrawalPosition" : { "type" : "string", "description" : "Meter's Withdrawal Position Name." }, "profileGroupProfileType" : { "type" : "integer", "format" : "int64", "description" : "Meter's Profile Group's Profile Type." }, "profileGroupSubscriptionGroup" : { "type" : "integer", "format" : "int64", "description" : "Meter's Profile Group Subscription Info." }, "distributionMeterCode" : { "type" : "string", "description" : "Distribution Meter Code." }, "withdrawalSettlementPointName" : { "type" : "string", "description" : "Withdrawal Settlement Point Name." }, "supplySettlementPointName" : { "type" : "string", "description" : "Supply Settlement Point Name." }, "tnzlWithdSettlementPointName" : { "type" : "string", "description" : "Withdrawal Reduced Settlement Point Name." }, "tnzlSupplySettlementPointName" : { "type" : "string", "description" : "Supply Reduced Settlement Point Name." }, "organizationNme" : { "type" : "string" } } }, "MeteringPointDemand" : { "type" : "object", "required" : [ "eic" ], "properties" : { "eic" : { "type" : "string", "example" : "40Z0000000007034", "description" : "It keeps meter EIC." }, "customerNo" : { "type" : "string", "description" : "#{METERING_POINT_DEMAND_CUSTOMERNO}" }, "name" : { "type" : "string", "description" : "#{METERING_POINT_DEMAND_NAME}" }, "address" : { "type" : "string", "description" : "#{METERING_POINT_DEMAND_ADDRESS}" }, "distributionMeterCode" : { "type" : "string", "description" : "#{METERING_POINT_DEMAND_DISTIRBUTION_METER_CODE}" }, "city" : { "type" : "string", "description" : "It keeps city Id." }, "county" : { "type" : "string", "description" : "It keeps county Id." }, "demandPeriod" : { "type" : "string", "format" : "date-time", "description" : "It keeps term info." }, "demandType" : { "type" : "integer", "format" : "int32", "description" : "It keeps demand type code. 1->NEW, 2->SUPPLIER_CHANGED, 3->PORTFOLIO_OUT, 4->EVACUATION, 5->NEW_PRE_DECLARATION, 6->SUPPLIER_CHANGED_PRE_DECLARATION, 7->PORTFOLIO_OUT_PRE_DECLARATION, 9->NEW_DEFINITE_DECLARATION, 10->SUPPLIER_CHANGED_DEFINITE_DECLARATION, 11->PORTFOLIO_OUT_DEFINITE_DECLARATION, 12->EVACUATION_DEFINITE_DECLARATION, 13->NEW_MULTIPLE, 14->SUPPLIER_CHANGED_MULTIPLE, 15->METERING_POINT_PASSIVE, AUTO" }, "demandTypeEnum" : { "type" : "string", "description" : "It keeps demand type.", "enum" : [ "NEW", "SUPPLIER_CHANGED", "PORTFOLIO_OUT", "EVACUATION", "NEW_PRE_DECLARATION", "SUPPLIER_CHANGED_PRE_DECLARATION", "PORTFOLIO_OUT_PRE_DECLARATION", "NEW_DEFINITE_DECLARATION", "SUPPLIER_CHANGED_DEFINITE_DECLARATION", "PORTFOLIO_OUT_DEFINITE_DECLARATION", "EVACUATION_DEFINITE_DECLARATION", "NEW_MULTIPLE", "SUPPLIER_CHANGED_MULTIPLE", "METERING_POINT_PASSIVE", "AUTO" ] }, "demandStatus" : { "type" : "integer", "format" : "int32", "description" : "It keeps demand's status code. 0->PASSIVE, 1->ACTIVE." }, "demandStatusEnum" : { "type" : "string", "description" : "It keeps demand's status. ACTIVE, PASSIVE.", "enum" : [ "ACTIVE", "PASSIVE" ] }, "demandAddingDate" : { "type" : "string", "format" : "date-time", "description" : "#{METERING_POINT_DEMAND_ADDING_DATE}" }, "demandCancelingOrganization" : { "type" : "string", "description" : "#{METERING_POINT_DEMAND_CANCELING_ORGANIZATION}" }, "demandDeclarationFormStatus" : { "type" : "integer", "format" : "int32", "description" : "It keeps bilateral declaration form status code. 0->false, 1:true." }, "demandDeclarationFormStatusEnum" : { "type" : "boolean", "description" : "It keeps bilateral declaration form status. false: not approved, true: approved.", "default" : false }, "demandOrganization" : { "type" : "string", "description" : "#{METERING_POINT_DEMAND_ORGANIZATION}" }, "demandCancellationDate" : { "type" : "string", "format" : "date-time", "description" : "#{METERING_POINT_DEMAND_CANCELLATION_DATE}" }, "demandAddingUser" : { "type" : "string", "description" : "#{METERING_POINT_DEMAND_ADDING_USER}" }, "category" : { "type" : "string", "description" : "Customer category", "enum" : [ "NATURAL", "PUBLIC", "PRIVATE", "CORPORATION", "FOREIGN" ] }, "consumerNo" : { "type" : "string", "description" : "Customer no" }, "title" : { "type" : "string", "description" : "Customer title" }, "authorizedPersonName" : { "type" : "string", "description" : "Authorized Person name" }, "authorizedPersonNo" : { "type" : "string", "description" : "Authorized Person no" }, "authorizedPersonName2" : { "type" : "string", "description" : "Authorized Person2 name" }, "authorizedPersonNo2" : { "type" : "string", "description" : "Authorized Person2 no" } }, "description" : "It keeps metering point demands that is going to be listed." }, "MeteringPointDemandCreate" : { "type" : "object", "required" : [ "category", "customerNo", "eic", "title" ], "properties" : { "eic" : { "type" : "string", "example" : "40Z0000000007034", "description" : "It keeps meter EIC." }, "type" : { "type" : "string", "description" : "It keeps demand type.", "enum" : [ "NEW", "SUPPLIER_CHANGED", "PORTFOLIO_OUT", "EVACUATION", "NEW_PRE_DECLARATION", "SUPPLIER_CHANGED_PRE_DECLARATION", "PORTFOLIO_OUT_PRE_DECLARATION", "NEW_DEFINITE_DECLARATION", "SUPPLIER_CHANGED_DEFINITE_DECLARATION", "PORTFOLIO_OUT_DEFINITE_DECLARATION", "EVACUATION_DEFINITE_DECLARATION", "NEW_MULTIPLE", "SUPPLIER_CHANGED_MULTIPLE", "METERING_POINT_PASSIVE", "AUTO" ] }, "status" : { "type" : "string", "description" : "It keeps demand's status. ACTIVE, PASSIVE.", "enum" : [ "ACTIVE", "PASSIVE" ] }, "formStatus" : { "type" : "boolean", "description" : "It keeps bilateral declaration form status. false: not approved, true: approved.", "default" : false }, "updateReason" : { "type" : "string", "description" : "#{METERING_POINT_DEMAND_UPDATE_REASON}" }, "category" : { "type" : "string", "description" : "Customer category", "enum" : [ "NATURAL", "PUBLIC", "PRIVATE", "CORPORATION", "FOREIGN" ] }, "customerNo" : { "type" : "string", "description" : "Customer no" }, "title" : { "type" : "string", "description" : "Customer title" }, "authorizedPersonName" : { "type" : "string", "description" : "Authorized Person name" }, "authorizedPersonNo" : { "type" : "string", "description" : "Authorized Person no" }, "authorizedPersonName2" : { "type" : "string", "description" : "Authorized Person2 name" }, "authorizedPersonNo2" : { "type" : "string", "description" : "Authorized Person2 no" } }, "description" : "Metering point demands which will be created" }, "MeteringPointDemandCreateDataList" : { "type" : "object", "properties" : { "demands" : { "type" : "array", "description" : "Metering point demands which will be created", "items" : { "$ref" : "#/definitions/MeteringPointDemandCreate" } } } }, "MeteringPointDemandCreateRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/MeteringPointDemandCreateDataList" } }, "description" : "Request for Saving Metering Point" }, "MeteringPointDemandCreateResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "Service Response Body for Saving Metering Point", "$ref" : "#/definitions/DemandResponseDataList" } }, "description" : "Service Response for Saving Metering Point" }, "MeteringPointDemandDataList" : { "type" : "object", "properties" : { "queryInformation" : { "description" : "Keeps how many record exist in the service response and range values.", "$ref" : "#/definitions/QueryInformation" }, "demands" : { "type" : "array", "description" : "It keeps metering point demands that is going to be listed.", "items" : { "$ref" : "#/definitions/MeteringPointDemand" } } } }, "MeteringPointDemandQuery" : { "type" : "object", "required" : [ "date", "demandType" ], "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "date" : { "type" : "string", "format" : "date-time", "example" : "2016-05-01T00:00:00.000+0300", "description" : "It keeps the term info." }, "demandType" : { "type" : "string", "example" : "MINE, COUNTER, DISCHARGED, MULTIPLE", "description" : "Demand type.", "enum" : [ "MINE", "COUNTER", "DISCHARGED", "MULTIPLE" ] }, "meterEic" : { "type" : "string", "example" : "40Z0000000007034", "description" : "It keeps meter EIC." } }, "description" : "It keeps request for Metering Point Demand Listing." }, "MeteringPointDemandQueryRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/MeteringPointDemandQuery" } }, "description" : "It keeps request for Metering Point Demand Listing." }, "MeteringPointDemandQueryResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "It keeps response body for metering point demand listing.", "$ref" : "#/definitions/MeteringPointDemandDataList" } }, "description" : "It keeps response for metering point demand listing." }, "MeteringPointDemandValidate" : { "type" : "object", "required" : [ "category", "customerNo", "eic", "title" ], "properties" : { "eic" : { "type" : "string", "example" : "40Z0000000007034", "description" : "It keeps meter EIC." }, "type" : { "type" : "string", "description" : "It keeps demand type.", "enum" : [ "NEW", "SUPPLIER_CHANGED", "PORTFOLIO_OUT", "EVACUATION", "NEW_PRE_DECLARATION", "SUPPLIER_CHANGED_PRE_DECLARATION", "PORTFOLIO_OUT_PRE_DECLARATION", "NEW_DEFINITE_DECLARATION", "SUPPLIER_CHANGED_DEFINITE_DECLARATION", "PORTFOLIO_OUT_DEFINITE_DECLARATION", "EVACUATION_DEFINITE_DECLARATION", "NEW_MULTIPLE", "SUPPLIER_CHANGED_MULTIPLE", "METERING_POINT_PASSIVE", "AUTO" ] }, "status" : { "type" : "string", "description" : "It keeps demand's status. ACTIVE, PASSIVE.", "enum" : [ "ACTIVE", "PASSIVE" ] }, "formStatus" : { "type" : "boolean", "description" : "It keeps bilateral declaration form status. false: not approved, true: approved.", "default" : false }, "updateReason" : { "type" : "string", "description" : "#{METERING_POINT_DEMAND_UPDATE_REASON}" }, "category" : { "type" : "string", "description" : "Customer category", "enum" : [ "NATURAL", "PUBLIC", "PRIVATE", "CORPORATION", "FOREIGN" ] }, "customerNo" : { "type" : "string", "description" : "Customer no" }, "title" : { "type" : "string", "description" : "Customer title" }, "authorizedPersonName" : { "type" : "string", "description" : "Authorized Person name" }, "authorizedPersonNo" : { "type" : "string", "description" : "Authorized Person no" }, "authorizedPersonName2" : { "type" : "string", "description" : "Authorized Person2 name" }, "authorizedPersonNo2" : { "type" : "string", "description" : "Authorized Person2 no" }, "description" : { "type" : "string", "description" : "Ölçüm noktas?n?n kaydedilmemesi durumunda ald??? hatan?n aç?klama bilgisini tutar." }, "resultStatus" : { "type" : "string", "description" : "Ölçüm noktas?n?n kaydedilme durum bilgisini tutar.", "enum" : [ "SUCCESS", "VALIDATION_ERROR", "DUPLICATE", "FAILED" ] } }, "description" : "Demand informations that will be validated." }, "MeteringPointDemandValidateResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "Metering Point Demand Validation Response Body", "$ref" : "#/definitions/ValidateDemandResponseList" } }, "description" : "Metering Point Demand Validation Response" }, "MeteringPointEICQuery" : { "type" : "object", "properties" : { "meterEic" : { "type" : "string", "description" : "It keeps EIC of requested meter." }, "distributionMeterCode" : { "type" : "string", "description" : "It keeps distribution meter code." }, "meterReadingCompanyEic" : { "type" : "string", "description" : "It keeps EIC of the company who reads requested meter." } }, "description" : "Request Model for Metering Point EIC Querying Service." }, "MeteringPointEICQueryList" : { "type" : "object", "properties" : { "meteringPointEICQueries" : { "type" : "array", "description" : "Request Model List for Metering Point EIC Querying Service.", "items" : { "$ref" : "#/definitions/MeteringPointEICQuery" } } }, "description" : "Request Container for Metering Point EIC Querying Service." }, "MeteringPointEICQueryRequest" : { "type" : "object", "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Service Request Body.", "$ref" : "#/definitions/MeteringPointEICQueryList" } }, "description" : "Request Model of Meter Eic Querying which has header and body info." }, "MeteringPointEICQueryResponse" : { "type" : "object", "required" : [ "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "Response Body for Metering Point EIC Querying Service", "$ref" : "#/definitions/MeteringPointEICQueryResponseDataList" } }, "description" : "Response Model for Meter EIC Querying" }, "MeteringPointEICQueryResponseData" : { "type" : "object", "properties" : { "meterEic" : { "type" : "string", "description" : "It keeps info of Meter EIC." }, "distributionMeterId" : { "type" : "string", "description" : "It keeps Distribution Meter Code which belongs to Meter's Company." }, "customerNo" : { "type" : "string", "description" : "It keeps Customer No of the meter." }, "eligibleConsumptionType" : { "type" : "string", "description" : "Consumption Metering Type", "enum" : [ "ELIGIBLE_CONSUMER", "NO_ELIGIBLE_CONSUMER", "ORGANIZED_INDUSTRIAL_ZONE_EC" ] }, "meterUsageState" : { "type" : "string", "description" : "Usage Type", "enum" : [ "NO_CONSUMER", "IN_USE" ] }, "supplierType" : { "type" : "string", "description" : "Supply Type", "enum" : [ "END_USE_SUPPLIER", "BILATERAL_CONTRACT", "RETAIL_SALE" ] }, "meteringPointName" : { "type" : "string", "description" : "It keeps Meter Name." }, "meteringAddress" : { "type" : "string", "description" : "It keeps info of Meter Address." }, "cityId" : { "type" : "integer", "format" : "int64", "description" : "It keeps City Id which the meter is belonging to." }, "countyId" : { "type" : "integer", "format" : "int64", "description" : "It keeps County Id which the meter is belonging to." }, "meterReadingCompanyId" : { "type" : "string", "description" : "It keeps Meter Reading Company Id." }, "meterReadingCompanyEic" : { "type" : "string", "description" : "Sayacı okuyan kurumun EIC bilgisini tutar" }, "tariffClass" : { "type" : "string", "description" : "Tariff Class", "enum" : [ "SINGLE_TERM", "DOUBLE_TERM" ] }, "mainTariffGroup" : { "type" : "string", "description" : "Main Tariff Group", "enum" : [ "INDUSTRY", "BUSINESS", "RESIDENCE", "AGRICULTURAL_IRRIGATION", "LIGHTING" ] }, "connectionPositionDescription" : { "type" : "string", "description" : "Connection Position Description" }, "status" : { "type" : "string", "description" : "Yapılan sorgulama sonucu kayıt bulunma durum bilgisini tutar. SUCCES:Ölçüm Noktası Bulundu , NOT_FOUND: Ölçüm Noktası Bulunamadı", "enum" : [ "SUCCESS", "NOT_FOUND" ] }, "description" : { "type" : "string", "description" : "Yapılan sorgulama sonucu başarısız olması durumunda nedeni." } }, "description" : "Response Model for Metering Point EIC Querying Service.", "xml" : { "name" : "meteringPointEICQueryResponseData" } }, "MeteringPointEICQueryResponseDataList" : { "type" : "object", "properties" : { "eicQueryResponseDatas" : { "type" : "array", "description" : "Response List for Metering Point EIC Querying Service", "items" : { "$ref" : "#/definitions/MeteringPointEICQueryResponseData" } } }, "description" : "Response container model for Metering Point EIC Querying Service" }, "MeteringPointListResponse" : { "type" : "object", "properties" : { "queryInformation" : { "description" : "Keeps how many record exist in the service response and range values.", "$ref" : "#/definitions/QueryInformation" }, "meteringPointListResponse" : { "type" : "array", "items" : { "$ref" : "#/definitions/MeteringPointResponse" } } } }, "MeteringPointRegister" : { "type" : "object", "required" : [ "amr", "averageAnnualConsumption", "busbarVoltage", "canLoadProfile", "connectionPointLocation", "contractPower", "countyId", "customerNo", "distributionMeterId", "eligibleConsumptionType", "estimation", "meterAddress", "meteringVoltage", "readingType", "status", "substation", "supplyPosition", "transLossFactorStatus", "transformerInputVoltage", "transformerOutputVoltage", "transformerPower", "usageState", "withdrawalPosition", "zonningPosition" ], "properties" : { "meterEic" : { "type" : "string", "example" : "40Z000000000001Y", "description" : "Meter EIC. (required field for updating metering points)" }, "distributionMeterId" : { "type" : "string", "description" : "Distribution Meter Code." }, "status" : { "type" : "boolean", "description" : "Metering Point Status. (required field for updating metering points)", "default" : false }, "withDrawalDeducSettlementPointEic" : { "type" : "string", "example" : "40W000000000001Y", "description" : "Meter Settlement Point EIC." }, "meterAddress" : { "type" : "string", "description" : "Meter address." }, "countyId" : { "type" : "integer", "format" : "int64", "description" : "County Id where the meter is located." }, "transformerInputVoltage" : { "type" : "number", "description" : "Meter's Transformer Input Voltage" }, "transformerOutputVoltage" : { "type" : "number", "description" : "Meter's Transformer Output Voltage" }, "customerNo" : { "type" : "string", "description" : "Meter's Customer No" }, "substation" : { "type" : "integer", "format" : "int64", "description" : "Transformer That Meter Belongs To" }, "connectionPointLocation" : { "type" : "integer", "format" : "int64", "description" : "Location info of metering point based on the transformer." }, "connectionPointLocationOther" : { "type" : "string", "description" : "Other location info of metering point based on the transformer." }, "meteringVoltage" : { "type" : "integer", "format" : "int64", "description" : "Meter Connection Point Voltage" }, "profileType" : { "type" : "integer", "format" : "int64", "description" : "Meter Profile Type" }, "profileSubscriptionGroup" : { "type" : "integer", "format" : "int64", "description" : "Meter Profile Subscription Group" }, "readingType" : { "type" : "integer", "format" : "int64", "description" : "Meter Reading Type" }, "transformerPower" : { "type" : "number", "description" : "Meter's Transformer Power (MVA)" }, "busbarVoltage" : { "type" : "integer", "format" : "int64", "description" : "Meter's Busbar Voltage" }, "noLoadLoss" : { "type" : "number", "description" : "Meter's Loss On No-load" }, "loadLoss" : { "type" : "number", "description" : "Meter's Loss On Load" }, "temperatureCoefficient" : { "type" : "integer", "format" : "int64", "description" : "Meter's Conductor Resistance" }, "lineLength" : { "type" : "number", "description" : "Meter's line length." }, "lineSection" : { "type" : "number", "description" : "Meter's Line Section" }, "lineCircuit" : { "type" : "integer", "format" : "int64", "description" : "Meter's Number of Circuits in Line" }, "transLossFactorStatus" : { "type" : "boolean", "description" : "Transmission Loss Factor Status", "default" : false }, "averageAnnualConsumption" : { "type" : "number", "description" : "Average Annual Consumption" }, "supplyPosition" : { "type" : "integer", "format" : "int64", "description" : "Meter Supply Position" }, "withdrawalPosition" : { "type" : "integer", "format" : "int64", "description" : "Meter Withdrawal Position" }, "meteringPointUpdateDate" : { "type" : "string", "format" : "date-time", "example" : "2016-05-01T00:00:00.000+0300", "description" : "The term of meters that is going to be changed. (required field for updating metering points)" }, "isDeleteDataForReadingType" : { "type" : "boolean", "description" : "If there is meter reading change, this field keeps deletion status. (required field for updating metering points)", "default" : false }, "addressCode" : { "type" : "integer", "format" : "int64", "description" : "Adres kod bilgisini tutar." }, "zonningPosition" : { "type" : "boolean", "description" : "?mar yerle?im alan? konum bilgisini tutar.", "default" : false }, "usageState" : { "type" : "integer", "format" : "int64", "description" : "Ölçüm noktas? kullan?m durumu bilgisini tutar." }, "organizedIndustrialZoneEic" : { "type" : "string", "description" : "Ölçüm noktas?n?n hangi organize sanayi bölgesinin ana sayac? oldu?u bilgisini tutar." }, "canLoadProfile" : { "type" : "boolean", "description" : "Yük profil bilgisini al?nabilir bilgisini tutar.", "default" : false }, "mainEligibleConsumptionEic" : { "type" : "string", "description" : "OSB'lerin alt?ndaki ölçüm noktalar?n?n hangi ana sayaca ba?l? oldu?u bilgisini tutar." }, "supplyDeductionSettlementPoint" : { "type" : "string", "description" : "OSB'lerin ana sayac?n?n veri? tenzil uevçb bilgisini tutar." }, "eligibleConsumptionType" : { "type" : "integer", "format" : "int64", "description" : "Ölçüm noktas?n?n tip bilgisini tutar." }, "supplierType" : { "type" : "integer", "format" : "int64", "description" : "Ölçüm noktas?n?n tedarik tip bilgisini tutar." }, "amr" : { "type" : "boolean", "description" : "Otomatik sayaç okuma sistemi ile okunmad? durum bilgisini tutar.", "default" : false }, "maxAnnualConsumption" : { "type" : "number", "description" : "Ölçüm noktas?n?n y?ll?k maksimum tüketim de?eri bilgisini tutar." }, "estimation" : { "type" : "boolean", "description" : "Ölçüm noktas?n?n tahminleme yap?lma durum bilgisi.", "default" : false }, "serialNumber" : { "type" : "string", "description" : "Meter's serial number;" }, "manufacturer" : { "type" : "string", "description" : "Meter's manufacturer." }, "supplierOrganization" : { "type" : "string", "description" : "Meter's supplier." }, "contractPower" : { "type" : "number", "description" : "Contract power (kW)" }, "tariffClass" : { "type" : "string", "description" : "Tariff Class", "enum" : [ "SINGLE_TERM", "DOUBLE_TERM" ] }, "mainTariffGroup" : { "type" : "string", "description" : "Main Tariff Group", "enum" : [ "INDUSTRY", "BUSINESS", "RESIDENCE", "AGRICULTURAL_IRRIGATION", "LIGHTING" ] }, "activityCode" : { "type" : "string", "description" : "Activity Code" }, "meteringType" : { "type" : "integer", "format" : "int64", "description" : "Meter's type." }, "withDrawalSettlementPointEic" : { "type" : "string", "description" : "Withdrawal Settlement Point" }, "supplySettlementPointEic" : { "type" : "string", "description" : "Ölçüm noktasının bağlı olduğu veriş uevçb bilgisini tutar. Bu bilgi sadece EPİAŞ tarafından değiştirilebilir." }, "reasonUpdate" : { "type" : "string", "description" : "Withdrawal Settlement Point" }, "readingPeriod" : { "type" : "integer", "format" : "int32", "description" : "#{CMP_METERING_POINTS_SAVE_QUERY_METER_READING_PERIOD}" } } }, "MeteringPointRegisterList" : { "type" : "object", "required" : [ "meteringPoints" ], "properties" : { "meteringPoints" : { "type" : "array", "description" : "Metering points which are going to be updated or to be saved.", "items" : { "$ref" : "#/definitions/MeteringPointRegister" } } } }, "MeteringPointRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/MeteringPointRegisterList" } } }, "MeteringPointResponse" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "description" : "Meter Id" }, "meterEic" : { "type" : "string", "description" : "Meter EIC" }, "distributionMeterId" : { "type" : "string", "description" : "Distribution Meter Code" }, "status" : { "type" : "boolean", "description" : "Meter Status", "default" : false }, "meterReadingCompany" : { "type" : "integer", "format" : "int64", "description" : "Meter Reading Organization" }, "withDrawalDeducSettlementPointEic" : { "type" : "string", "description" : "Withdrawal Deduction Settlement Point" }, "meterName" : { "type" : "string", "description" : "Meter Name" }, "meterAddress" : { "type" : "string", "description" : "Meter Address" }, "countyId" : { "type" : "integer", "format" : "int64", "description" : "County Id" }, "transformerInputVoltage" : { "type" : "number", "description" : "Transformer Input Voltage" }, "transformerOutputVoltage" : { "type" : "number", "description" : "Transformer Output Voltage" }, "customerNo" : { "type" : "string", "description" : "Customer No" }, "substation" : { "type" : "integer", "format" : "int64", "description" : "Transformer That Meter Belongs To" }, "connectionPointLocation" : { "type" : "integer", "format" : "int64", "description" : "Connection Point Location" }, "connectionPointLocationOther" : { "type" : "string", "description" : "Other Connection Point Location" }, "meteringVoltage" : { "type" : "integer", "format" : "int64", "description" : "Meter Connection Point Voltage" }, "profileType" : { "type" : "integer", "format" : "int64", "description" : "Profile Type (AC / DC)" }, "profileSubscriptionGroup" : { "type" : "integer", "format" : "int64", "description" : "Meter Subscription Group" }, "readingType" : { "type" : "integer", "format" : "int64", "description" : "Meter Reading Type" }, "transformerPower" : { "type" : "number", "description" : "Transformer Power" }, "busbarVoltage" : { "type" : "integer", "format" : "int64", "description" : "Busbar Voltage" }, "noLoadLoss" : { "type" : "number", "description" : "Loss On No-load" }, "loadLoss" : { "type" : "number", "description" : "Loss On Load" }, "temperatureCoefficient" : { "type" : "integer", "format" : "int64", "description" : "Conductor Resistance" }, "lineLength" : { "type" : "number", "description" : "Line Length" }, "lineSection" : { "type" : "number", "description" : "Line Section" }, "lineCircuit" : { "type" : "integer", "format" : "int64", "description" : "Number of Circuits in Line" }, "transLossFactorStatus" : { "type" : "boolean", "description" : "Transfer Loss Factor Status", "default" : false }, "averageAnnualConsumption" : { "type" : "number", "description" : "Average Annual Consumption" }, "supplyPosition" : { "type" : "integer", "format" : "int64", "description" : "Meter Supply Position" }, "withdrawalPosition" : { "type" : "integer", "format" : "int64", "description" : "Meter Withdrawal Position" }, "addressCode" : { "type" : "integer", "format" : "int64", "description" : "Adres kod bilgisini tutar." }, "zonningPosition" : { "type" : "boolean", "description" : "?mar yerle?im alan? konum bilgisini tutar.", "default" : false }, "usageState" : { "type" : "integer", "format" : "int64", "description" : "Ölçüm noktas? kullan?m durumu bilgisini tutar." }, "organizedIndustrialZoneEic" : { "type" : "string", "description" : "lçüm noktas?n?n hangi organize sanayi bölgesinin ana sayac? oldu?u bilgisini tutar." }, "canLoadProfile" : { "type" : "boolean", "description" : "Yük profil bilgisini al?nabilir bilgisini tutar.", "default" : false }, "mainEligibleConsumptionEic" : { "type" : "string", "description" : "OSB'lerin alt?ndaki ölçüm noktalar?n?n hangi ana sayaca ba?l? oldu?u bilgisini tutar." }, "supplyDeductionSettlementPoint" : { "type" : "string", "description" : "OSB'lerin ana sayac?n?n veri? tenzil uevçb bilgisini tutar." }, "eligibleConsumptionType" : { "type" : "integer", "format" : "int64", "description" : "Ölçüm noktas?n?n tip bilgisini tutar." }, "amr" : { "type" : "boolean", "description" : "Otomatik sayaç okuma sistemi ile okunmad? durum bilgisini tutar.", "default" : false }, "maxAnnualConsumption" : { "type" : "number", "description" : "Ölçüm noktas?n?n y?ll?k maksimum tüketim de?eri bilgisini tutar." }, "estimation" : { "type" : "boolean", "description" : "Ölçüm noktas?n?n tahminleme yap?lma durum bilgisi.", "default" : false }, "serialNumber" : { "type" : "string", "description" : "Serial number" }, "manufacturer" : { "type" : "string", "description" : "Manufacturer" }, "supplierOrganization" : { "type" : "string", "description" : "Supplier Organizaton" }, "contractPower" : { "type" : "number", "description" : "Contract power" }, "tariffClass" : { "type" : "string", "description" : "Tariff class", "enum" : [ "SINGLE_TERM", "DOUBLE_TERM" ] }, "mainTariffGroup" : { "type" : "string", "description" : "Main tariff group", "enum" : [ "INDUSTRY", "BUSINESS", "RESIDENCE", "AGRICULTURAL_IRRIGATION", "LIGHTING" ] }, "activityCode" : { "type" : "string", "description" : "Activity code" }, "meteringType" : { "type" : "integer", "format" : "int64", "description" : "Metering Type" }, "supplierType" : { "type" : "integer", "format" : "int64", "description" : "Supplier Type" }, "withDrawalSettlementPointEic" : { "type" : "string", "description" : "Withdrawal Deduction Settlement Point" }, "supplySettlementPointEic" : { "type" : "string", "description" : "Withdrawal Deduction Settlement Point" }, "withdrawalPositionDescription" : { "type" : "string", "description" : "Ba?lant? pozisyon aç?klama bilgisi" }, "countyName" : { "type" : "string", "description" : "Meter's County Name" }, "organizedIndustrialZone" : { "type" : "string", "description" : "Organize Sanayi Bölgesinin Adı" }, "meteringVoltageValue" : { "type" : "number", "description" : "Bağlantı noktası Gerilim Değeri" }, "busbarVoltageValue" : { "type" : "number", "description" : "Bara Gerilim Değeri" }, "lineCircuitDesc" : { "type" : "string", "description" : "Hat Devre Bilgisi" }, "temperatureCoefficientValue" : { "type" : "number", "description" : "İletken Özdirenç Değeri" }, "profileSubscriptionGroupDesc" : { "type" : "string", "description" : "Profil Abone Grup Bilgisi" }, "profileTypeDesc" : { "type" : "string", "description" : "Profil Tip Bilgisi" }, "withdrawalPositionName" : { "type" : "string", "description" : "Sayaç Çekiş Pozisyon Adı" }, "supplyPositionName" : { "type" : "string", "description" : "Sayaç Veriş Pozisyon Adı" }, "eligibleConsumptionTypeDesc" : { "type" : "string", "description" : "Ölçüm Noktası Tip Bilgisi", "enum" : [ "ELIGIBLE_CONSUMER", "NO_ELIGIBLE_CONSUMER", "ORGANIZED_INDUSTRIAL_ZONE_EC" ] }, "usageStateDesc" : { "type" : "string", "description" : "Ölçüm Noktası Kullanım Durum Bilgisi", "enum" : [ "NO_CONSUMER", "IN_USE" ] }, "supplierTypeDesc" : { "type" : "string", "description" : "Tedarik Tip Bilgisi", "enum" : [ "END_USE_SUPPLIER", "BILATERAL_CONTRACT", "RETAIL_SALE" ] }, "connectionPointLocationDesc" : { "type" : "string", "description" : "Trafoya Gören Konum Bilgisi" }, "substationDesc" : { "type" : "string", "description" : "Trafo Merkezi Bilgisi" }, "registrationDate" : { "type" : "string", "format" : "date-time", "description" : "Ölçüm noktası kayıt tarih bilgisi." }, "readingPeriod" : { "type" : "integer", "format" : "int32", "description" : "Reading Period" } } }, "MeteringPointSaveListResponse" : { "type" : "object", "required" : [ "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "$ref" : "#/definitions/MeteringPointSaveListResponseBody" } }, "description" : "It keeps the response info of metering point." }, "MeteringPointSaveListResponseBody" : { "type" : "object", "properties" : { "meteringPointSaveResponses" : { "type" : "array", "items" : { "$ref" : "#/definitions/MeteringPointSaveResponse" } } } }, "MeteringPointSaveResponse" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64", "description" : "Kaydedilen ölçüm noktas?n?n ID bilgisini tutar." }, "meterEic" : { "type" : "string", "description" : "Kaydedilen ölçüm noktas?n?n EIC kod bilgisini tutar." }, "distributionMeterCode" : { "type" : "string", "description" : "Kaydedilen ölçüm noktas?n?n tekil kod bilgisini tutar." }, "status" : { "type" : "string", "description" : "Ölçüm noktas?n?n kaydedilme durum bilgisini tutar.", "enum" : [ "SUCCESS", "VALIDATION_ERROR", "DUPLICATE", "FAILED" ] }, "description" : { "type" : "string", "description" : "Ölçüm noktas?n?n kaydedilmemesi durumunda ald??? hatan?n aç?klama bilgisini tutar." } } }, "MeteringPointServiceResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "It keeps the response body info of metering point.", "$ref" : "#/definitions/MeteringPointListResponse" } }, "description" : "It keeps the response info of metering point." }, "MeteringProfileBulkDataList" : { "type" : "object", "properties" : { "profileDataLists" : { "type" : "array", "items" : { "$ref" : "#/definitions/MeteringProfileDataList" } } } }, "MeteringProfileBulkDataRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/MeteringProfileBulkDataList" } } }, "MeteringProfileData" : { "type" : "object", "required" : [ "dayTimeConsumption", "nightTimeConsumption", "peakConsumption" ], "properties" : { "dayTimeConsumption" : { "type" : "number", "description" : "Consumption value which is read in day time." }, "peakConsumption" : { "type" : "number", "description" : "Consumption value which is read in peak time." }, "nightTimeConsumption" : { "type" : "number", "description" : "Consumption value which is read in night time." } } }, "MeteringProfileDataList" : { "type" : "object", "required" : [ "data", "eic", "settlementPeriod" ], "properties" : { "settlementPeriod" : { "type" : "string", "format" : "date-time", "description" : "The settlement term which new meter info saved at. You can save new meter info only for open settlement term." }, "eic" : { "type" : "string", "description" : "EIC of the meter which is going to be saved." }, "data" : { "description" : "Consumption value of single or three tariffs meters on open settlement term.", "$ref" : "#/definitions/MeteringProfileData" } } }, "MeteringProfileDataRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/MeteringProfileDataList" } } }, "Move" : { "type" : "object", "required" : [ "moveId" ], "properties" : { "moveId" : { "type" : "integer", "format" : "int64", "description" : "Customer move id" } }, "description" : "Customer Activites which will be deactivated." }, "ProfileConsumptionDataList" : { "type" : "object", "properties" : { "queryInformation" : { "description" : "Keeps how many record exist in the service response and range values.", "$ref" : "#/definitions/QueryInformation" }, "consumptions" : { "type" : "array", "description" : "Consumption informations.", "items" : { "$ref" : "#/definitions/ProfileConsumption" } } } }, "ProfileConsumptionGetRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/ProfileConsumptionQueryRequest" } }, "description" : "Profile consumption request informations." }, "ProfileConsumptionQueryRequest" : { "type" : "object", "required" : [ "period" ], "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "period" : { "type" : "string", "format" : "date-time", "example" : "2016-05-01T00:00:00.000+0300", "description" : "Date period of meters." }, "pastVersion" : { "type" : "boolean", "example" : false, "description" : "It keeps if past meters are going to be listed or not.", "default" : false }, "meterEics" : { "type" : "array", "example" : "40Z0000000007034", "description" : "Verisi istenen sayaçlara ait etso kod bilgisi.", "items" : { "type" : "string" } } }, "description" : "Profile consumption request informations." }, "ProfileConsumptionResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "Profile consumption service response body informations.", "$ref" : "#/definitions/ProfileConsumptionDataList" } }, "description" : "Profile consumption service response informations." }, "ProfileFactor" : { "type" : "object", "properties" : { "membershipGroup" : { "type" : "integer", "format" : "int32", "description" : "Membership group" }, "profiles" : { "type" : "array", "description" : "Factors", "items" : { "$ref" : "#/definitions/FactorByPeriod" } } }, "description" : "Contains profile factors." }, "ProfileFactorResponse" : { "type" : "object", "properties" : { "factors" : { "type" : "array", "description" : "membership based profile factors", "items" : { "$ref" : "#/definitions/ProfileFactor" } } }, "description" : "Profile factors response." }, "ProfileFactorsQuery" : { "type" : "object", "required" : [ "membershipGroup", "meteringReadingType", "period", "regionCode" ], "properties" : { "regionCode" : { "type" : "integer", "format" : "int32", "example" : 13, "description" : "Region Code" }, "period" : { "type" : "string", "format" : "date-time", "example" : "2016-03-01T00:00:00.000+0300", "description" : "Should be first day of month. Others will be converted to first day of month. " }, "meteringReadingType" : { "type" : "string", "description" : "Meter reading type. ", "enum" : [ "HOURLY", "SINGLE_RATE", "THREE_RATE" ] }, "membershipGroup" : { "type" : "integer", "format" : "int32", "description" : "Membership group" } }, "description" : "Profile factors query criterias." }, "ProfileFactorsQueryRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/ProfileFactorsQuery" } }, "description" : "Profile factors query criterias." }, "ProfileFactorsQueryResponse" : { "type" : "object", "required" : [ "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "$ref" : "#/definitions/ProfileFactorResponse" } }, "description" : "Profile factors response." }, "QueryInformation" : { "type" : "object", "properties" : { "begin" : { "type" : "integer", "format" : "int32", "example" : 1, "description" : "Start range value." }, "end" : { "type" : "integer", "format" : "int32", "example" : 10, "description" : "End range value." }, "count" : { "type" : "integer", "format" : "int32", "example" : 4444, "description" : "Total number of record." } }, "description" : "Keeps how many record exist in the service response and range values." }, "QueryMeteringHourlyRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/QueryMeteringHourlyRequestData" } }, "description" : "It keeps request parameters for Meter Supply / Withdrawal Service." }, "QueryMeteringHourlyRequestData" : { "type" : "object", "required" : [ "period" ], "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "period" : { "type" : "string", "format" : "date-time", "example" : "2016-05-01T00:00:00.000+0300", "description" : "Returns meter info that is active on given term." }, "meterEic" : { "type" : "string", "example" : "40Z0000000007034", "description" : "Meter EIC" }, "monthly" : { "type" : "boolean", "example" : false, "description" : "Requested meter is monthly or not.", "default" : false }, "pastVersion" : { "type" : "boolean", "example" : false, "description" : "It keeps if past meters are going to be listed or not.", "default" : false }, "meterEics" : { "type" : "array", "example" : "40Z0000000007034", "description" : "Verisi istenen sayaçlara ait etso kod bilgisi.", "items" : { "type" : "string" } } }, "description" : "It keeps request parameters for Meter Supply / Withdrawal Service." }, "QueryMeteringHourlyResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "Meter Supply / Withdrawal Response Body", "$ref" : "#/definitions/QueryMeteringHourlyResponseDataList" } }, "description" : "Meter Supply / Withdrawal Response" }, "QueryMeteringHourlyResponseDataList" : { "type" : "object", "properties" : { "queryInformation" : { "description" : "Keeps how many record exist in the service response and range values.", "$ref" : "#/definitions/QueryInformation" }, "hourlyMeteringInformations" : { "type" : "array", "description" : "Hourly meter info.", "items" : { "$ref" : "#/definitions/QueryMeteringHourlyResponseData" } } } }, "QueryMeteringInfo" : { "type" : "object", "properties" : { "meteringInfo" : { "$ref" : "#/definitions/MeteringInfo" } } }, "QueryMeteringInfoList" : { "type" : "object", "properties" : { "queryInformation" : { "description" : "Keeps how many record exist in the service response and range values.", "$ref" : "#/definitions/QueryInformation" }, "meteringInfoResponseLists" : { "type" : "array", "description" : "List of meters.", "items" : { "$ref" : "#/definitions/MeteringInfo" } } } }, "QueryMeteringInfoListRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/QueryMeteringInfoListRequestData" } } }, "QueryMeteringInfoListRequestData" : { "type" : "object", "required" : [ "date" ], "properties" : { "range" : { "description" : "By using this object you can specify record number with start and end index values.", "$ref" : "#/definitions/Range" }, "date" : { "type" : "string", "format" : "date-time", "description" : "Meter Effective Date." }, "queryType" : { "type" : "string", "description" : "Query filter type; QueryByRegion to query based on a region id. " }, "filter" : { "description" : "Request filter Info. ", "$ref" : "#/definitions/QueryMeteringInfoRequestFilter" } }, "description" : "It keeps request parameters for Meter Supply / Withdrawal Service." }, "QueryMeteringInfoListResponse" : { "type" : "object", "required" : [ "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "$ref" : "#/definitions/QueryMeteringInfoList" } } }, "QueryMeteringInfoRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/QueryMeteringInfoRequestData" } } }, "QueryMeteringInfoRequestData" : { "type" : "object", "required" : [ "date", "meterEic" ], "properties" : { "date" : { "type" : "string", "format" : "date-time", "description" : "Meter Effective Date." }, "meterEic" : { "type" : "string", "description" : "Meter EIC." } } }, "QueryMeteringInfoRequestFilter" : { "type" : "object", "properties" : { "transmissionLossFactorStatus" : { "type" : "boolean", "description" : "TransmissionLossFactor Status.If null, all status valuyes included.", "default" : false }, "regionId" : { "type" : "integer", "format" : "int64", "description" : "RegionId for filtering. If null all regionid values included." } }, "description" : "Request filter Info. " }, "QueryMeteringInfoResponse" : { "type" : "object", "required" : [ "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "$ref" : "#/definitions/QueryMeteringInfo" } } }, "Range" : { "type" : "object", "properties" : { "begin" : { "type" : "integer", "format" : "int32", "example" : 1, "description" : "Keeps range start value." }, "end" : { "type" : "integer", "format" : "int32", "example" : 10, "description" : "Keeps range end value." } }, "description" : "By using this object you can specify record number with start and end index values." }, "ReadingMeteringPointListResponse" : { "type" : "object", "properties" : { "queryInformation" : { "description" : "Keeps how many record exist in the service response and range values.", "$ref" : "#/definitions/QueryInformation" }, "readingMeteringPointListResponse" : { "type" : "array", "description" : "It keeps the response info of meters based on their reading type (new to be read or non-obligatory to read).", "items" : { "$ref" : "#/definitions/ReadingMeteringPointResponse" } } }, "description" : "It keeps the response body info of meters based on their reading type (new to be read or non-obligatory to read)." }, "ReadingMeteringPointResponse" : { "type" : "object", "properties" : { "meterEic" : { "type" : "string", "description" : "Meter EIC" }, "meterName" : { "type" : "string", "description" : "Meter Name" }, "meterId" : { "type" : "integer", "format" : "int64", "description" : "Meter Id" }, "meterEffectiveDate" : { "type" : "string", "format" : "date-time", "description" : "Meter Effective Date" }, "readingType" : { "type" : "string", "description" : "Meter Reading Type", "enum" : [ "THREE_RATE", "HOURLY", "SINGLE_RATE" ] }, "readingTypeId" : { "type" : "integer", "format" : "int64", "description" : "Meter Reading Type" }, "meterLossesType" : { "type" : "integer", "format" : "int64", "description" : "Meter Losses Type" }, "organization" : { "type" : "integer", "format" : "int64", "description" : "Organization Id" }, "meterReadingOrganization" : { "type" : "integer", "format" : "int64", "description" : "Meter Reading Organization" }, "profileSubscriptionGroup" : { "type" : "integer", "format" : "int64", "description" : "Meter Subscription Group" }, "distributionMeterCode" : { "type" : "string", "description" : "Distribution Meter Code" }, "customerNo" : { "type" : "string", "description" : "Customer No" }, "meterAddress" : { "type" : "string", "description" : "Meter Address" }, "countyId" : { "type" : "integer", "format" : "int64", "description" : "County Id" }, "averageAnnualConsumption" : { "type" : "number", "description" : "Average Annual Consumption" }, "organizationEic" : { "type" : "string", "description" : "Organization EIC" }, "organizationCode" : { "type" : "string", "description" : "Organization Code" }, "profileSubscriptionGroupName" : { "type" : "string", "description" : "Meter Subscription Group Name" }, "city" : { "type" : "string", "description" : "City that meter belongs to." }, "categoryType" : { "type" : "string", "description" : "#{READING_METER_CATEGORY_TYPE}", "enum" : [ "NATURAL", "PUBLIC", "PRIVATE", "CORPORATION", "FOREIGN" ] } }, "description" : "It keeps the response info of meters based on their reading type (new to be read or non-obligatory to read)." }, "ReadingMeteringPointServiceResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "It keeps the response body info of meters based on their reading type (new to be read or non-obligatory to read).", "$ref" : "#/definitions/ReadingMeteringPointListResponse" } }, "description" : "It keeps the service response of meters based on their reading type (new to be read or non-obligatory to read)." }, "ReturnedToSupplierMeterListResponse" : { "type" : "object", "properties" : { "queryInformation" : { "description" : "Keeps how many record exist in the service response and range values.", "$ref" : "#/definitions/QueryInformation" }, "returnedToSupplierMeterListResponse" : { "type" : "array", "items" : { "$ref" : "#/definitions/ReturnedToSupplierMeterResponse" } } } }, "ReturnedToSupplierMeterResponse" : { "type" : "object", "properties" : { "newMeterId" : { "type" : "integer", "format" : "int64", "description" : "New Meter's Id" }, "newMeterEic" : { "type" : "string", "description" : "New Meter's EIC" }, "newOrganizationEic" : { "type" : "string", "description" : "New Meter's Organization EIC" }, "oldOrganizationEic" : { "type" : "string", "description" : "Old Meter's Organization EIC" }, "newCustomerNo" : { "type" : "string", "description" : "New Customer No" }, "newMeterName" : { "type" : "string", "description" : "New Meter's Name" }, "newMeterAddress" : { "type" : "string", "description" : "New Meter's Address" }, "newMeterCountyId" : { "type" : "integer", "format" : "int64", "description" : "New Meter's Country Id" }, "newMeterReadingType" : { "type" : "integer", "format" : "int64", "description" : "New Meter's Reading Type" }, "newProfileSubscriptionGroup" : { "type" : "integer", "format" : "int64", "description" : "New Meter's Subscription Group" }, "newAverageAnnualConsumption" : { "type" : "number", "description" : "New Meter's Average Annual Consumption" }, "newDistributionMeterCode" : { "type" : "string", "description" : "New Meter's Distribution Meter Code" }, "newprofileSubscriptionGroupName" : { "type" : "string", "description" : "New Meter's Subscription Group Name" }, "newCity" : { "type" : "string", "description" : "New Meter's City" }, "oldOrganizationCode" : { "type" : "string", "description" : "Old Meter's Organization Code" }, "newOrganizationCode" : { "type" : "string", "description" : "New Meter's Organization Code" } } }, "ReturnedToSupplierMeterServiceResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "It keeps the response body info of meters which returned to their supplier.", "$ref" : "#/definitions/ReturnedToSupplierMeterListResponse" } }, "description" : "It keeps the response info of meters which returned to their supplier." }, "UpdateDemandCustomerRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/UpdateDemandCustomerRequestList" } }, "description" : "Demand Customer Update Request" }, "UpdateDemandCustomerRequestList" : { "type" : "object", "properties" : { "demands" : { "type" : "array", "description" : "Demand Customer Update Request Data List", "items" : { "$ref" : "#/definitions/UpdateDemandCustomerRequestModel" } } } }, "UpdateDemandCustomerRequestModel" : { "type" : "object", "required" : [ "category", "customerNo", "title" ], "properties" : { "eic" : { "type" : "string", "description" : "It keeps meter EIC." }, "category" : { "type" : "string", "description" : "Customer category", "enum" : [ "NATURAL", "PUBLIC", "PRIVATE", "CORPORATION", "FOREIGN" ] }, "customerNo" : { "type" : "string", "description" : "Customer no" }, "title" : { "type" : "string", "description" : "Customer title" }, "authorizedPersonName" : { "type" : "string", "description" : "Authorized Person name" }, "authorizedPersonNo" : { "type" : "string", "description" : "Authorized Person no" }, "authorizedPersonName2" : { "type" : "string", "description" : "Authorized Person2 name" }, "authorizedPersonNo2" : { "type" : "string", "description" : "Authorized Person2 no" } }, "description" : "Demand Customer Update Request Data List" }, "UpdateDemandCustomerResponse" : { "type" : "object", "required" : [ "body", "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "description" : "Demand Customer Update Response Body", "$ref" : "#/definitions/UpdateDemandCustomerResponseList" } }, "description" : "Demand Customer Update Response" }, "UpdateDemandCustomerResponseList" : { "type" : "object", "properties" : { "demands" : { "type" : "array", "description" : "Demand Customer Update Response Data List", "items" : { "$ref" : "#/definitions/UpdateDemandCustomerResponseModel" } } } }, "UpdateDemandCustomerResponseModel" : { "type" : "object", "required" : [ "category", "customerNo", "title" ], "properties" : { "eic" : { "type" : "string", "description" : "It keeps meter EIC." }, "demandPeriod" : { "type" : "string", "format" : "date-time", "description" : "It keeps term info." }, "demandType" : { "type" : "string", "description" : "It keeps demand type.", "enum" : [ "NEW", "SUPPLIER_CHANGED", "PORTFOLIO_OUT", "EVACUATION", "NEW_PRE_DECLARATION", "SUPPLIER_CHANGED_PRE_DECLARATION", "PORTFOLIO_OUT_PRE_DECLARATION", "NEW_DEFINITE_DECLARATION", "SUPPLIER_CHANGED_DEFINITE_DECLARATION", "PORTFOLIO_OUT_DEFINITE_DECLARATION", "EVACUATION_DEFINITE_DECLARATION", "NEW_MULTIPLE", "SUPPLIER_CHANGED_MULTIPLE", "METERING_POINT_PASSIVE", "AUTO" ] }, "demandStatus" : { "type" : "string", "description" : "It keeps demand's status. ACTIVE, PASSIVE.", "enum" : [ "ACTIVE", "PASSIVE" ] }, "demandOrganization" : { "type" : "string", "description" : "#{METERING_POINT_DEMAND_ORGANIZATION}" }, "category" : { "type" : "string", "description" : "Customer category", "enum" : [ "NATURAL", "PUBLIC", "PRIVATE", "CORPORATION", "FOREIGN" ] }, "customerNo" : { "type" : "string", "description" : "Customer no" }, "title" : { "type" : "string", "description" : "Customer title" }, "authorizedPersonName" : { "type" : "string", "description" : "Authorized Person name" }, "authorizedPersonNo" : { "type" : "string", "description" : "Authorized Person no" }, "authorizedPersonName2" : { "type" : "string", "description" : "Authorized Person2 name" }, "authorizedPersonNo2" : { "type" : "string", "description" : "Authorized Person2 no" }, "description" : { "type" : "string", "description" : "Ölçüm noktas?n?n kaydedilmemesi durumunda ald??? hatan?n aç?klama bilgisini tutar." }, "status" : { "type" : "string", "description" : "Response status of the demand save operation.", "enum" : [ "SUCCESS", "FAILED" ] } }, "description" : "Demand Customer Update Response Data List", "xml" : { "name" : "updateDemandCustomerResponseModel" } }, "UploadFormRequest" : { "type" : "object", "required" : [ "body" ], "properties" : { "header" : { "type" : "array", "description" : "Keeps request header informations.", "items" : { "$ref" : "#/definitions/Header" } }, "body" : { "description" : "Keeps request body informations.", "$ref" : "#/definitions/UploadFormRequestModel" } }, "description" : "Form Upload Request" }, "UploadFormRequestModel" : { "type" : "object", "required" : [ "fileContent", "meteringPointEic" ], "properties" : { "meteringPointEic" : { "type" : "string", "description" : "It keeps meter EIC." }, "fileName" : { "type" : "string", "description" : "File Name" }, "fileContent" : { "type" : "string", "description" : "File Content as Base64 Format" } }, "description" : "Form Upload Request Body" }, "UploadFormResponse" : { "type" : "object", "required" : [ "resultCode", "resultDescription", "resultType" ], "properties" : { "resultCode" : { "type" : "string", "example" : "0", "description" : "0 means success other values may differ for each request" }, "resultDescription" : { "type" : "string", "example" : "OK", "description" : "if requests succeed return OK otherwise returns error description" }, "resultType" : { "type" : "string", "example" : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR", "description" : "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", "enum" : [ "SUCCESS", "BUSINESSERROR", "SYSTEMERROR", "SECURITYERROR" ] }, "body" : { "$ref" : "#/definitions/BooleanResponse" } } }, "ValidateDemandResponseList" : { "type" : "object", "properties" : { "demands" : { "type" : "array", "description" : "Demand informations that will be validated.", "items" : { "$ref" : "#/definitions/MeteringPointDemandValidate" } } } } } }