![\"PSR](\"https://www.energylinx.co.uk/postman-docs/psr-questions.png\")
Energylinx APIs are used throughout the UK energy industry by many types of user:
\nThis platform contains access to our Sandbox environment and a number of APIs that we hope will be of interest to you.
\nPricing data within this Sandbox environment is synced every hour with our production database.
\nWe throttle the Sandbox area so that its performance has restrictions in terms of concurrency and speed.
\nMany of the APIs here will operate without any credentials whereas you will find our core APIs require your own set of credentials.
\nTo obtain your access please contact our API Team on 01259 220000 or ken.geddes@energylinx.com or kenny.griffith@energylinx.com.
\nThis documentation IS NOT COMPLETE but we aim to keep improving it. A variation of this documentation is available at https://apis2.awsprod.energylinx.com/docs/ which uses code introspection to generate the documentation and it could provide more useful detail until this edition reaches maturity.
\nDue to rapid evolution of the APIs, our version strategy is not conventional. We version by the endpoint, not the API suite. Our advice is that you use the highest version endpoint published in the documentation for the functionality that you are trying to achieve. Publishing of a higher version endpoint automatically deprecates all lower versions of that endpoint although we may keep the lower versions in operation for as long as it may take for all clients to upgrade.
\nWe do not currently have a mechanism to inform all clients of upgraded endpoints when they are published but we are working on establishing a blog or online forum or a notification list to do that.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"318581","collectionId":"9c53cbed-aec3-4d8a-8936-ee9534b2bb2b","publishedId":"SztBbTXu","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-05-10T13:34:31.000Z"},"item":[{"name":"Throttle Limits","item":[],"id":"fa42b616-3cee-48be-9c33-1a3c985f2eea","description":"API supports throttling. That means it will refuse to talk to the client if he reaches a configured number of requests.
\nLimits are set in settings_awsprod.py
https://github.com/ENERGYLINX/elex-apis2/blob/master/elexapis2/settings_awsprod.py#L90
There may be some exceptions saved in the admin area.
\n","event":[{"listen":"prerequest","script":{"id":"25d49cfa-483e-4773-b161-78373d3c05f9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e5bb681b-d411-44fe-9af6-3578b52f74c4","type":"text/javascript","exec":[""]}}],"_postman_id":"fa42b616-3cee-48be-9c33-1a3c985f2eea"},{"name":"API status and error messages","item":[],"id":"9b71de56-09b3-4dba-aa40-376044f38a51","description":"A message is a tuple. On first position is human readable message and on second position is error_code.
\nThis messages works only with our api.exceptions.APIException!
\nAll error_codes started from 1000 because HTTP has own numbers.
\nThe interpretation of the final status condition involves three fields:
\nThere are four groups of status conditions and the flow between them is as follows:
\nTariff and Supplier listing endpoints are important endpoints for bulding a typical web journey. They allow the web developer to streamline drop-down menus to be shown to the end user by using filters. The more information that a journey can send into the filter, the better the probability of a successful quote.
\nThe latest version of the supplier listing endpoint is v3.1 and the tariff listing endpoint is v3.2.
\nA typical input json for the suppliers list looks like:
\n{\n \"distIds\": [\"16\"],\n \"payTypes\": [1],\n \"fuelTypes\": [\"elecgas\"],\n \"meterTypesElec\": [\"E7\"],\n \"datesToUse\": \"onsale-dates\"\n}
\nOnce a supplier is selected, the same input json as above can be used with an additional \"supplierName\" input which is a mandatory input.
\nAll of the above filter inputs are optional. If a filter input is missing or is an empty list, the endpoint assumes that all possible values in the list are in the request.
\nSome notes on datesToUse.
\nonsale-dates:
\nOnsale dates are used for the query. That means that only tariffs which are offered for sale at the present moment will be returned. A typical use case for such a query is if you are building a client application which needs to show tariffs which a domestic consumer could switch to today.
\nIn a comparison site UI flow, you might like to ask the domestic consumer to choose from a list of tariffs that she might be interested in switching to and in that scenario, you would use this view.
\nregulatory-dates:
\nRegulatory dates are used for the query. That means that only tariffs that a domestic consumer could be using will be returned. A typical use case for such a query is if you are building a client application which needs to show tariffs which a domestic consumer could be using today.
\nIn a comparison site UI flow, you might like to ask the domestic consumer to choose from a list of existing tariffs in preparation for issuing a quote and in that scenario, you would use this view.
\nregulatory-dates-with-3-month-buffer:
\nSame as above except that the regulatory end date is extended by 3 months. So, it can return a few more tariffs than above. This the default value if not provided in input.
\nno-dates:
\nAll tariffs offered at any point in time will be returned but this view is only available for cients authenticated as super users.
\n","event":[{"listen":"prerequest","script":{"id":"8530ada3-4953-43e3-a8b2-e313498db2fe","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"086610d6-d2c2-47dd-ae61-da982ec02165","type":"text/javascript","exec":[""]}}],"_postman_id":"261e95ea-a911-4e62-8e0e-44b9e77978f7"},{"name":"Quotes","item":[{"name":"Gas Only Quote","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests['Status code is 200'] = responseCode.code === 200;","var jsonData = JSON.parse(responseBody);","var inputData = JSON.parse(request.data);","postman.setEnvironmentVariable('supply_subb', inputData.supplySubb);","postman.setEnvironmentVariable('supply_bnam', inputData.supplyBnam);","postman.setEnvironmentVariable('supply_bnum', inputData.supplyBnum);","postman.setEnvironmentVariable('mpan_data', JSON.stringify(jsonData.data));",""]}}],"id":"588757eb-7642-4f3e-a41d-f339b05d278f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{partner_auth}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"includeTestTariffs\": false,\n \"postcode\": \"FK10 3SA\", \n \"dnoArea\": \"\",\n \"existingSupplierIdGas\": null,\n \"existingSupplierNameGas\": \"British Gas\", \n \"existingTariffNameGas\": \"Standard\", \n \"meterTypeGas\": \"\", \n \"existingPayTypesGas\": [1,2,3], \n \"desiredPayTypes\": [1,2,3], \n \"existingkWhsGas\": \"3300\", \n \"existingkWhsIntervalGas\": \"year\",\n \"existingSpendGas\": null, \n \"existingSpendIntervalGas\": \"\",\n \"existingPaperlessGas\": null, \n \"hasSmartMeterGas\": null, \n \"hasGreenDeal\": null, \n \"hasIgtMeter\": null,\n\n \"filterSupplierGroupId\": null,\n \"filterSupplierGroup\": \"\", \n \"filterTariffNames\": [], \n \"filterPaperlessBilling\": \"NO\", \n \"filterTariffComparison\": \"all\",\n \"filterCompetitorRange\": \"\",\n \"useDefaultExistingSuppliers\": false,\n\n \"flagCallName\": \"\",\n \"searchStartDate\": null,\n \"searchEndDate\": null,\n \"switchDate\": null,\n\n \"rmrCompliantCalculation\": true, \n \"showTcr\": true, \n \"showNewTil\": true,\n \"showExistingTil\": true,\n \"sortBy\": \"\",\n \"showHistoricTariffs\": false,\n \"rmrCompliantCalculationNew\": true,\n \"rmrNonCompliantCalculation\": true,\n\n \"unknownUsageTypeGas\": \"\",\n \"ofgemAverageGas\": \"\",\n \"peopleGas\": null,\n \"typeOfHomeGas\": null,\n \"bedroomsGas\": null,\n \"readingStartDateGas\": null,\n \"readingStartGas\": null,\n \"readingEndDateGas\": null,\n \"readingEndGas\": null,\n \"readingMeasuringUnitGas\": \"\",\n \"title\": \"Mr\",\n \"forename\": \"Test\",\n \"surname\": \"Test\",\n \"email\": \"cx@initd.cz\",\n \"phone\": \"07777636388\",\n \"dpaSupplierEmail\": true,\n \"bnamOrBnum\": \"Test 1234\"\n}"},"url":"{{host}}/v2.2/partner-resources/{{partner_affiliate_id}}/quotes/gas/","description":"Explanation of some input fields. The same input fields are repeated in the elecgas (dual fuel) quote inputs so this explanation applies to the elecgas/ endpoint also:
\n","urlObject":{"path":["v2.2","partner-resources","{{partner_affiliate_id}}","quotes","gas",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"588757eb-7642-4f3e-a41d-f339b05d278f"},{"name":"Electricity Only Quote","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests['Status code is 200'] = responseCode.code === 200;","var jsonData = JSON.parse(responseBody);","var inputData = JSON.parse(request.data);","postman.setEnvironmentVariable('supply_subb', inputData.supplySubb);","postman.setEnvironmentVariable('supply_bnam', inputData.supplyBnam);","postman.setEnvironmentVariable('supply_bnum', inputData.supplyBnum);","postman.setEnvironmentVariable('mpan_data', JSON.stringify(jsonData.data));",""]}}],"id":"a9421819-10f9-46e7-8e4f-3ef93e2062d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{partner_auth}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"includeTestTariffs\": false,\n \"postcode\": \"E18 2HN\", \n \"dnoArea\": \"\",\n \"existingSupplierIdElec\": null,\n \"existingSupplierNameElec\": \"British Gas\", \n \"existingTariffNameElec\": \"Standard\", \n \"meterTypeElec\": \"STD\", \n \"nightUsePercentElec\": null, \n \"existingPayTypesElec\": [1], \n \"desiredPayTypes\": [1], \n \"existingkWhsElec\": \"3300\", \n \"existingkWhsIntervalElec\": \"year\",\n \"existingSpendElec\": null, \n \"existingSpendIntervalElec\": \"\",\n \"mainsGas\": true, \n \"existingPaperlessElec\": null, \n \"hasSmartMeterElec\": null, \n \"hasGreenDeal\": null, \n \"hasIgtMeter\": null,\n\n \"filterSupplierGroupId\": null,\n \"filterSupplierGroup\": \"\", \n \"filterTariffNames\": [], \n \"filterPaperlessBilling\": \"\", \n \"filterTariffComparison\": \"all\",\n \"filterCompetitorRange\": \"\",\n \"useDefaultExistingSuppliers\": false,\n\n \"flagCallName\": \"\",\n \"searchStartDate\": null,\n \"searchEndDate\": null,\n \"switchDate\": null,\n\n \"rmrCompliantCalculation\": true, \n \"showTcr\": true, \n \"showNewTil\": true,\n \"showExistingTil\": true,\n \"sortBy\": \"\",\n \"showHistoricTariffs\": false,\n \"rmrCompliantCalculationNew\": true,\n \"rmrNonCompliantCalculation\": true,\n\n \"unknownUsageTypeElec\": \"\",\n \"ofgemAverageElec\": \"\",\n \"peopleElec\": null,\n \"typeOfHomeElec\": null,\n \"bedroomsElec\": null,\n \"readingStartDateElec\": null,\n \"readingStartStdElec\": null,\n \"readingStartE7Elec\": null,\n \"readingEndDateElec\": null,\n \"readingEndStdElec\": null,\n \"readingEndE7Elec\": null,\n \"title\": \"Mr\",\n \"forename\": \"Test\",\n \"surname\": \"Test\",\n \"email\": \"cx@initd.cz\",\n \"phone\": \"07777636388\",\n \"dpaSupplierEmail\": true,\n \"bnamOrBnum\": \"Test 1234\"\n}"},"url":"{{host}}/v2.2/partner-resources/{{partner_affiliate_id}}/quotes/elec/","description":"Explanation of some input fields. The same input fields are repeated in the elecgas (dual fuel) quote inputs so this explanation applies to the elecgas/ endpoint also:
\nExplanation of some input fields:
\nAt time of quote, you should ask your customers whether they have smart meters for each fuel, or obtain this information through MPAS addressing data lookup. Pass this information as true/false in the hasSmartMeterElec and hasSmartMeterGas fields in the Quote request.
\nA few tariffs on the market may only be available for customers with smart meters, or only be available to customers who do not have smart meters.
\nTariffs with a tariffTypeRegulatory of \"smart-meter-mandatory\" are only shown in our search results if we positively know all the relevant customer fuels (gas and/or electricity) are smart meters. Conversely, \"smart-meter-disallowed\" tariffs are only shown if we positively know all relevant fuels are NOT smart meters. If hasSmartMeterElec|Gas is not supplied in the quote request as true or false, then all \"smart-meter-mandatory\" and \"smart-meter-disallowed\" tariffs will be hidden.
\n","urlObject":{"path":["v2.2","partner-resources","{{partner_affiliate_id}}","quotes","elecgas",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b7ddaa0-b964-4ef9-ba41-a6aac6fd2d3a"}],"id":"0cdf1863-1c75-42b0-84ea-841faea8c680","description":"The endpoints under the quotes/ space are a set of endpoints that provide you with:
These endpoints are the most complex and the most commonly used endpoints and it will take a bit of practice to understand how to use them.
\nYou can set your inputs to return a whole of market response or refine the response to a particular supplier or a range of tariffs from one supplier.
\nYou can also set your inputs to return tariff information label information (TIL) fields although this is typically not used in the majority of requests.
\nYou can also set your inputs to switch between RMR compliant and non-compliant calculations for the estimates.
\nThere are ways to reduce the complexity of the inputs:
\nuseDefaultExistingSuppliers. This lets you skip all existing supplier information and sets that to be the default supplier for the region. You can see it in the 'minimal' examples below.There are three major variations of quotes, viz.
\nquotes/elec/: electricity only quotesquotes/gas/: gas only quotesquotes/elecgas: dual fuel quotes, i.e. electricity and gas tariffs bundled together with some dual fuel discounts.Some of the common inputs of all three variations are documented here.
\nuseDefaultExistingSuppliers: Please see table below for default suppliers for each region. If you set this flag to be true, these suppliers will be assumed and the existing suppliers for quotes along with their standard tariffs.
See below for full documentation.
\n","urlObject":{"path":["v3.3","partner-resources","{{partner_affiliate_id}}","supplier-details","5",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b5c8c9eb-6ebc-470a-b50b-20ffbca74e70"},{"name":"All suppliers example","event":[{"listen":"test","script":{"id":"86887cec-b493-4c74-bf11-9c041294b5b6","exec":["tests['Status code is 200'] = responseCode.code === 200;","","var jsonData = JSON.parse(responseBody);","","tests['Response body contains msg'] = jsonData.hasOwnProperty('message');","tests['Response body contains statusCode'] = jsonData.hasOwnProperty('statusCode');","tests['StatusCode is 1041'] = jsonData.statusCode === 1041;","tests['Response body contains data'] = jsonData.hasOwnProperty('data');","","tests['Data contains supplierName'] = jsonData.data.hasOwnProperty('supplierName');","tests['Data contains supplierId'] = jsonData.data.hasOwnProperty('supplierId');","tests['Data contains supplierSlug'] = jsonData.data.hasOwnProperty('supplierSlug');","tests['Data contains supplierGroupName'] = jsonData.data.hasOwnProperty('supplierGroupName');","tests['Data contains supplierImageUrls'] = jsonData.data.hasOwnProperty('supplierImageUrls');","","tests['supplierImageUrls has at least one element'] = jsonData.data.supplierImageUrls.length > 1;","","tests['supplierImageUrls[0] contains name'] = jsonData.data.supplierImageUrls[0].hasOwnProperty('name');","tests['supplierImageUrls[0] name is width-640'] = jsonData.data.supplierImageUrls[0].name = 'width-640';","tests['supplierImageUrls[0] contains url'] = jsonData.data.supplierImageUrls[0].hasOwnProperty('url');","","tests['supplierImageUrls[1] contains name'] = jsonData.data.supplierImageUrls[1].hasOwnProperty('name');","tests['supplierImageUrls[1] name is facebook'] = jsonData.data.supplierImageUrls[1].name = 'facebook';","tests['supplierImageUrls[1] contains url'] = jsonData.data.supplierImageUrls[1].hasOwnProperty('url');","","tests['supplierImageUrls[0] url contains supplierSlug'] = jsonData.data.supplierImageUrls[0].url.includes(jsonData.data.supplierSlug);","tests['supplierImageUrls[1] url contains supplierSlug'] = jsonData.data.supplierImageUrls[1].url.includes(jsonData.data.supplierSlug);","","","","","","","",""],"type":"text/javascript"}}],"id":"0d783f70-c0f7-4a8f-bc02-c78ab3047dfb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{partner_auth}}","type":"text"}],"url":"{{host}}/v3.3/partner-resources/{{partner_affiliate_id}}/supplier-details/","description":"The /supplier-details endpoint indicates which accompanying similarly-named /signups API fields are enabled and/or mandatory for particular suppliers. It also supplies some UI question prompt text which has been vetted by suppliers' legal departments.
\nCall the /supplier-details endpoint per supplier (e.g. /supplier-details/{{supplierId}}/), or get a list of all suppliers by leaving off {{supplierId}}.
\nThis summarizes the breaking changes in /supplier-details and /signups since v3.0:
\nv3.2 /signups requires the use of psr* fields, some of which can be conditionally mandatory based on /supplier-details. See section entitled: \"PSR fields in /supplier-details which affect /signups\" below.
\nv3.3 /signups expands on this, with more fields that are conditionally mandatory based on /supplier-details. Many are GDPR Consent fields. See section entitled: \"/supplier-details fields which affect /signups\" below.
\nThe data structure of the /supplier-details endpoint has changed as of v3.2:
\n\"data\": {\n \"records\": [], /* this is a list of supplier-details for each supplier returned */\n \"defaults\": {} /* this is a dict of DEFAULT values for any value left blank in section above */\n}\nA collection of PSR questions should be presented if psrShowSection is true. The responses are collected through /signup API in fields: psrChoiceMain1|2|3 (answers from up to 3 dropdowns), psrChoiceSub1|2|3 (answers to optional dependent dropdowns based on the respective psrChoiceMain1|2|3), psrCustomAnswer1, and psrCustomAnswer2. You can see a live example at work on our own site, energylinx.co.uk:
Under the \"defaults\" dict, you will see the PSR menu options and prompt to use in your UI:
\n \"defaults\": {\n \"psrMainQuestionPrompt\": The Priority Services Register (PSR) is a free service provided by suppliers and network operators to customers in need. Please select any need that reflects your own circumstances.\",\n \"psrMainMenuList\": /* this populates the 0, 1, or 3 main dropdowns */\n [\n {\n \"groupName\": \"Medically Dependant\",\n \"name\": \"Apnoea Monitor\",\n \"value\": \"01.1\"\n },\n {\n \"groupName\": \"Medically Dependant\",\n \"name\": \"Automated Medication\",\n \"value\": \"03.1\"\n },\n ...\n ],\n \"psrSubMenuList\": /* this only appears dependent on certain psrMainMenuList items chosen */\n [\n {\n \"mainValue\": \"22\", /* this sub-list item to appear if 22 is selected from Main list dropdown */\n \"name\": \"Asthma\",\n \"value\": \"d\"\n },\n {\n \"mainValue\": \"22\", /* this sub-list item to appear if 22 is selected from Main list dropdown */\n \"name\": \"Cancer\",\n \"value\": \"a\"\n },\n ...\n ]\n }\nThe signup API must allow these questions to be received and stored. The new field names are:
\n[*] REQUIRED if psrCustomQuestionMandatory1 (resp. psrCustomQuestionMandatory2) is \"yes\" or \"yes-if-psr-chosen\" and psrChoiceMain1 was sent.
Some examples of a variety of PSR conditions, as of Oct. 2018:
\npsrShowSection set to true.psrCustomQuestionType1|2 of \"freeform\".psrMainQuestionPrompt, but don't ask the user to choose or input ANYTHINGOUTSIDE of the /supplier-details \"records\" dict is a \"defaults\" dict. This specifies settings across all suppliers if they have not overridden them (left them blank):
\nconsentSupplierCreditCheckConfigconsentSupplierMarketingConfigconsentSupplierMarketingPartnerConfigpromptText in the supplier-details \"defaults\" dict may contain {{supplierName}} (a Handlebars-style variable to be filled in with the supplier's name) and may contain HTML links.
Fields consentSupplierMarketingConfig and consentSupplierMarketingPartnerConfig contain display-related info regarding GDPR consents.
Key to this design is a \"Yes\" or \"No\" question MUST be positively selected by a user action (neither can be selected by default). If \"Yes\" is selected, then the specific contact methods listed (email/phone/post/etc.) can be chosen from.
\nIf contactMethods is empty, contactMethodIfNone will be populated. This removes the choice among contact methods and just leaves a Yes/No option. If contactMethodIfNone is \"email\", the API will expect to store the Yes/No answer in the relevant *email field.
Example JSON:
\nconsentSupplierMarketingConfig:
{\n \"headerText\": \"Stay in the loop\",\n \"introText\": \"Nearly one million customers count on us to help save them money on their household bills and make running their home easier. You can benefit too. Be the first to hear from First Utility about:\",\n \"bulletText1\": \"New deals on home products\",\n \"bulletText2\": \"Discounts, offers and new products\",\n \"bulletText3\": \"Advice and competitions via our newsletter\",\n \"bulletText4\": \"\",\n \"promptText\": \"If you're happy to receive this information from First Utility please tell us how you'd like to hear from them:\",\n \"contactMethods\": [\"email\", \"sms\", \"phone\"],\n \"contactMethodIfNone\": \"\",\n \"footerText\": \"\"\n }\nconsentSupplierMarketingPartnerConfig:
{\n \"headerText\": \"Offers from trusted partners\",\n \"introText\": \"We want you to know that we never sell your data to third parties for marketing purposes. We work with selected third parties to bring you extras, from smart home cameras to smart thermostats and more. Would you like to hear about these products and exclusives?\",\n \"promptText\": \"\",\n \"contactMethodIfNone\": \"email\",\n \"footerText\": \"You will be able to change your preferences at any time. First Utility will provide you with details of your \\\"My Account\\\" as part of their onboarding pack\"\n }\n
This should then be rendered as:
![\"GDPR](\"https://www.energylinx.co.uk/postman-docs/supplier-consent-questions.png\")
supplierImageUrls (array[ImgixEntrySerializer]):
Eight weeks after a customer switches energy through the Energylinx.co.uk web site or one of our white labels, they are sent an e-mail and requested to rate their supplier.
\nThe results of these are available through the /supplier-details endpoint. Ratings data are kept over the last five years on a rolling basis. The fields include:
\nThese ratings will appear as null unless you have requested they be enabled. Please contact your account manager to have them enabled.
\nOnce enabled, a call to v3.3 /supplier-details will show you these ratings fields, for example:
\n \"ratingOverall\": 4.12849,\n \"ratingOverallCount\": 179,\n \"ratingSwitchingEase\": 4.12571,\n \"ratingSwitchingEaseCount\": 175,\n \"ratingTariffPricing\": 4.09357,\n \"ratingTariffPricingCount\": 171,\n \"ratingSupplierCommunication\": 3.62644,\n \"ratingSupplierCommunicationCount\": 174,\n \"ratingSupplierInformation\": 3.73714,\n \"ratingSupplierInformationCount\": 175\n(If there are no ratings, the count fields can be 0 and the non-count fields can be null)
\nThere are only two per-supplier rules which are not encapsulated by supplier-details:
\nSome tariffs require a mobile phone number. Since this is not supplier-level information, you can determine this by checking the phoneMobileMandatory field returned for each tariff within the response of the /quotes API.
\nOVO Energy requires a securityAnswer (free-form), and a securityQuestionCode (menu choice). securityQuestionCode choices are:
\nThis method will get MPAN signup data (MPAN, electric meter serial numbers) for the input supply address from 'energylinx' data source.
\nsupplyPcod is required.
{\n \"mpanLower\": \"\",\n \"mpanTopLine\": \"\",\n \"meterSerialElec\": \"\"\n}\nThis method will get MPRN signup data (MPRN, gas meter serial number) for the input supply address from 'energylinx' data source.
\nsupplyPcod is required.
{\n \"mprn\": \"\",\n \"meterSerialGas\": \"\"\n}\nThis method will generate a unique signupId to associate with partial updates of input fields into the temporary store.
\n{\n \"signupTag\": \"\"\n}\nThis method read all the input fields saved into the temporary store for the given signupId.
\nmpanData (MpanDataSerializer) format:
mprnData (MprnDataSerializer) format:
This method will write the input fields (even if only a subset of them are supplied) into a temporary store to be committed into the resultsTable later.
\n","urlObject":{"path":["v3.3","partner-resources","{{partner_affiliate_id}}","signups","{{signup_tag}}",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec3d06b8-ef6c-4d58-8743-cc9b9d656c01"},{"name":"Commit signup input fields","event":[{"listen":"test","script":{"id":"6e30e9b5-aed2-4f75-af84-57531ecbe961","exec":["tests['Status code is 200'] = responseCode.code === 200;","var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable('signup_id', JSON.stringify(jsonData.data.signupId));"],"type":"text/javascript"}}],"id":"77f82147-4112-452f-87fc-87b0b3c13370","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"{{partner_auth}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{host}}/v3.3/partner-resources/{{partner_affiliate_id}}/signups/commit/{{signup_tag}}/","description":"This method will commit all the input fields for the given signupId from the temporary store into the resultsTable database.
\n{\n \"signupId\": 123456\n}\nView to cancel signups given a list of signup ids as input. Cancellation is a complex transaction which involves updating several tables in the database and cancellation notices sent to applicant, energylinx staff and supplier. In case of cancellation failure, you can assume that email to supplier was not sent because it is the last part of the transaction. But you might have to follow up with applicant and energylinx admin team to prevent confusion.
\nsignupId and postcode are required.
This method will delete all the input fields for the giving signupId from the temporary store.
\n","urlObject":{"path":["v3.3","partner-resources","{{partner_affiliate_id}}","signups","{{signup_tag}}",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"72bf7eee-642f-4e63-a3ff-979622e2234c"}],"id":"7b8ed748-3fd1-4c2e-a401-1d4533dad296","_postman_id":"7b8ed748-3fd1-4c2e-a401-1d4533dad296","description":""},{"name":"SVT Tariffs","item":[{"name":"E.ON","event":[{"listen":"test","script":{"id":"1e665d4a-c64c-464e-9129-48e856783f25","exec":["tests['Status code is 200'] = responseCode.code === 200;","","var jsonData = JSON.parse(responseBody);","","tests['Response body contains msg'] = jsonData.hasOwnProperty('message');","tests['Response body contains statusCode'] = jsonData.hasOwnProperty('statusCode');","tests['StatusCode is 1034'] = jsonData.statusCode === 1034;","tests['Response body contains data'] = jsonData.hasOwnProperty('data');","","tests['Data contains standardTariffs'] = jsonData.data.hasOwnProperty('standardTariffs');","tests['standardTariffs has at least 1 element'] = jsonData.data.standardTariffs.length >= 1;","","allowedFuelTypes = ['gas', 'elec', 'elecgas'];","allowedPayTypes = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];","tuplesSeen = [];","","for (i = 0; i < jsonData.data.standardTariffs.length; ++i) {"," "," tests['standardTariffs[i] contains fuelType'] = jsonData.data.standardTariffs[i].hasOwnProperty('fuelType');"," fuelType = jsonData.data.standardTariffs[i].fuelType;"," tests['standardTariffs[i] fuelType is one of elec, gas, elecgas'] = allowedFuelTypes.includes(fuelType);"," "," tests['standardTariffs[i] contains payType'] = jsonData.data.standardTariffs[i].hasOwnProperty('payType');"," payType = jsonData.data.standardTariffs[i].payType;"," tests['standardTariffs[i] fuelType is one of 1 to 13 inclusive'] = allowedPayTypes.includes(payType);"," "," tuple = fuelType + payType.toString();"," "," tests['standardTariffs[i] fuelType, payTypes tuple not seen before'] = !tuplesSeen.includes(tuple);"," "," tuplesSeen.push(tuple);","}","",""],"type":"text/javascript"}}],"id":"106692ef-a7fa-4b1b-b8a0-a33080c5bffe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{partner_auth}}"}],"body":{"mode":"raw","raw":"{\n \"supplierName\": \"E.ON\"\n}"},"url":"{{host}}/v3/partner-resources/{{partner_affiliate_id}}/tariffs-standard-by-supplier-name/","urlObject":{"path":["v3","partner-resources","{{partner_affiliate_id}}","tariffs-standard-by-supplier-name",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"106692ef-a7fa-4b1b-b8a0-a33080c5bffe"},{"name":"EDF Energy","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests['Status code is 200'] = responseCode.code === 200;","","var jsonData = JSON.parse(responseBody);","","tests['Response body contains msg'] = jsonData.hasOwnProperty('message');","tests['Response body contains statusCode'] = jsonData.hasOwnProperty('statusCode');","tests['StatusCode is 1034'] = jsonData.statusCode === 1034;","tests['Response body contains data'] = jsonData.hasOwnProperty('data');","","tests['Data contains standardTariffs'] = jsonData.data.hasOwnProperty('standardTariffs');","tests['standardTariffs has at least 1 element'] = jsonData.data.standardTariffs.length >= 1;","","allowedFuelTypes = ['gas', 'elec', 'elecgas'];","allowedPayTypes = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];","tuplesSeen = [];","","for (i = 0; i < jsonData.data.standardTariffs.length; ++i) {"," "," tests['standardTariffs[i] contains fuelType'] = jsonData.data.standardTariffs[i].hasOwnProperty('fuelType');"," fuelType = jsonData.data.standardTariffs[i].fuelType;"," tests['standardTariffs[i] fuelType is one of elec, gas, elecgas'] = allowedFuelTypes.includes(fuelType);"," "," tests['standardTariffs[i] contains payType'] = jsonData.data.standardTariffs[i].hasOwnProperty('payType');"," payType = jsonData.data.standardTariffs[i].payType;"," tests['standardTariffs[i] fuelType is one of 1 to 13 inclusive'] = allowedPayTypes.includes(payType);"," "," tuple = fuelType + payType.toString();"," "," tests['standardTariffs[i] fuelType, payTypes tuple not seen before'] = !tuplesSeen.includes(tuple);"," "," tuplesSeen.push(tuple);","}","",""]}}],"id":"54b74b5d-aafd-44f6-89a9-25b06a03667f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{partner_auth}}"}],"body":{"mode":"raw","raw":"{\n \"supplierName\": \"EDF Energy\"\n}"},"url":"{{host}}/v3/partner-resources/{{partner_affiliate_id}}/tariffs-standard-by-supplier-name/","urlObject":{"path":["v3","partner-resources","{{partner_affiliate_id}}","tariffs-standard-by-supplier-name",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"54b74b5d-aafd-44f6-89a9-25b06a03667f"},{"name":"ScottishPower","event":[{"listen":"test","script":{"id":"794001e6-50d1-4db5-a602-1b6b8daae219","exec":["tests['Status code is 200'] = responseCode.code === 200;","","var jsonData = JSON.parse(responseBody);","","tests['Response body contains msg'] = jsonData.hasOwnProperty('message');","tests['Response body contains statusCode'] = jsonData.hasOwnProperty('statusCode');","tests['StatusCode is 1034'] = jsonData.statusCode === 1034;","tests['Response body contains data'] = jsonData.hasOwnProperty('data');","","tests['Data contains standardTariffs'] = jsonData.data.hasOwnProperty('standardTariffs');","tests['standardTariffs has at least 1 element'] = jsonData.data.standardTariffs.length >= 1;","","allowedFuelTypes = ['gas', 'elec', 'elecgas'];","allowedPayTypes = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13];","tuplesSeen = [];","","for (i = 0; i < jsonData.data.standardTariffs.length; ++i) {"," "," tests['standardTariffs[i] contains fuelType'] = jsonData.data.standardTariffs[i].hasOwnProperty('fuelType');"," fuelType = jsonData.data.standardTariffs[i].fuelType;"," tests['standardTariffs[i] fuelType is one of elec, gas, elecgas'] = allowedFuelTypes.includes(fuelType);"," "," tests['standardTariffs[i] contains payType'] = jsonData.data.standardTariffs[i].hasOwnProperty('payType');"," payType = jsonData.data.standardTariffs[i].payType;"," tests['standardTariffs[i] fuelType is one of 1 to 13 inclusive'] = allowedPayTypes.includes(payType);"," "," tuple = fuelType + payType.toString();"," "," tests['standardTariffs[i] fuelType, payTypes tuple not seen before'] = !tuplesSeen.includes(tuple);"," "," tuplesSeen.push(tuple);","}","",""],"type":"text/javascript"}}],"id":"a5817101-b3ad-4341-8110-b93b34676ce8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{partner_auth}}"}],"body":{"mode":"raw","raw":"{\n \"supplierName\": \"ScottishPower\"\n}"},"url":"{{host}}/v3/partner-resources/{{partner_affiliate_id}}/tariffs-standard-by-supplier-name/","urlObject":{"path":["v3","partner-resources","{{partner_affiliate_id}}","tariffs-standard-by-supplier-name",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a5817101-b3ad-4341-8110-b93b34676ce8"}],"id":"229c6239-9ff3-4678-9593-3c23182b789f","event":[{"listen":"prerequest","script":{"id":"41308ebe-eec6-493b-954e-4675bf585c6f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5f96f135-88cf-4443-a25a-791d2355e874","type":"text/javascript","exec":[""]}}],"_postman_id":"229c6239-9ff3-4678-9593-3c23182b789f","description":""}],"event":[{"listen":"prerequest","script":{"id":"b48d9309-6dd4-49e1-b891-870e6a450611","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f6ae5f77-5899-4bce-8a00-1c634b49b916","type":"text/javascript","exec":[""]}}]}