GET request/dcda/contract/all
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
DCDAContractList| Name | Description | Type | Additional information |
|---|---|---|---|
| dcdaContracts | Collection of DCDAContract |
None. |
|
| Header | DCDAContractHeader |
None. |
Response Formats
application/json, text/json
Sample:
{
"header": {
"gasContractSend": 1,
"electicityContractSend": 2
},
"dcdaContracts": [
{
"contractId": 1,
"contractDetailId": 1,
"resultId": 2,
"contractTemplateId": 3,
"contractStatusId": 4,
"contractURL": "sample string 5",
"siteName": "sample string 6",
"companyName": "sample string 7",
"fuelType": "sample string 8",
"createdDate": "2025-06-26T08:26:21.7112679+00:00",
"docusignGuideRef": "sample string 9",
"status": "sample string 10",
"agentName": "sample string 11",
"sitePostcode": "sample string 12",
"contractStartDate": "2025-06-26T08:26:21.7112679+00:00",
"sites": [
{
"siteAddress": "sample string 1",
"siteName": "sample string 2",
"mpxn": "sample string 3",
"status": "sample string 4",
"contractStatusId": 1
},
{
"siteAddress": "sample string 1",
"siteName": "sample string 2",
"mpxn": "sample string 3",
"status": "sample string 4",
"contractStatusId": 1
}
],
"sitemeters": [
{
"resultIds": [
1,
2
],
"tpiQuoteMeterId": 1,
"meterId": 2,
"mpanMprn": "sample string 3",
"siteFullAddress": "sample string 4",
"siteEmail": "sample string 5",
"sitePhone": "sample string 6",
"journeyStatusRefId": 7,
"capacityOrSOQ": 1.0,
"dcdaOrLoggerCharges": 1.0,
"mopOrMexCharges": 1.0,
"dcdaOrLoggerCommission": 1.0,
"mopOrMexCommission": 1.0,
"maximumCommission": 1.0,
"serviceTypeId": 1,
"serviceTypeName": "sample string 8",
"annualCost": 9.0,
"codeOfPractice": 1,
"dataPlatform": 1,
"dataProfile": 1,
"otherCharges": 1,
"totalCharge": 1.0,
"isHH": true,
"dcdaContractStartDate": "2025-06-26T08:26:21.7112679+00:00",
"mopContractStartDate": "2025-06-26T08:26:21.7112679+00:00",
"startDate": "sample string 10",
"endDate": "sample string 11",
"meterSerialNumber": "sample string 12",
"isImport": true
},
{
"resultIds": [
1,
2
],
"tpiQuoteMeterId": 1,
"meterId": 2,
"mpanMprn": "sample string 3",
"siteFullAddress": "sample string 4",
"siteEmail": "sample string 5",
"sitePhone": "sample string 6",
"journeyStatusRefId": 7,
"capacityOrSOQ": 1.0,
"dcdaOrLoggerCharges": 1.0,
"mopOrMexCharges": 1.0,
"dcdaOrLoggerCommission": 1.0,
"mopOrMexCommission": 1.0,
"maximumCommission": 1.0,
"serviceTypeId": 1,
"serviceTypeName": "sample string 8",
"annualCost": 9.0,
"codeOfPractice": 1,
"dataPlatform": 1,
"dataProfile": 1,
"otherCharges": 1,
"totalCharge": 1.0,
"isHH": true,
"dcdaContractStartDate": "2025-06-26T08:26:21.7112679+00:00",
"mopContractStartDate": "2025-06-26T08:26:21.7112679+00:00",
"startDate": "sample string 10",
"endDate": "sample string 11",
"meterSerialNumber": "sample string 12",
"isImport": true
}
]
},
{
"contractId": 1,
"contractDetailId": 1,
"resultId": 2,
"contractTemplateId": 3,
"contractStatusId": 4,
"contractURL": "sample string 5",
"siteName": "sample string 6",
"companyName": "sample string 7",
"fuelType": "sample string 8",
"createdDate": "2025-06-26T08:26:21.7112679+00:00",
"docusignGuideRef": "sample string 9",
"status": "sample string 10",
"agentName": "sample string 11",
"sitePostcode": "sample string 12",
"contractStartDate": "2025-06-26T08:26:21.7112679+00:00",
"sites": [
{
"siteAddress": "sample string 1",
"siteName": "sample string 2",
"mpxn": "sample string 3",
"status": "sample string 4",
"contractStatusId": 1
},
{
"siteAddress": "sample string 1",
"siteName": "sample string 2",
"mpxn": "sample string 3",
"status": "sample string 4",
"contractStatusId": 1
}
],
"sitemeters": [
{
"resultIds": [
1,
2
],
"tpiQuoteMeterId": 1,
"meterId": 2,
"mpanMprn": "sample string 3",
"siteFullAddress": "sample string 4",
"siteEmail": "sample string 5",
"sitePhone": "sample string 6",
"journeyStatusRefId": 7,
"capacityOrSOQ": 1.0,
"dcdaOrLoggerCharges": 1.0,
"mopOrMexCharges": 1.0,
"dcdaOrLoggerCommission": 1.0,
"mopOrMexCommission": 1.0,
"maximumCommission": 1.0,
"serviceTypeId": 1,
"serviceTypeName": "sample string 8",
"annualCost": 9.0,
"codeOfPractice": 1,
"dataPlatform": 1,
"dataProfile": 1,
"otherCharges": 1,
"totalCharge": 1.0,
"isHH": true,
"dcdaContractStartDate": "2025-06-26T08:26:21.7112679+00:00",
"mopContractStartDate": "2025-06-26T08:26:21.7112679+00:00",
"startDate": "sample string 10",
"endDate": "sample string 11",
"meterSerialNumber": "sample string 12",
"isImport": true
},
{
"resultIds": [
1,
2
],
"tpiQuoteMeterId": 1,
"meterId": 2,
"mpanMprn": "sample string 3",
"siteFullAddress": "sample string 4",
"siteEmail": "sample string 5",
"sitePhone": "sample string 6",
"journeyStatusRefId": 7,
"capacityOrSOQ": 1.0,
"dcdaOrLoggerCharges": 1.0,
"mopOrMexCharges": 1.0,
"dcdaOrLoggerCommission": 1.0,
"mopOrMexCommission": 1.0,
"maximumCommission": 1.0,
"serviceTypeId": 1,
"serviceTypeName": "sample string 8",
"annualCost": 9.0,
"codeOfPractice": 1,
"dataPlatform": 1,
"dataProfile": 1,
"otherCharges": 1,
"totalCharge": 1.0,
"isHH": true,
"dcdaContractStartDate": "2025-06-26T08:26:21.7112679+00:00",
"mopContractStartDate": "2025-06-26T08:26:21.7112679+00:00",
"startDate": "sample string 10",
"endDate": "sample string 11",
"meterSerialNumber": "sample string 12",
"isImport": true
}
]
}
]
}
text/html
Sample:
{"header":{"gasContractSend":1,"electicityContractSend":2},"dcdaContracts":[{"contractId":1,"contractDetailId":1,"resultId":2,"contractTemplateId":3,"contractStatusId":4,"contractURL":"sample string 5","siteName":"sample string 6","companyName":"sample string 7","fuelType":"sample string 8","createdDate":"2025-06-26T08:26:21.7112679+00:00","docusignGuideRef":"sample string 9","status":"sample string 10","agentName":"sample string 11","sitePostcode":"sample string 12","contractStartDate":"2025-06-26T08:26:21.7112679+00:00","sites":[{"siteAddress":"sample string 1","siteName":"sample string 2","mpxn":"sample string 3","status":"sample string 4","contractStatusId":1},{"siteAddress":"sample string 1","siteName":"sample string 2","mpxn":"sample string 3","status":"sample string 4","contractStatusId":1}],"sitemeters":[{"resultIds":[1,2],"tpiQuoteMeterId":1,"meterId":2,"mpanMprn":"sample string 3","siteFullAddress":"sample string 4","siteEmail":"sample string 5","sitePhone":"sample string 6","journeyStatusRefId":7,"capacityOrSOQ":1.0,"dcdaOrLoggerCharges":1.0,"mopOrMexCharges":1.0,"dcdaOrLoggerCommission":1.0,"mopOrMexCommission":1.0,"maximumCommission":1.0,"serviceTypeId":1,"serviceTypeName":"sample string 8","annualCost":9.0,"codeOfPractice":1,"dataPlatform":1,"dataProfile":1,"otherCharges":1,"totalCharge":1.0,"isHH":true,"dcdaContractStartDate":"2025-06-26T08:26:21.7112679+00:00","mopContractStartDate":"2025-06-26T08:26:21.7112679+00:00","startDate":"sample string 10","endDate":"sample string 11","meterSerialNumber":"sample string 12","isImport":true},{"resultIds":[1,2],"tpiQuoteMeterId":1,"meterId":2,"mpanMprn":"sample string 3","siteFullAddress":"sample string 4","siteEmail":"sample string 5","sitePhone":"sample string 6","journeyStatusRefId":7,"capacityOrSOQ":1.0,"dcdaOrLoggerCharges":1.0,"mopOrMexCharges":1.0,"dcdaOrLoggerCommission":1.0,"mopOrMexCommission":1.0,"maximumCommission":1.0,"serviceTypeId":1,"serviceTypeName":"sample string 8","annualCost":9.0,"codeOfPractice":1,"dataPlatform":1,"dataProfile":1,"otherCharges":1,"totalCharge":1.0,"isHH":true,"dcdaContractStartDate":"2025-06-26T08:26:21.7112679+00:00","mopContractStartDate":"2025-06-26T08:26:21.7112679+00:00","startDate":"sample string 10","endDate":"sample string 11","meterSerialNumber":"sample string 12","isImport":true}]},{"contractId":1,"contractDetailId":1,"resultId":2,"contractTemplateId":3,"contractStatusId":4,"contractURL":"sample string 5","siteName":"sample string 6","companyName":"sample string 7","fuelType":"sample string 8","createdDate":"2025-06-26T08:26:21.7112679+00:00","docusignGuideRef":"sample string 9","status":"sample string 10","agentName":"sample string 11","sitePostcode":"sample string 12","contractStartDate":"2025-06-26T08:26:21.7112679+00:00","sites":[{"siteAddress":"sample string 1","siteName":"sample string 2","mpxn":"sample string 3","status":"sample string 4","contractStatusId":1},{"siteAddress":"sample string 1","siteName":"sample string 2","mpxn":"sample string 3","status":"sample string 4","contractStatusId":1}],"sitemeters":[{"resultIds":[1,2],"tpiQuoteMeterId":1,"meterId":2,"mpanMprn":"sample string 3","siteFullAddress":"sample string 4","siteEmail":"sample string 5","sitePhone":"sample string 6","journeyStatusRefId":7,"capacityOrSOQ":1.0,"dcdaOrLoggerCharges":1.0,"mopOrMexCharges":1.0,"dcdaOrLoggerCommission":1.0,"mopOrMexCommission":1.0,"maximumCommission":1.0,"serviceTypeId":1,"serviceTypeName":"sample string 8","annualCost":9.0,"codeOfPractice":1,"dataPlatform":1,"dataProfile":1,"otherCharges":1,"totalCharge":1.0,"isHH":true,"dcdaContractStartDate":"2025-06-26T08:26:21.7112679+00:00","mopContractStartDate":"2025-06-26T08:26:21.7112679+00:00","startDate":"sample string 10","endDate":"sample string 11","meterSerialNumber":"sample string 12","isImport":true},{"resultIds":[1,2],"tpiQuoteMeterId":1,"meterId":2,"mpanMprn":"sample string 3","siteFullAddress":"sample string 4","siteEmail":"sample string 5","sitePhone":"sample string 6","journeyStatusRefId":7,"capacityOrSOQ":1.0,"dcdaOrLoggerCharges":1.0,"mopOrMexCharges":1.0,"dcdaOrLoggerCommission":1.0,"mopOrMexCommission":1.0,"maximumCommission":1.0,"serviceTypeId":1,"serviceTypeName":"sample string 8","annualCost":9.0,"codeOfPractice":1,"dataPlatform":1,"dataProfile":1,"otherCharges":1,"totalCharge":1.0,"isHH":true,"dcdaContractStartDate":"2025-06-26T08:26:21.7112679+00:00","mopContractStartDate":"2025-06-26T08:26:21.7112679+00:00","startDate":"sample string 10","endDate":"sample string 11","meterSerialNumber":"sample string 12","isImport":true}]}]}
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>
<DCDAContract>
<AgentName>sample string 11</AgentName>
<CompanyName>sample string 7</CompanyName>
<ContractDetailId>1</ContractDetailId>
<ContractId>1</ContractId>
<ContractStartDate>2025-06-26T08:26:21.7112679+00:00</ContractStartDate>
<ContractStatusId>4</ContractStatusId>
<ContractTemplateId>3</ContractTemplateId>
<ContractURL>sample string 5</ContractURL>
<CreatedDate>2025-06-26T08:26:21.7112679+00:00</CreatedDate>
<DocusignGuideRef>sample string 9</DocusignGuideRef>
<FuelType>sample string 8</FuelType>
<ResultId>2</ResultId>
<SiteName>sample string 6</SiteName>
<SitePostcode>sample string 12</SitePostcode>
<Status>sample string 10</Status>
<sitemeters>
<DCDASiteMeterResult>
<AnnualCost>9</AnnualCost>
<CapacityOrSOQ>1</CapacityOrSOQ>
<CodeOfPractice>1</CodeOfPractice>
<DCDAContractStartDate>2025-06-26T08:26:21.7112679+00:00</DCDAContractStartDate>
<DCDAOrLoggerCharges>1</DCDAOrLoggerCharges>
<DCDAOrLoggerCommission>1</DCDAOrLoggerCommission>
<DataPlatform>1</DataPlatform>
<DataProfile>1</DataProfile>
<EndDate>sample string 11</EndDate>
<IsHH>true</IsHH>
<IsImport>true</IsImport>
<JourneyStatusRefId>7</JourneyStatusRefId>
<MOPContractStartDate>2025-06-26T08:26:21.7112679+00:00</MOPContractStartDate>
<MOPOrMexCharges>1</MOPOrMexCharges>
<MOPOrMexCommission>1</MOPOrMexCommission>
<MaximumCommission>1</MaximumCommission>
<MeterId>2</MeterId>
<MeterSerialNumber>sample string 12</MeterSerialNumber>
<MpanMprn>sample string 3</MpanMprn>
<OtherCharges>1</OtherCharges>
<ResultIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:long>1</d6p1:long>
<d6p1:long>2</d6p1:long>
</ResultIds>
<ServiceTypeId>1</ServiceTypeId>
<ServiceTypeName>sample string 8</ServiceTypeName>
<SiteEmail>sample string 5</SiteEmail>
<SiteFullAddress>sample string 4</SiteFullAddress>
<SitePhone>sample string 6</SitePhone>
<StartDate>sample string 10</StartDate>
<TPIQuoteMeterId>1</TPIQuoteMeterId>
<TotalCharge>1</TotalCharge>
</DCDASiteMeterResult>
<DCDASiteMeterResult>
<AnnualCost>9</AnnualCost>
<CapacityOrSOQ>1</CapacityOrSOQ>
<CodeOfPractice>1</CodeOfPractice>
<DCDAContractStartDate>2025-06-26T08:26:21.7112679+00:00</DCDAContractStartDate>
<DCDAOrLoggerCharges>1</DCDAOrLoggerCharges>
<DCDAOrLoggerCommission>1</DCDAOrLoggerCommission>
<DataPlatform>1</DataPlatform>
<DataProfile>1</DataProfile>
<EndDate>sample string 11</EndDate>
<IsHH>true</IsHH>
<IsImport>true</IsImport>
<JourneyStatusRefId>7</JourneyStatusRefId>
<MOPContractStartDate>2025-06-26T08:26:21.7112679+00:00</MOPContractStartDate>
<MOPOrMexCharges>1</MOPOrMexCharges>
<MOPOrMexCommission>1</MOPOrMexCommission>
<MaximumCommission>1</MaximumCommission>
<MeterId>2</MeterId>
<MeterSerialNumber>sample string 12</MeterSerialNumber>
<MpanMprn>sample string 3</MpanMprn>
<OtherCharges>1</OtherCharges>
<ResultIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:long>1</d6p1:long>
<d6p1:long>2</d6p1:long>
</ResultIds>
<ServiceTypeId>1</ServiceTypeId>
<ServiceTypeName>sample string 8</ServiceTypeName>
<SiteEmail>sample string 5</SiteEmail>
<SiteFullAddress>sample string 4</SiteFullAddress>
<SitePhone>sample string 6</SitePhone>
<StartDate>sample string 10</StartDate>
<TPIQuoteMeterId>1</TPIQuoteMeterId>
<TotalCharge>1</TotalCharge>
</DCDASiteMeterResult>
</sitemeters>
<sites>
<DCDAContractSite>
<ContractStatusId>1</ContractStatusId>
<Mpxn>sample string 3</Mpxn>
<SiteAddress>sample string 1</SiteAddress>
<SiteName>sample string 2</SiteName>
<Status>sample string 4</Status>
</DCDAContractSite>
<DCDAContractSite>
<ContractStatusId>1</ContractStatusId>
<Mpxn>sample string 3</Mpxn>
<SiteAddress>sample string 1</SiteAddress>
<SiteName>sample string 2</SiteName>
<Status>sample string 4</Status>
</DCDAContractSite>
</sites>
</DCDAContract>
<DCDAContract>
<AgentName>sample string 11</AgentName>
<CompanyName>sample string 7</CompanyName>
<ContractDetailId>1</ContractDetailId>
<ContractId>1</ContractId>
<ContractStartDate>2025-06-26T08:26:21.7112679+00:00</ContractStartDate>
<ContractStatusId>4</ContractStatusId>
<ContractTemplateId>3</ContractTemplateId>
<ContractURL>sample string 5</ContractURL>
<CreatedDate>2025-06-26T08:26:21.7112679+00:00</CreatedDate>
<DocusignGuideRef>sample string 9</DocusignGuideRef>
<FuelType>sample string 8</FuelType>
<ResultId>2</ResultId>
<SiteName>sample string 6</SiteName>
<SitePostcode>sample string 12</SitePostcode>
<Status>sample string 10</Status>
<sitemeters>
<DCDASiteMeterResult>
<AnnualCost>9</AnnualCost>
<CapacityOrSOQ>1</CapacityOrSOQ>
<CodeOfPractice>1</CodeOfPractice>
<DCDAContractStartDate>2025-06-26T08:26:21.7112679+00:00</DCDAContractStartDate>
<DCDAOrLoggerCharges>1</DCDAOrLoggerCharges>
<DCDAOrLoggerCommission>1</DCDAOrLoggerCommission>
<DataPlatform>1</DataPlatform>
<DataProfile>1</DataProfile>
<EndDate>sample string 11</EndDate>
<IsHH>true</IsHH>
<IsImport>true</IsImport>
<JourneyStatusRefId>7</JourneyStatusRefId>
<MOPContractStartDate>2025-06-26T08:26:21.7112679+00:00</MOPContractStartDate>
<MOPOrMexCharges>1</MOPOrMexCharges>
<MOPOrMexCommission>1</MOPOrMexCommission>
<MaximumCommission>1</MaximumCommission>
<MeterId>2</MeterId>
<MeterSerialNumber>sample string 12</MeterSerialNumber>
<MpanMprn>sample string 3</MpanMprn>
<OtherCharges>1</OtherCharges>
<ResultIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:long>1</d6p1:long>
<d6p1:long>2</d6p1:long>
</ResultIds>
<ServiceTypeId>1</ServiceTypeId>
<ServiceTypeName>sample string 8</ServiceTypeName>
<SiteEmail>sample string 5</SiteEmail>
<SiteFullAddress>sample string 4</SiteFullAddress>
<SitePhone>sample string 6</SitePhone>
<StartDate>sample string 10</StartDate>
<TPIQuoteMeterId>1</TPIQuoteMeterId>
<TotalCharge>1</TotalCharge>
</DCDASiteMeterResult>
<DCDASiteMeterResult>
<AnnualCost>9</AnnualCost>
<CapacityOrSOQ>1</CapacityOrSOQ>
<CodeOfPractice>1</CodeOfPractice>
<DCDAContractStartDate>2025-06-26T08:26:21.7112679+00:00</DCDAContractStartDate>
<DCDAOrLoggerCharges>1</DCDAOrLoggerCharges>
<DCDAOrLoggerCommission>1</DCDAOrLoggerCommission>
<DataPlatform>1</DataPlatform>
<DataProfile>1</DataProfile>
<EndDate>sample string 11</EndDate>
<IsHH>true</IsHH>
<IsImport>true</IsImport>
<JourneyStatusRefId>7</JourneyStatusRefId>
<MOPContractStartDate>2025-06-26T08:26:21.7112679+00:00</MOPContractStartDate>
<MOPOrMexCharges>1</MOPOrMexCharges>
<MOPOrMexCommission>1</MOPOrMexCommission>
<MaximumCommission>1</MaximumCommission>
<MeterId>2</MeterId>
<MeterSerialNumber>sample string 12</MeterSerialNumber>
<MpanMprn>sample string 3</MpanMprn>
<OtherCharges>1</OtherCharges>
<ResultIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:long>1</d6p1:long>
<d6p1:long>2</d6p1:long>
</ResultIds>
<ServiceTypeId>1</ServiceTypeId>
<ServiceTypeName>sample string 8</ServiceTypeName>
<SiteEmail>sample string 5</SiteEmail>
<SiteFullAddress>sample string 4</SiteFullAddress>
<SitePhone>sample string 6</SitePhone>
<StartDate>sample string 10</StartDate>
<TPIQuoteMeterId>1</TPIQuoteMeterId>
<TotalCharge>1</TotalCharge>
</DCDASiteMeterResult>
</sitemeters>
<sites>
<DCDAContractSite>
<ContractStatusId>1</ContractStatusId>
<Mpxn>sample string 3</Mpxn>
<SiteAddress>sample string 1</SiteAddress>
<SiteName>sample string 2</SiteName>
<Status>sample string 4</Status>
</DCDAContractSite>
<DCDAContractSite>
<ContractStatusId>1</ContractStatusId>
<Mpxn>sample string 3</Mpxn>
<SiteAddress>sample string 1</SiteAddress>
<SiteName>sample string 2</SiteName>
<Status>sample string 4</Status>
</DCDAContractSite>
</sites>
</DCDAContract>
</dcdaContracts>
</DCDAContractList>