CustomerCareService Web Service

CustomerCareService

Click here for a complete list of operations.

GetPaperlessBillingInfo

Returns customer information via a lookup to CSS based on either account or phone number

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/GetPaperlessBillingInfo"

<?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>
    <GetPaperlessBillingInfo xmlns="http://ws.southernco.com/CustSvc-iHub">
      <lookupInfo>
        <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>
        <AccountNumber xmlns="">string</AccountNumber>
      </lookupInfo>
    </GetPaperlessBillingInfo>
  </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>
    <GetPaperlessBillingInfoResponse xmlns="http://ws.southernco.com/CustSvc-iHub">
      <GetPaperlessBillingInfoResult>
        <BaseResponse xmlns="">
          <MessageDateTime>dateTime</MessageDateTime>
          <ResponseCode>string</ResponseCode>
          <ResponseDescription>string</ResponseDescription>
          <ErrorData>
            <ErrorCode>string</ErrorCode>
            <ErrorDescription>string</ErrorDescription>
            <NativeErrorDetail>string</NativeErrorDetail>
          </ErrorData>
        </BaseResponse>
        <PaperlessInfo xmlns="">
          <PaperlessBillingActionCode>string</PaperlessBillingActionCode>
          <PaperlessBillingStatus>string</PaperlessBillingStatus>
          <Email>string</Email>
          <EmailReminderFlag>string</EmailReminderFlag>
          <EmailReminderDays>decimal</EmailReminderDays>
          <ReminderEligibilityFlag>string</ReminderEligibilityFlag>
          <DefaultEmailReminderDays>decimal</DefaultEmailReminderDays>
          <DefaultEmailReminderDays>decimal</DefaultEmailReminderDays>
          <EmailVerifiedFlag>string</EmailVerifiedFlag>
          <NumEmailsUndelivered>string</NumEmailsUndelivered>
          <EmailUndeliveredRecentReason>string</EmailUndeliveredRecentReason>
          <ValidateEmailFlag>string</ValidateEmailFlag>
          <EFTIndicator>string</EFTIndicator>
          <PaperlessEligibilityFlag>string</PaperlessEligibilityFlag>
          <LockingSeqNumber>decimal</LockingSeqNumber>
        </PaperlessInfo>
      </GetPaperlessBillingInfoResult>
    </GetPaperlessBillingInfoResponse>
  </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>
    <GetPaperlessBillingInfo xmlns="http://ws.southernco.com/CustSvc-iHub">
      <lookupInfo>
        <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>
        <AccountNumber xmlns="">string</AccountNumber>
      </lookupInfo>
    </GetPaperlessBillingInfo>
  </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>
    <GetPaperlessBillingInfoResponse xmlns="http://ws.southernco.com/CustSvc-iHub">
      <GetPaperlessBillingInfoResult>
        <BaseResponse xmlns="">
          <MessageDateTime>dateTime</MessageDateTime>
          <ResponseCode>string</ResponseCode>
          <ResponseDescription>string</ResponseDescription>
          <ErrorData>
            <ErrorCode>string</ErrorCode>
            <ErrorDescription>string</ErrorDescription>
            <NativeErrorDetail>string</NativeErrorDetail>
          </ErrorData>
        </BaseResponse>
        <PaperlessInfo xmlns="">
          <PaperlessBillingActionCode>string</PaperlessBillingActionCode>
          <PaperlessBillingStatus>string</PaperlessBillingStatus>
          <Email>string</Email>
          <EmailReminderFlag>string</EmailReminderFlag>
          <EmailReminderDays>decimal</EmailReminderDays>
          <ReminderEligibilityFlag>string</ReminderEligibilityFlag>
          <DefaultEmailReminderDays>decimal</DefaultEmailReminderDays>
          <DefaultEmailReminderDays>decimal</DefaultEmailReminderDays>
          <EmailVerifiedFlag>string</EmailVerifiedFlag>
          <NumEmailsUndelivered>string</NumEmailsUndelivered>
          <EmailUndeliveredRecentReason>string</EmailUndeliveredRecentReason>
          <ValidateEmailFlag>string</ValidateEmailFlag>
          <EFTIndicator>string</EFTIndicator>
          <PaperlessEligibilityFlag>string</PaperlessEligibilityFlag>
          <LockingSeqNumber>decimal</LockingSeqNumber>
        </PaperlessInfo>
      </GetPaperlessBillingInfoResult>
    </GetPaperlessBillingInfoResponse>
  </soap12:Body>
</soap12:Envelope>