GET request/Switch/Pro/Info/Address/v2

?SwitchKey={SwitchKey}&IsTou={IsTou}

Returns consumer address details through upfront quote journey capture.

Request Information

URI Parameters

Name	Description	Type	Additional information
IsTou		boolean	None.
SwitchKey		string	Required Max length: 50 Min length: 1

Name

Description

Type

Additional information

IsTou

boolean

None.

SwitchKey

string

Required

Max length: 50

Min length: 1

Body Parameters

None.

Response Information

Resource Description

AddressInfoDetailsDtoResponse

Name	Type	Additional information
AddressInfoDto	AddressInfoDetailsDto	None.
ApiVersion	string	None.
Uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "apiVersion": "sample string 1",
  "uri": "sample string 2",
  "addressInfoDto": {
    "residentialAddresses": {
      "present": {
        "line1": "sample string 1",
        "line2": "sample string 2",
        "city": "sample string 3",
        "county": "sample string 4",
        "postcode": "sample string 5",
        "residentialStatus": "sample string 6",
        "lengthOfResidencyInMonths": 1,
        "mpan": "sample string 7",
        "mprn": "sample string 8"
      }
    },
    "businessAddress": {
      "line1": "sample string 1",
      "line2": "sample string 2",
      "city": "sample string 3",
      "county": "sample string 4",
      "postcode": "sample string 5"
    }
  }
}

application/xml, text/xml

Sample:

<AddressInfoDetailsDtoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.DtoResponse">
  <AddressInfoDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.Dto">
    <d2p1:BusinessAddress>
      <d2p1:City>sample string 3</d2p1:City>
      <d2p1:County>sample string 4</d2p1:County>
      <d2p1:Line1>sample string 1</d2p1:Line1>
      <d2p1:Line2>sample string 2</d2p1:Line2>
      <d2p1:Postcode>sample string 5</d2p1:Postcode>
    </d2p1:BusinessAddress>
    <d2p1:ResidentialAddresses xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfResidentialAddressTypeResidentialAddressDetailsDtoVRB4RhVM>
        <d3p1:Key>Present</d3p1:Key>
        <d3p1:Value>
          <d2p1:City>sample string 3</d2p1:City>
          <d2p1:County>sample string 4</d2p1:County>
          <d2p1:LengthOfResidencyInMonths>1</d2p1:LengthOfResidencyInMonths>
          <d2p1:Line1>sample string 1</d2p1:Line1>
          <d2p1:Line2>sample string 2</d2p1:Line2>
          <d2p1:Mpan>sample string 7</d2p1:Mpan>
          <d2p1:Mprn>sample string 8</d2p1:Mprn>
          <d2p1:Postcode>sample string 5</d2p1:Postcode>
          <d2p1:ResidentialStatus>sample string 6</d2p1:ResidentialStatus>
        </d3p1:Value>
      </d3p1:KeyValueOfResidentialAddressTypeResidentialAddressDetailsDtoVRB4RhVM>
    </d2p1:ResidentialAddresses>
  </AddressInfoDto>
  <ApiVersion>sample string 1</ApiVersion>
  <Uri>sample string 2</Uri>
</AddressInfoDetailsDtoResponse>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ApiVersion"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Uri"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AddressInfoDto.ResidentialAddresses[0].Key"

Present
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AddressInfoDto.ResidentialAddresses[0].Value.Line1"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AddressInfoDto.ResidentialAddresses[0].Value.Line2"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AddressInfoDto.ResidentialAddresses[0].Value.City"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AddressInfoDto.ResidentialAddresses[0].Value.County"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AddressInfoDto.ResidentialAddresses[0].Value.Postcode"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AddressInfoDto.ResidentialAddresses[0].Value.ResidentialStatus"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AddressInfoDto.ResidentialAddresses[0].Value.LengthOfResidencyInMonths"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AddressInfoDto.ResidentialAddresses[0].Value.Mpan"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AddressInfoDto.ResidentialAddresses[0].Value.Mprn"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AddressInfoDto.BusinessAddress.Line1"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AddressInfoDto.BusinessAddress.Line2"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AddressInfoDto.BusinessAddress.City"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AddressInfoDto.BusinessAddress.County"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AddressInfoDto.BusinessAddress.Postcode"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e--