POST request/Switch/Pro/Detail/Employment-Statuses

Returns a selection of employment statuses for a consumer switching energy as mandatory. (Some energy suppliers request this information, contact MyUtilityGenius to confirm which suppliers request this).

Request Information

URI Parameters

None.

Body Parameters

The switch completion binding model.

SwitchCompletionInfoBindingModel
NameDescriptionTypeAdditional information
IsTou

boolean

None.

SwitchKey

string

Required

Max length: 50

Min length: 1

Request Formats

application/json, text/json

Sample:
{
  "switchKey": "sample string 1",
  "isTou": true
}

application/xml, text/xml

Sample:
<SwitchCompletionInfoBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.Sample">
  <IsTou xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.BindingModel">true</IsTou>
  <SwitchKey xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.BindingModel">sample string 1</SwitchKey>
</SwitchCompletionInfoBindingModel>

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SwitchKey"

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

True
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

EmploymentStatusesDtoResponse
NameDescriptionTypeAdditional information
ApiVersion

string

None.

EmploymentStatusesDto

EmploymentStatusesDto

None.

Uri

string

None.

Response Formats

application/json, text/json

Sample:
{
  "apiVersion": "sample string 1",
  "uri": "sample string 2",
  "employmentStatusesDto": {
    "employmentStatuses": {
      "1": "sample string 2",
      "3": "sample string 4"
    }
  }
}

application/xml, text/xml

Sample:
<EmploymentStatusesDtoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.DtoResponse">
  <ApiVersion>sample string 1</ApiVersion>
  <EmploymentStatusesDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.Dto">
    <d2p1:EmploymentStatuses xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfintstring>
        <d3p1:Key>1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfintstring>
      <d3p1:KeyValueOfintstring>
        <d3p1:Key>3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfintstring>
    </d2p1:EmploymentStatuses>
  </EmploymentStatusesDto>
  <Uri>sample string 2</Uri>
</EmploymentStatusesDtoResponse>

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="EmploymentStatusesDto.EmploymentStatuses[0].Key"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="EmploymentStatusesDto.EmploymentStatuses[0].Value"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="EmploymentStatusesDto.EmploymentStatuses[1].Key"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="EmploymentStatusesDto.EmploymentStatuses[1].Value"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e--