POST request/supplier/targetmarket/bespoke

Request Information

URI Parameters

None.

Body Parameters

BespokeConfigPost
NameDescriptionTypeAdditional information
ContractTypes

Collection of ContractType

None.

FuelTypes

Collection of FuelType

None.

MeterSupplyTypes

Collection of MeterSupplyType

None.

MeterTypes

Collection of MeterType

None.

PaymentTypes

Collection of PaymentType

None.

RenewalTypes

Collection of RenewalType

None.

TargetPortfolios

Collection of TargetPortfolio

None.

TargetSectors

Collection of TargetSector

None.

Request Formats

application/json, text/json

Sample:
{
  "meterSupplyTypes": [
    {
      "id": 1,
      "label": "sample string 2",
      "isChecked": true
    },
    {
      "id": 1,
      "label": "sample string 2",
      "isChecked": true
    }
  ],
  "meterTypes": [
    {
      "id": 1,
      "label": "sample string 2",
      "isChecked": true
    },
    {
      "id": 1,
      "label": "sample string 2",
      "isChecked": true
    }
  ],
  "targetSectors": [
    {
      "id": 1,
      "label": "sample string 2",
      "isChecked": true
    },
    {
      "id": 1,
      "label": "sample string 2",
      "isChecked": true
    }
  ],
  "contractTypes": [
    {
      "id": 1,
      "label": "sample string 2",
      "isChecked": true
    },
    {
      "id": 1,
      "label": "sample string 2",
      "isChecked": true
    }
  ],
  "renewalTypes": [
    {
      "id": 1,
      "label": "sample string 2",
      "isChecked": true
    },
    {
      "id": 1,
      "label": "sample string 2",
      "isChecked": true
    }
  ],
  "fuelTypes": [
    {
      "id": 1,
      "label": "sample string 2",
      "isChecked": true
    },
    {
      "id": 1,
      "label": "sample string 2",
      "isChecked": true
    }
  ],
  "targetPortfolios": [
    {
      "id": 1,
      "label": "sample string 2",
      "isChecked": true
    },
    {
      "id": 1,
      "label": "sample string 2",
      "isChecked": true
    }
  ],
  "paymentTypes": [
    {
      "id": 1,
      "label": "sample string 2",
      "isChecked": true
    },
    {
      "id": 1,
      "label": "sample string 2",
      "isChecked": true
    }
  ]
}

text/html

Sample:
{"meterSupplyTypes":[{"id":1,"label":"sample string 2","isChecked":true},{"id":1,"label":"sample string 2","isChecked":true}],"meterTypes":[{"id":1,"label":"sample string 2","isChecked":true},{"id":1,"label":"sample string 2","isChecked":true}],"targetSectors":[{"id":1,"label":"sample string 2","isChecked":true},{"id":1,"label":"sample string 2","isChecked":true}],"contractTypes":[{"id":1,"label":"sample string 2","isChecked":true},{"id":1,"label":"sample string 2","isChecked":true}],"renewalTypes":[{"id":1,"label":"sample string 2","isChecked":true},{"id":1,"label":"sample string 2","isChecked":true}],"fuelTypes":[{"id":1,"label":"sample string 2","isChecked":true},{"id":1,"label":"sample string 2","isChecked":true}],"targetPortfolios":[{"id":1,"label":"sample string 2","isChecked":true},{"id":1,"label":"sample string 2","isChecked":true}],"paymentTypes":[{"id":1,"label":"sample string 2","isChecked":true},{"id":1,"label":"sample string 2","isChecked":true}]}

application/xml, text/xml

Sample:
<BespokeConfigPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.SupplierDetails">
  <ContractTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Target_Market">
    <d2p1:ContractType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Label>sample string 2</d2p1:Label>
    </d2p1:ContractType>
    <d2p1:ContractType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Label>sample string 2</d2p1:Label>
    </d2p1:ContractType>
  </ContractTypes>
  <FuelTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Target_Market">
    <d2p1:FuelType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Label>sample string 2</d2p1:Label>
    </d2p1:FuelType>
    <d2p1:FuelType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Label>sample string 2</d2p1:Label>
    </d2p1:FuelType>
  </FuelTypes>
  <MeterSupplyTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Target_Market">
    <d2p1:MeterSupplyType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Label>sample string 2</d2p1:Label>
    </d2p1:MeterSupplyType>
    <d2p1:MeterSupplyType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Label>sample string 2</d2p1:Label>
    </d2p1:MeterSupplyType>
  </MeterSupplyTypes>
  <MeterTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Target_Market">
    <d2p1:MeterType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Label>sample string 2</d2p1:Label>
    </d2p1:MeterType>
    <d2p1:MeterType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Label>sample string 2</d2p1:Label>
    </d2p1:MeterType>
  </MeterTypes>
  <PaymentTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Target_Market">
    <d2p1:PaymentType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Label>sample string 2</d2p1:Label>
    </d2p1:PaymentType>
    <d2p1:PaymentType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Label>sample string 2</d2p1:Label>
    </d2p1:PaymentType>
  </PaymentTypes>
  <RenewalTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Target_Market">
    <d2p1:RenewalType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Label>sample string 2</d2p1:Label>
    </d2p1:RenewalType>
    <d2p1:RenewalType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Label>sample string 2</d2p1:Label>
    </d2p1:RenewalType>
  </RenewalTypes>
  <TargetPortfolios xmlns:d2p1="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Target_Market">
    <d2p1:TargetPortfolio>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Label>sample string 2</d2p1:Label>
    </d2p1:TargetPortfolio>
    <d2p1:TargetPortfolio>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsChecked>true</d2p1:IsChecked>
      <d2p1:Label>sample string 2</d2p1:Label>
    </d2p1:TargetPortfolio>
  </TargetPortfolios>
  <TargetSectors>
    <TargetSector>
      <Id>1</Id>
      <IsChecked>true</IsChecked>
      <Label>sample string 2</Label>
    </TargetSector>
    <TargetSector>
      <Id>1</Id>
      <IsChecked>true</IsChecked>
      <Label>sample string 2</Label>
    </TargetSector>
  </TargetSectors>
</BespokeConfigPost>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.