GET request/dcda/contract/all

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Description	Type	Additional information
dcdaContracts		Collection of DCDAContractView	None.
Header		DCDAContractHeader	None.

Response Formats

application/json, text/json

Sample:

{
  "header": {
    "gasContractSend": 1,
    "electicityContractSend": 2
  },
  "dcdaContracts": [
    {
      "contractId": 1,
      "customerId": 2,
      "contractDetailId": 1,
      "resultId": 3,
      "contractDuration": 64,
      "contractStatusId": 4,
      "contractURL": "sample string 5",
      "companyName": "sample string 6",
      "fuelType": "sample string 7",
      "createdDate": "2026-05-02T05:11:08.1179695+00:00",
      "contractExpiryDate": "2026-05-02T05:11:08.1179695+00:00",
      "docusignGuideRef": "sample string 8",
      "status": "sample string 9",
      "brokerCompany": "sample string 10",
      "brokerId": 1,
      "brokerName": "sample string 11",
      "numberOfSites": 1,
      "contractTypeId": 12,
      "contractType": "sample string 13",
      "contractSubmittedDate": "2026-05-02T05:11:08.1179695+00:00",
      "contractStartDate": "2026-05-02T05:11:08.1179695+00:00",
      "connectionTypeName": "sample string 14",
      "serviceType": "sample string 15",
      "totalAnnualDCDAOrLoggerCommission": 1.0,
      "totalAnnualMOPOrMexCommission": 1.0,
      "totalAnnualCommission": 1.0,
      "totalAnnualCost": 16.0,
      "sites": [
        {
          "siteAddress": "sample string 1",
          "siteName": "sample string 2",
          "mpxn": "sample string 3",
          "mpanParts": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "capacityOrSOQ": 1.0,
          "dcdaOrLoggerCommission": 1.0,
          "mopOrMexCommission": 1.0,
          "totalAnnualCommission": 1.0,
          "annualCost": 4.0,
          "codeOfPractice": 1,
          "dcdaContractStartDate": "2026-05-02T05:11:08.1179695+00:00",
          "mopContractStartDate": "2026-05-02T05:11:08.1179695+00:00",
          "dcdaContractEndDate": "2026-05-02T05:11:08.1179695+00:00",
          "mopContractEndDate": "2026-05-02T05:11:08.1179695+00:00",
          "annualcontractCommission": 1.0,
          "connectionTypeName": "sample string 5"
        },
        {
          "siteAddress": "sample string 1",
          "siteName": "sample string 2",
          "mpxn": "sample string 3",
          "mpanParts": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "capacityOrSOQ": 1.0,
          "dcdaOrLoggerCommission": 1.0,
          "mopOrMexCommission": 1.0,
          "totalAnnualCommission": 1.0,
          "annualCost": 4.0,
          "codeOfPractice": 1,
          "dcdaContractStartDate": "2026-05-02T05:11:08.1179695+00:00",
          "mopContractStartDate": "2026-05-02T05:11:08.1179695+00:00",
          "dcdaContractEndDate": "2026-05-02T05:11:08.1179695+00:00",
          "mopContractEndDate": "2026-05-02T05:11:08.1179695+00:00",
          "annualcontractCommission": 1.0,
          "connectionTypeName": "sample string 5"
        }
      ]
    },
    {
      "contractId": 1,
      "customerId": 2,
      "contractDetailId": 1,
      "resultId": 3,
      "contractDuration": 64,
      "contractStatusId": 4,
      "contractURL": "sample string 5",
      "companyName": "sample string 6",
      "fuelType": "sample string 7",
      "createdDate": "2026-05-02T05:11:08.1179695+00:00",
      "contractExpiryDate": "2026-05-02T05:11:08.1179695+00:00",
      "docusignGuideRef": "sample string 8",
      "status": "sample string 9",
      "brokerCompany": "sample string 10",
      "brokerId": 1,
      "brokerName": "sample string 11",
      "numberOfSites": 1,
      "contractTypeId": 12,
      "contractType": "sample string 13",
      "contractSubmittedDate": "2026-05-02T05:11:08.1179695+00:00",
      "contractStartDate": "2026-05-02T05:11:08.1179695+00:00",
      "connectionTypeName": "sample string 14",
      "serviceType": "sample string 15",
      "totalAnnualDCDAOrLoggerCommission": 1.0,
      "totalAnnualMOPOrMexCommission": 1.0,
      "totalAnnualCommission": 1.0,
      "totalAnnualCost": 16.0,
      "sites": [
        {
          "siteAddress": "sample string 1",
          "siteName": "sample string 2",
          "mpxn": "sample string 3",
          "mpanParts": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "capacityOrSOQ": 1.0,
          "dcdaOrLoggerCommission": 1.0,
          "mopOrMexCommission": 1.0,
          "totalAnnualCommission": 1.0,
          "annualCost": 4.0,
          "codeOfPractice": 1,
          "dcdaContractStartDate": "2026-05-02T05:11:08.1179695+00:00",
          "mopContractStartDate": "2026-05-02T05:11:08.1179695+00:00",
          "dcdaContractEndDate": "2026-05-02T05:11:08.1179695+00:00",
          "mopContractEndDate": "2026-05-02T05:11:08.1179695+00:00",
          "annualcontractCommission": 1.0,
          "connectionTypeName": "sample string 5"
        },
        {
          "siteAddress": "sample string 1",
          "siteName": "sample string 2",
          "mpxn": "sample string 3",
          "mpanParts": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "capacityOrSOQ": 1.0,
          "dcdaOrLoggerCommission": 1.0,
          "mopOrMexCommission": 1.0,
          "totalAnnualCommission": 1.0,
          "annualCost": 4.0,
          "codeOfPractice": 1,
          "dcdaContractStartDate": "2026-05-02T05:11:08.1179695+00:00",
          "mopContractStartDate": "2026-05-02T05:11:08.1179695+00:00",
          "dcdaContractEndDate": "2026-05-02T05:11:08.1179695+00:00",
          "mopContractEndDate": "2026-05-02T05:11:08.1179695+00:00",
          "annualcontractCommission": 1.0,
          "connectionTypeName": "sample string 5"
        }
      ]
    }
  ]
}

text/html

Sample:

{"header":{"gasContractSend":1,"electicityContractSend":2},"dcdaContracts":[{"contractId":1,"customerId":2,"contractDetailId":1,"resultId":3,"contractDuration":64,"contractStatusId":4,"contractURL":"sample string 5","companyName":"sample string 6","fuelType":"sample string 7","createdDate":"2026-05-02T05:11:08.1179695+00:00","contractExpiryDate":"2026-05-02T05:11:08.1179695+00:00","docusignGuideRef":"sample string 8","status":"sample string 9","brokerCompany":"sample string 10","brokerId":1,"brokerName":"sample string 11","numberOfSites":1,"contractTypeId":12,"contractType":"sample string 13","contractSubmittedDate":"2026-05-02T05:11:08.1179695+00:00","contractStartDate":"2026-05-02T05:11:08.1179695+00:00","connectionTypeName":"sample string 14","serviceType":"sample string 15","totalAnnualDCDAOrLoggerCommission":1.0,"totalAnnualMOPOrMexCommission":1.0,"totalAnnualCommission":1.0,"totalAnnualCost":16.0,"sites":[{"siteAddress":"sample string 1","siteName":"sample string 2","mpxn":"sample string 3","mpanParts":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"capacityOrSOQ":1.0,"dcdaOrLoggerCommission":1.0,"mopOrMexCommission":1.0,"totalAnnualCommission":1.0,"annualCost":4.0,"codeOfPractice":1,"dcdaContractStartDate":"2026-05-02T05:11:08.1179695+00:00","mopContractStartDate":"2026-05-02T05:11:08.1179695+00:00","dcdaContractEndDate":"2026-05-02T05:11:08.1179695+00:00","mopContractEndDate":"2026-05-02T05:11:08.1179695+00:00","annualcontractCommission":1.0,"connectionTypeName":"sample string 5"},{"siteAddress":"sample string 1","siteName":"sample string 2","mpxn":"sample string 3","mpanParts":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"capacityOrSOQ":1.0,"dcdaOrLoggerCommission":1.0,"mopOrMexCommission":1.0,"totalAnnualCommission":1.0,"annualCost":4.0,"codeOfPractice":1,"dcdaContractStartDate":"2026-05-02T05:11:08.1179695+00:00","mopContractStartDate":"2026-05-02T05:11:08.1179695+00:00","dcdaContractEndDate":"2026-05-02T05:11:08.1179695+00:00","mopContractEndDate":"2026-05-02T05:11:08.1179695+00:00","annualcontractCommission":1.0,"connectionTypeName":"sample string 5"}]},{"contractId":1,"customerId":2,"contractDetailId":1,"resultId":3,"contractDuration":64,"contractStatusId":4,"contractURL":"sample string 5","companyName":"sample string 6","fuelType":"sample string 7","createdDate":"2026-05-02T05:11:08.1179695+00:00","contractExpiryDate":"2026-05-02T05:11:08.1179695+00:00","docusignGuideRef":"sample string 8","status":"sample string 9","brokerCompany":"sample string 10","brokerId":1,"brokerName":"sample string 11","numberOfSites":1,"contractTypeId":12,"contractType":"sample string 13","contractSubmittedDate":"2026-05-02T05:11:08.1179695+00:00","contractStartDate":"2026-05-02T05:11:08.1179695+00:00","connectionTypeName":"sample string 14","serviceType":"sample string 15","totalAnnualDCDAOrLoggerCommission":1.0,"totalAnnualMOPOrMexCommission":1.0,"totalAnnualCommission":1.0,"totalAnnualCost":16.0,"sites":[{"siteAddress":"sample string 1","siteName":"sample string 2","mpxn":"sample string 3","mpanParts":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"capacityOrSOQ":1.0,"dcdaOrLoggerCommission":1.0,"mopOrMexCommission":1.0,"totalAnnualCommission":1.0,"annualCost":4.0,"codeOfPractice":1,"dcdaContractStartDate":"2026-05-02T05:11:08.1179695+00:00","mopContractStartDate":"2026-05-02T05:11:08.1179695+00:00","dcdaContractEndDate":"2026-05-02T05:11:08.1179695+00:00","mopContractEndDate":"2026-05-02T05:11:08.1179695+00:00","annualcontractCommission":1.0,"connectionTypeName":"sample string 5"},{"siteAddress":"sample string 1","siteName":"sample string 2","mpxn":"sample string 3","mpanParts":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"capacityOrSOQ":1.0,"dcdaOrLoggerCommission":1.0,"mopOrMexCommission":1.0,"totalAnnualCommission":1.0,"annualCost":4.0,"codeOfPractice":1,"dcdaContractStartDate":"2026-05-02T05:11:08.1179695+00:00","mopContractStartDate":"2026-05-02T05:11:08.1179695+00:00","dcdaContractEndDate":"2026-05-02T05:11:08.1179695+00:00","mopContractEndDate":"2026-05-02T05:11:08.1179695+00:00","annualcontractCommission":1.0,"connectionTypeName":"sample string 5"}]}]}

application/xml, text/xml

Sample:

<DCDAContractList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.DCDAMOP">
  <Header>
    <ElecticityContractSend>2</ElecticityContractSend>
    <GasContractSend>1</GasContractSend>
  </Header>
  <dcdaContracts>
    <DCDAContractView>
      <BrokerCompany>sample string 10</BrokerCompany>
      <BrokerId>1</BrokerId>
      <BrokerName>sample string 11</BrokerName>
      <CompanyName>sample string 6</CompanyName>
      <ConnectionTypeName>sample string 14</ConnectionTypeName>
      <ContractDetailId>1</ContractDetailId>
      <ContractDuration>64</ContractDuration>
      <ContractExpiryDate>2026-05-02T05:11:08.1179695+00:00</ContractExpiryDate>
      <ContractId>1</ContractId>
      <ContractStartDate>2026-05-02T05:11:08.1179695+00:00</ContractStartDate>
      <ContractStatusId>4</ContractStatusId>
      <ContractSubmittedDate>2026-05-02T05:11:08.1179695+00:00</ContractSubmittedDate>
      <ContractType>sample string 13</ContractType>
      <ContractTypeId>12</ContractTypeId>
      <ContractURL>sample string 5</ContractURL>
      <CreatedDate>2026-05-02T05:11:08.1179695+00:00</CreatedDate>
      <CustomerId>2</CustomerId>
      <DocusignGuideRef>sample string 8</DocusignGuideRef>
      <FuelType>sample string 7</FuelType>
      <NumberOfSites>1</NumberOfSites>
      <ResultId>3</ResultId>
      <ServiceType>sample string 15</ServiceType>
      <Status>sample string 9</Status>
      <TotalAnnualCommission>1</TotalAnnualCommission>
      <TotalAnnualCost>16</TotalAnnualCost>
      <TotalAnnualDCDAOrLoggerCommission>1</TotalAnnualDCDAOrLoggerCommission>
      <TotalAnnualMOPOrMexCommission>1</TotalAnnualMOPOrMexCommission>
      <sites>
        <DCDAContractSiteMeter>
          <AnnualCost>4</AnnualCost>
          <AnnualcontractCommission>1</AnnualcontractCommission>
          <CapacityOrSOQ>1</CapacityOrSOQ>
          <CodeOfPractice>1</CodeOfPractice>
          <ConnectionTypeName>sample string 5</ConnectionTypeName>
          <DCDAContractEndDate>2026-05-02T05:11:08.1179695+00:00</DCDAContractEndDate>
          <DCDAContractStartDate>2026-05-02T05:11:08.1179695+00:00</DCDAContractStartDate>
          <DCDAOrLoggerCommission>1</DCDAOrLoggerCommission>
          <MOPContractEndDate>2026-05-02T05:11:08.1179695+00:00</MOPContractEndDate>
          <MOPContractStartDate>2026-05-02T05:11:08.1179695+00:00</MOPContractStartDate>
          <MOPOrMexCommission>1</MOPOrMexCommission>
          <MpanParts xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </MpanParts>
          <Mpxn>sample string 3</Mpxn>
          <SiteAddress>sample string 1</SiteAddress>
          <SiteName>sample string 2</SiteName>
          <TotalAnnualCommission>1</TotalAnnualCommission>
        </DCDAContractSiteMeter>
        <DCDAContractSiteMeter>
          <AnnualCost>4</AnnualCost>
          <AnnualcontractCommission>1</AnnualcontractCommission>
          <CapacityOrSOQ>1</CapacityOrSOQ>
          <CodeOfPractice>1</CodeOfPractice>
          <ConnectionTypeName>sample string 5</ConnectionTypeName>
          <DCDAContractEndDate>2026-05-02T05:11:08.1179695+00:00</DCDAContractEndDate>
          <DCDAContractStartDate>2026-05-02T05:11:08.1179695+00:00</DCDAContractStartDate>
          <DCDAOrLoggerCommission>1</DCDAOrLoggerCommission>
          <MOPContractEndDate>2026-05-02T05:11:08.1179695+00:00</MOPContractEndDate>
          <MOPContractStartDate>2026-05-02T05:11:08.1179695+00:00</MOPContractStartDate>
          <MOPOrMexCommission>1</MOPOrMexCommission>
          <MpanParts xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </MpanParts>
          <Mpxn>sample string 3</Mpxn>
          <SiteAddress>sample string 1</SiteAddress>
          <SiteName>sample string 2</SiteName>
          <TotalAnnualCommission>1</TotalAnnualCommission>
        </DCDAContractSiteMeter>
      </sites>
    </DCDAContractView>
    <DCDAContractView>
      <BrokerCompany>sample string 10</BrokerCompany>
      <BrokerId>1</BrokerId>
      <BrokerName>sample string 11</BrokerName>
      <CompanyName>sample string 6</CompanyName>
      <ConnectionTypeName>sample string 14</ConnectionTypeName>
      <ContractDetailId>1</ContractDetailId>
      <ContractDuration>64</ContractDuration>
      <ContractExpiryDate>2026-05-02T05:11:08.1179695+00:00</ContractExpiryDate>
      <ContractId>1</ContractId>
      <ContractStartDate>2026-05-02T05:11:08.1179695+00:00</ContractStartDate>
      <ContractStatusId>4</ContractStatusId>
      <ContractSubmittedDate>2026-05-02T05:11:08.1179695+00:00</ContractSubmittedDate>
      <ContractType>sample string 13</ContractType>
      <ContractTypeId>12</ContractTypeId>
      <ContractURL>sample string 5</ContractURL>
      <CreatedDate>2026-05-02T05:11:08.1179695+00:00</CreatedDate>
      <CustomerId>2</CustomerId>
      <DocusignGuideRef>sample string 8</DocusignGuideRef>
      <FuelType>sample string 7</FuelType>
      <NumberOfSites>1</NumberOfSites>
      <ResultId>3</ResultId>
      <ServiceType>sample string 15</ServiceType>
      <Status>sample string 9</Status>
      <TotalAnnualCommission>1</TotalAnnualCommission>
      <TotalAnnualCost>16</TotalAnnualCost>
      <TotalAnnualDCDAOrLoggerCommission>1</TotalAnnualDCDAOrLoggerCommission>
      <TotalAnnualMOPOrMexCommission>1</TotalAnnualMOPOrMexCommission>
      <sites>
        <DCDAContractSiteMeter>
          <AnnualCost>4</AnnualCost>
          <AnnualcontractCommission>1</AnnualcontractCommission>
          <CapacityOrSOQ>1</CapacityOrSOQ>
          <CodeOfPractice>1</CodeOfPractice>
          <ConnectionTypeName>sample string 5</ConnectionTypeName>
          <DCDAContractEndDate>2026-05-02T05:11:08.1179695+00:00</DCDAContractEndDate>
          <DCDAContractStartDate>2026-05-02T05:11:08.1179695+00:00</DCDAContractStartDate>
          <DCDAOrLoggerCommission>1</DCDAOrLoggerCommission>
          <MOPContractEndDate>2026-05-02T05:11:08.1179695+00:00</MOPContractEndDate>
          <MOPContractStartDate>2026-05-02T05:11:08.1179695+00:00</MOPContractStartDate>
          <MOPOrMexCommission>1</MOPOrMexCommission>
          <MpanParts xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </MpanParts>
          <Mpxn>sample string 3</Mpxn>
          <SiteAddress>sample string 1</SiteAddress>
          <SiteName>sample string 2</SiteName>
          <TotalAnnualCommission>1</TotalAnnualCommission>
        </DCDAContractSiteMeter>
        <DCDAContractSiteMeter>
          <AnnualCost>4</AnnualCost>
          <AnnualcontractCommission>1</AnnualcontractCommission>
          <CapacityOrSOQ>1</CapacityOrSOQ>
          <CodeOfPractice>1</CodeOfPractice>
          <ConnectionTypeName>sample string 5</ConnectionTypeName>
          <DCDAContractEndDate>2026-05-02T05:11:08.1179695+00:00</DCDAContractEndDate>
          <DCDAContractStartDate>2026-05-02T05:11:08.1179695+00:00</DCDAContractStartDate>
          <DCDAOrLoggerCommission>1</DCDAOrLoggerCommission>
          <MOPContractEndDate>2026-05-02T05:11:08.1179695+00:00</MOPContractEndDate>
          <MOPContractStartDate>2026-05-02T05:11:08.1179695+00:00</MOPContractStartDate>
          <MOPOrMexCommission>1</MOPOrMexCommission>
          <MpanParts xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 1</d6p1:Key>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>sample string 3</d6p1:Key>
              <d6p1:Value>sample string 4</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </MpanParts>
          <Mpxn>sample string 3</Mpxn>
          <SiteAddress>sample string 1</SiteAddress>
          <SiteName>sample string 2</SiteName>
          <TotalAnnualCommission>1</TotalAnnualCommission>
        </DCDAContractSiteMeter>
      </sites>
    </DCDAContractView>
  </dcdaContracts>
</DCDAContractList>