CustomerCareService Web Service

CustomerCareService

Click here for a complete list of operations.

CreateBusiness

Creates new business

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /webservices/CustomerCareService.asmx HTTP/1.1
Host: ua-custsvc-ihub.southerncompany.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.southernco.com/CustSvc-iHub/CreateBusiness"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <ScCredentials xmlns="http://ws.southernco.com/CustSvc-iHub">
      <DirectUserNameToken>
        <BinarySecurityToken>
          <ID>string</ID>
        </BinarySecurityToken>
      </DirectUserNameToken>
      <OriginatingUserNameToken>
        <BinarySecurityToken>
          <ID>string</ID>
        </BinarySecurityToken>
      </OriginatingUserNameToken>
      <Created>string</Created>
    </ScCredentials>
  </soap:Header>
  <soap:Body>
    <CreateBusiness xmlns="http://ws.southernco.com/CustSvc-iHub">
      <createBusinessRequest>
        <BaseRequest xmlns="">
          <UserId>string</UserId>
          <MessageDateTime>dateTime</MessageDateTime>
          <MessageId>string</MessageId>
          <NameValue>
            <Name>string</Name>
            <Value>string</Value>
          </NameValue>
          <NameValue>
            <Name>string</Name>
            <Value>string</Value>
          </NameValue>
        </BaseRequest>
        <AccountNumber xmlns="">string</AccountNumber>
        <PremiseNumber xmlns="">string</PremiseNumber>
        <CustomerNumber xmlns="">string</CustomerNumber>
        <MarketingCode xmlns="">
          <Code>string</Code>
          <Description>string</Description>
        </MarketingCode>
        <CustomerRespondedDate xmlns="">date</CustomerRespondedDate>
        <AgreementVerification xmlns="">
          <Code>string</Code>
          <Description>string</Description>
        </AgreementVerification>
        <Requestor xmlns="">
          <ContactType>string</ContactType>
          <Prefix>string</Prefix>
          <FirstName>string</FirstName>
          <MiddleInitial>string</MiddleInitial>
          <LastName>string</LastName>
          <Suffix>string</Suffix>
          <FullName>string</FullName>
          <PrimaryContact>
            <PhoneType>string</PhoneType>
            <Phone>string</Phone>
            <Extension>string</Extension>
            <PreferredCallbackTime xsi:nil="true" />
            <DoNotCallFlag>boolean</DoNotCallFlag>
          </PrimaryContact>
          <SecondaryContact>
            <PhoneType>string</PhoneType>
            <Phone>string</Phone>
            <Extension>string</Extension>
            <PreferredCallbackTime xsi:nil="true" />
            <DoNotCallFlag>boolean</DoNotCallFlag>
          </SecondaryContact>
          <Email>
            <EmailType>bytes</EmailType>
            <Email>string</Email>
          </Email>
          <CreatedDate>date</CreatedDate>
          <Memo>string</Memo>
          <SSN>string</SSN>
          <CSRId>string</CSRId>
          <CriticalContactFlag>boolean</CriticalContactFlag>
          <StatusCode>string</StatusCode>
          <CriticalExpirationDate>date</CriticalExpirationDate>
          <Address>
            <AddressType>string</AddressType>
            <AddressKey>string</AddressKey>
            <AddressLineCode>string</AddressLineCode>
            <PreStreetDirection>string</PreStreetDirection>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <AddressLine4>string</AddressLine4>
            <AddressCompressed>string</AddressCompressed>
            <StreetType>string</StreetType>
            <PostStreetDirection>string</PostStreetDirection>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <CountryCode>string</CountryCode>
            <CountyCode>string</CountyCode>
            <CountyName>string</CountyName>
            <RuralOrUrbanCode>string</RuralOrUrbanCode>
            <AddressStatusCode>string</AddressStatusCode>
            <StartDate>date</StartDate>
            <EndDate>date</EndDate>
            <Notes>string</Notes>
          </Address>
          <Address>
            <AddressType>string</AddressType>
            <AddressKey>string</AddressKey>
            <AddressLineCode>string</AddressLineCode>
            <PreStreetDirection>string</PreStreetDirection>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <AddressLine4>string</AddressLine4>
            <AddressCompressed>string</AddressCompressed>
            <StreetType>string</StreetType>
            <PostStreetDirection>string</PostStreetDirection>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <CountryCode>string</CountryCode>
            <CountyCode>string</CountyCode>
            <CountyName>string</CountyName>
            <RuralOrUrbanCode>string</RuralOrUrbanCode>
            <AddressStatusCode>string</AddressStatusCode>
            <StartDate>date</StartDate>
            <EndDate>date</EndDate>
            <Notes>string</Notes>
          </Address>
          <OtherPhone>
            <PhoneType>string</PhoneType>
            <Phone>string</Phone>
            <Extension>string</Extension>
            <PreferredCallbackTime xsi:nil="true" />
            <DoNotCallFlag>boolean</DoNotCallFlag>
          </OtherPhone>
          <OtherPhone>
            <PhoneType>string</PhoneType>
            <Phone>string</Phone>
            <Extension>string</Extension>
            <PreferredCallbackTime xsi:nil="true" />
            <DoNotCallFlag>boolean</DoNotCallFlag>
          </OtherPhone>
          <Fax>
            <PhoneType>string</PhoneType>
            <Phone>string</Phone>
            <Extension>string</Extension>
            <PreferredCallbackTime xsi:nil="true" />
            <DoNotCallFlag>boolean</DoNotCallFlag>
          </Fax>
          <Fax>
            <PhoneType>string</PhoneType>
            <Phone>string</Phone>
            <Extension>string</Extension>
            <PreferredCallbackTime xsi:nil="true" />
            <DoNotCallFlag>boolean</DoNotCallFlag>
          </Fax>
          <EmployerName>string</EmployerName>
          <DriverLicense>
            <Number>string</Number>
            <State>string</State>
            <Birthday>date</Birthday>
            <IssuedDate>date</IssuedDate>
            <ExpirationDate>date</ExpirationDate>
          </DriverLicense>
          <DriverLicense>
            <Number>string</Number>
            <State>string</State>
            <Birthday>date</Birthday>
            <IssuedDate>date</IssuedDate>
            <ExpirationDate>date</ExpirationDate>
          </DriverLicense>
        </Requestor>
        <BusinessDetails xmlns="">
          <BusinessCode>
            <Code>string</Code>
            <Description>string</Description>
          </BusinessCode>
          <ProductCode>
            <Code>string</Code>
            <Description>string</Description>
          </ProductCode>
          <OpCenterCode>
            <Code>string</Code>
            <Description>string</Description>
          </OpCenterCode>
          <APR>float</APR>
          <TotalInstallments>int</TotalInstallments>
          <FinanceChargeAmount>decimal</FinanceChargeAmount>
          <NumberOfInstallment>int</NumberOfInstallment>
          <InstallmentAmount>decimal</InstallmentAmount>
          <FinalInstallmentAmount>decimal</FinalInstallmentAmount>
          <BillingProcess>
            <Code>string</Code>
            <Description>string</Description>
          </BillingProcess>
          <FirstBillDate>date</FirstBillDate>
          <DownPaymentAmount>decimal</DownPaymentAmount>
          <TotalPurchasePrice>decimal</TotalPurchasePrice>
          <DueAmount>decimal</DueAmount>
          <TariffType>
            <Code>string</Code>
            <Description>string</Description>
          </TariffType>
          <TaxableFlag>boolean</TaxableFlag>
          <BusinessServiceStatusCode>
            <Code>string</Code>
            <Description>string</Description>
          </BusinessServiceStatusCode>
          <FinalReasonCode>
            <Code>string</Code>
            <Description>string</Description>
          </FinalReasonCode>
          <BillProcessingClassCode>
            <Code>string</Code>
            <Description>string</Description>
          </BillProcessingClassCode>
          <RemainingInstallments>int</RemainingInstallments>
          <UnearnedFinanceCharge>decimal</UnearnedFinanceCharge>
          <ArrearsBalanceAmount>decimal</ArrearsBalanceAmount>
          <UnbilledBalanceAmount>decimal</UnbilledBalanceAmount>
          <BusinessProductStatusCode>string</BusinessProductStatusCode>
          <CreditAmount>decimal</CreditAmount>
          <ConsumptionAmount>decimal</ConsumptionAmount>
          <ChangeInTermReason>
            <Code>string</Code>
            <Description>string</Description>
          </ChangeInTermReason>
          <ProductOrderNumber>string</ProductOrderNumber>
          <NextBillDate>date</NextBillDate>
        </BusinessDetails>
      </createBusinessRequest>
    </CreateBusiness>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <ScCredentials xmlns="http://ws.southernco.com/CustSvc-iHub">
      <DirectUserNameToken>
        <BinarySecurityToken>
          <ID>string</ID>
        </BinarySecurityToken>
      </DirectUserNameToken>
      <OriginatingUserNameToken>
        <BinarySecurityToken>
          <ID>string</ID>
        </BinarySecurityToken>
      </OriginatingUserNameToken>
      <Created>string</Created>
    </ScCredentials>
  </soap:Header>
  <soap:Body>
    <CreateBusinessResponse xmlns="http://ws.southernco.com/CustSvc-iHub">
      <CreateBusinessResult>
        <BaseResponse xmlns="">
          <MessageDateTime>dateTime</MessageDateTime>
          <ResponseCode>string</ResponseCode>
          <ResponseDescription>string</ResponseDescription>
          <ErrorData>
            <ErrorCode>string</ErrorCode>
            <ErrorDescription>string</ErrorDescription>
            <NativeErrorDetail>string</NativeErrorDetail>
          </ErrorData>
        </BaseResponse>
        <ProductOrderNumber xmlns="">string</ProductOrderNumber>
      </CreateBusinessResult>
    </CreateBusinessResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /webservices/CustomerCareService.asmx HTTP/1.1
Host: ua-custsvc-ihub.southerncompany.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <ScCredentials xmlns="http://ws.southernco.com/CustSvc-iHub">
      <DirectUserNameToken>
        <BinarySecurityToken>
          <ID>string</ID>
        </BinarySecurityToken>
      </DirectUserNameToken>
      <OriginatingUserNameToken>
        <BinarySecurityToken>
          <ID>string</ID>
        </BinarySecurityToken>
      </OriginatingUserNameToken>
      <Created>string</Created>
    </ScCredentials>
  </soap12:Header>
  <soap12:Body>
    <CreateBusiness xmlns="http://ws.southernco.com/CustSvc-iHub">
      <createBusinessRequest>
        <BaseRequest xmlns="">
          <UserId>string</UserId>
          <MessageDateTime>dateTime</MessageDateTime>
          <MessageId>string</MessageId>
          <NameValue>
            <Name>string</Name>
            <Value>string</Value>
          </NameValue>
          <NameValue>
            <Name>string</Name>
            <Value>string</Value>
          </NameValue>
        </BaseRequest>
        <AccountNumber xmlns="">string</AccountNumber>
        <PremiseNumber xmlns="">string</PremiseNumber>
        <CustomerNumber xmlns="">string</CustomerNumber>
        <MarketingCode xmlns="">
          <Code>string</Code>
          <Description>string</Description>
        </MarketingCode>
        <CustomerRespondedDate xmlns="">date</CustomerRespondedDate>
        <AgreementVerification xmlns="">
          <Code>string</Code>
          <Description>string</Description>
        </AgreementVerification>
        <Requestor xmlns="">
          <ContactType>string</ContactType>
          <Prefix>string</Prefix>
          <FirstName>string</FirstName>
          <MiddleInitial>string</MiddleInitial>
          <LastName>string</LastName>
          <Suffix>string</Suffix>
          <FullName>string</FullName>
          <PrimaryContact>
            <PhoneType>string</PhoneType>
            <Phone>string</Phone>
            <Extension>string</Extension>
            <PreferredCallbackTime xsi:nil="true" />
            <DoNotCallFlag>boolean</DoNotCallFlag>
          </PrimaryContact>
          <SecondaryContact>
            <PhoneType>string</PhoneType>
            <Phone>string</Phone>
            <Extension>string</Extension>
            <PreferredCallbackTime xsi:nil="true" />
            <DoNotCallFlag>boolean</DoNotCallFlag>
          </SecondaryContact>
          <Email>
            <EmailType>bytes</EmailType>
            <Email>string</Email>
          </Email>
          <CreatedDate>date</CreatedDate>
          <Memo>string</Memo>
          <SSN>string</SSN>
          <CSRId>string</CSRId>
          <CriticalContactFlag>boolean</CriticalContactFlag>
          <StatusCode>string</StatusCode>
          <CriticalExpirationDate>date</CriticalExpirationDate>
          <Address>
            <AddressType>string</AddressType>
            <AddressKey>string</AddressKey>
            <AddressLineCode>string</AddressLineCode>
            <PreStreetDirection>string</PreStreetDirection>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <AddressLine4>string</AddressLine4>
            <AddressCompressed>string</AddressCompressed>
            <StreetType>string</StreetType>
            <PostStreetDirection>string</PostStreetDirection>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <CountryCode>string</CountryCode>
            <CountyCode>string</CountyCode>
            <CountyName>string</CountyName>
            <RuralOrUrbanCode>string</RuralOrUrbanCode>
            <AddressStatusCode>string</AddressStatusCode>
            <StartDate>date</StartDate>
            <EndDate>date</EndDate>
            <Notes>string</Notes>
          </Address>
          <Address>
            <AddressType>string</AddressType>
            <AddressKey>string</AddressKey>
            <AddressLineCode>string</AddressLineCode>
            <PreStreetDirection>string</PreStreetDirection>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <AddressLine4>string</AddressLine4>
            <AddressCompressed>string</AddressCompressed>
            <StreetType>string</StreetType>
            <PostStreetDirection>string</PostStreetDirection>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <CountryCode>string</CountryCode>
            <CountyCode>string</CountyCode>
            <CountyName>string</CountyName>
            <RuralOrUrbanCode>string</RuralOrUrbanCode>
            <AddressStatusCode>string</AddressStatusCode>
            <StartDate>date</StartDate>
            <EndDate>date</EndDate>
            <Notes>string</Notes>
          </Address>
          <OtherPhone>
            <PhoneType>string</PhoneType>
            <Phone>string</Phone>
            <Extension>string</Extension>
            <PreferredCallbackTime xsi:nil="true" />
            <DoNotCallFlag>boolean</DoNotCallFlag>
          </OtherPhone>
          <OtherPhone>
            <PhoneType>string</PhoneType>
            <Phone>string</Phone>
            <Extension>string</Extension>
            <PreferredCallbackTime xsi:nil="true" />
            <DoNotCallFlag>boolean</DoNotCallFlag>
          </OtherPhone>
          <Fax>
            <PhoneType>string</PhoneType>
            <Phone>string</Phone>
            <Extension>string</Extension>
            <PreferredCallbackTime xsi:nil="true" />
            <DoNotCallFlag>boolean</DoNotCallFlag>
          </Fax>
          <Fax>
            <PhoneType>string</PhoneType>
            <Phone>string</Phone>
            <Extension>string</Extension>
            <PreferredCallbackTime xsi:nil="true" />
            <DoNotCallFlag>boolean</DoNotCallFlag>
          </Fax>
          <EmployerName>string</EmployerName>
          <DriverLicense>
            <Number>string</Number>
            <State>string</State>
            <Birthday>date</Birthday>
            <IssuedDate>date</IssuedDate>
            <ExpirationDate>date</ExpirationDate>
          </DriverLicense>
          <DriverLicense>
            <Number>string</Number>
            <State>string</State>
            <Birthday>date</Birthday>
            <IssuedDate>date</IssuedDate>
            <ExpirationDate>date</ExpirationDate>
          </DriverLicense>
        </Requestor>
        <BusinessDetails xmlns="">
          <BusinessCode>
            <Code>string</Code>
            <Description>string</Description>
          </BusinessCode>
          <ProductCode>
            <Code>string</Code>
            <Description>string</Description>
          </ProductCode>
          <OpCenterCode>
            <Code>string</Code>
            <Description>string</Description>
          </OpCenterCode>
          <APR>float</APR>
          <TotalInstallments>int</TotalInstallments>
          <FinanceChargeAmount>decimal</FinanceChargeAmount>
          <NumberOfInstallment>int</NumberOfInstallment>
          <InstallmentAmount>decimal</InstallmentAmount>
          <FinalInstallmentAmount>decimal</FinalInstallmentAmount>
          <BillingProcess>
            <Code>string</Code>
            <Description>string</Description>
          </BillingProcess>
          <FirstBillDate>date</FirstBillDate>
          <DownPaymentAmount>decimal</DownPaymentAmount>
          <TotalPurchasePrice>decimal</TotalPurchasePrice>
          <DueAmount>decimal</DueAmount>
          <TariffType>
            <Code>string</Code>
            <Description>string</Description>
          </TariffType>
          <TaxableFlag>boolean</TaxableFlag>
          <BusinessServiceStatusCode>
            <Code>string</Code>
            <Description>string</Description>
          </BusinessServiceStatusCode>
          <FinalReasonCode>
            <Code>string</Code>
            <Description>string</Description>
          </FinalReasonCode>
          <BillProcessingClassCode>
            <Code>string</Code>
            <Description>string</Description>
          </BillProcessingClassCode>
          <RemainingInstallments>int</RemainingInstallments>
          <UnearnedFinanceCharge>decimal</UnearnedFinanceCharge>
          <ArrearsBalanceAmount>decimal</ArrearsBalanceAmount>
          <UnbilledBalanceAmount>decimal</UnbilledBalanceAmount>
          <BusinessProductStatusCode>string</BusinessProductStatusCode>
          <CreditAmount>decimal</CreditAmount>
          <ConsumptionAmount>decimal</ConsumptionAmount>
          <ChangeInTermReason>
            <Code>string</Code>
            <Description>string</Description>
          </ChangeInTermReason>
          <ProductOrderNumber>string</ProductOrderNumber>
          <NextBillDate>date</NextBillDate>
        </BusinessDetails>
      </createBusinessRequest>
    </CreateBusiness>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <ScCredentials xmlns="http://ws.southernco.com/CustSvc-iHub">
      <DirectUserNameToken>
        <BinarySecurityToken>
          <ID>string</ID>
        </BinarySecurityToken>
      </DirectUserNameToken>
      <OriginatingUserNameToken>
        <BinarySecurityToken>
          <ID>string</ID>
        </BinarySecurityToken>
      </OriginatingUserNameToken>
      <Created>string</Created>
    </ScCredentials>
  </soap12:Header>
  <soap12:Body>
    <CreateBusinessResponse xmlns="http://ws.southernco.com/CustSvc-iHub">
      <CreateBusinessResult>
        <BaseResponse xmlns="">
          <MessageDateTime>dateTime</MessageDateTime>
          <ResponseCode>string</ResponseCode>
          <ResponseDescription>string</ResponseDescription>
          <ErrorData>
            <ErrorCode>string</ErrorCode>
            <ErrorDescription>string</ErrorDescription>
            <NativeErrorDetail>string</NativeErrorDetail>
          </ErrorData>
        </BaseResponse>
        <ProductOrderNumber xmlns="">string</ProductOrderNumber>
      </CreateBusinessResult>
    </CreateBusinessResponse>
  </soap12:Body>
</soap12:Envelope>