CustomerCareService Web Service

CustomerCareService

Click here for a complete list of operations.

CreateLightingOutageMessage

Creates a lighting outage message

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

<?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>
    <CreateLightingOutageMessage xmlns="http://ws.southernco.com/CustSvc-iHub">
      <lightingOutageRequest>
        <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>
        <CallerId xmlns="">string</CallerId>
        <Account xmlns="">
          <AccountName>string</AccountName>
          <AccountNumber>string</AccountNumber>
          <AccountStatus>string</AccountStatus>
          <CriticalAccountCode>string</CriticalAccountCode>
          <PrimaryContact>
            <ContactType>string</ContactType>
            <Prefix>string</Prefix>
            <FirstName>string</FirstName>
            <MiddleInitial>string</MiddleInitial>
            <LastName>string</LastName>
            <Suffix>string</Suffix>
            <FullName>string</FullName>
            <PrimaryContact xsi:nil="true" />
            <SecondaryContact xsi:nil="true" />
            <Email xsi:nil="true" />
            <CreatedDate>date</CreatedDate>
            <Memo>string</Memo>
            <SSN>string</SSN>
            <CSRId>string</CSRId>
            <CriticalContactFlag>boolean</CriticalContactFlag>
            <StatusCode>string</StatusCode>
            <CriticalExpirationDate>date</CriticalExpirationDate>
            <Address xsi:nil="true" />
            <Address xsi:nil="true" />
            <OtherPhone xsi:nil="true" />
            <OtherPhone xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Fax xsi:nil="true" />
            <EmployerName>string</EmployerName>
            <DriverLicense xsi:nil="true" />
            <DriverLicense xsi:nil="true" />
          </PrimaryContact>
          <ServiceAddress>
            <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>
          </ServiceAddress>
          <OperatingCenter>
            <OpCenterCode>string</OpCenterCode>
            <RegionCode>string</RegionCode>
            <RegionName>string</RegionName>
            <CompanyCode>string</CompanyCode>
            <DivisionCode>string</DivisionCode>
            <DivisionName>string</DivisionName>
          </OperatingCenter>
          <OutageMessages>
            <OutageId>string</OutageId>
            <MessageType>string</MessageType>
            <MessageToPlay>string</MessageToPlay>
            <OutageDate>dateTime</OutageDate>
            <EstimatedRestorationDate>dateTime</EstimatedRestorationDate>
            <EstimatedRestorationDateString>string</EstimatedRestorationDateString>
            <TroubleCode>string</TroubleCode>
            <CallBackRequestFlag>boolean</CallBackRequestFlag>
            <CallBackPhone xsi:nil="true" />
            <CallBackResponseFlag>boolean</CallBackResponseFlag>
            <CancelFlag>boolean</CancelFlag>
            <OutageRemarks xsi:nil="true" />
            <IsExistsFlag>boolean</IsExistsFlag>
            <CaseNotesCode>string</CaseNotesCode>
            <AreaMessage>string</AreaMessage>
            <AreaMessageRestorationDateTime>dateTime</AreaMessageRestorationDateTime>
            <AreaMessageRestorationDateTimeString>string</AreaMessageRestorationDateTimeString>
            <PrevMessageInstanceId>string</PrevMessageInstanceId>
            <StatusUpdatedDate>dateTime</StatusUpdatedDate>
            <StatusUpdatedDateString>string</StatusUpdatedDateString>
            <ByPassIndicator xsi:nil="true" />
            <ComponentID>string</ComponentID>
            <FeederSwitchID>string</FeederSwitchID>
          </OutageMessages>
          <OutageMessages>
            <OutageId>string</OutageId>
            <MessageType>string</MessageType>
            <MessageToPlay>string</MessageToPlay>
            <OutageDate>dateTime</OutageDate>
            <EstimatedRestorationDate>dateTime</EstimatedRestorationDate>
            <EstimatedRestorationDateString>string</EstimatedRestorationDateString>
            <TroubleCode>string</TroubleCode>
            <CallBackRequestFlag>boolean</CallBackRequestFlag>
            <CallBackPhone xsi:nil="true" />
            <CallBackResponseFlag>boolean</CallBackResponseFlag>
            <CancelFlag>boolean</CancelFlag>
            <OutageRemarks xsi:nil="true" />
            <IsExistsFlag>boolean</IsExistsFlag>
            <CaseNotesCode>string</CaseNotesCode>
            <AreaMessage>string</AreaMessage>
            <AreaMessageRestorationDateTime>dateTime</AreaMessageRestorationDateTime>
            <AreaMessageRestorationDateTimeString>string</AreaMessageRestorationDateTimeString>
            <PrevMessageInstanceId>string</PrevMessageInstanceId>
            <StatusUpdatedDate>dateTime</StatusUpdatedDate>
            <StatusUpdatedDateString>string</StatusUpdatedDateString>
            <ByPassIndicator xsi:nil="true" />
            <ComponentID>string</ComponentID>
            <FeederSwitchID>string</FeederSwitchID>
          </OutageMessages>
          <Premise>
            <PremiseNumber>string</PremiseNumber>
            <DrivingDirections>string</DrivingDirections>
            <DrivingDirectionsKey>string</DrivingDirectionsKey>
            <LocationId xsi:nil="true" />
            <LocationTypeCode>string</LocationTypeCode>
            <ReadingRouteCode>string</ReadingRouteCode>
            <ReadingRouteSequenceNumber>string</ReadingRouteSequenceNumber>
            <GWACode>string</GWACode>
            <Meters xsi:nil="true" />
            <Meters xsi:nil="true" />
            <BuildingNumber>string</BuildingNumber>
            <LockSequenceNumber>int</LockSequenceNumber>
          </Premise>
          <Customer>
            <CustomerNumber>string</CustomerNumber>
          </Customer>
          <Bill>
            <BillGroup>string</BillGroup>
          </Bill>
          <LockSequenceNumber>int</LockSequenceNumber>
        </Account>
      </lightingOutageRequest>
    </CreateLightingOutageMessage>
  </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>
    <CreateLightingOutageMessageResponse xmlns="http://ws.southernco.com/CustSvc-iHub">
      <CreateLightingOutageMessageResult>
        <BaseResponse xmlns="">
          <MessageDateTime>dateTime</MessageDateTime>
          <ResponseCode>string</ResponseCode>
          <ResponseDescription>string</ResponseDescription>
          <ErrorData>
            <ErrorCode>string</ErrorCode>
            <ErrorDescription>string</ErrorDescription>
            <NativeErrorDetail>string</NativeErrorDetail>
          </ErrorData>
        </BaseResponse>
      </CreateLightingOutageMessageResult>
    </CreateLightingOutageMessageResponse>
  </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>
    <CreateLightingOutageMessage xmlns="http://ws.southernco.com/CustSvc-iHub">
      <lightingOutageRequest>
        <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>
        <CallerId xmlns="">string</CallerId>
        <Account xmlns="">
          <AccountName>string</AccountName>
          <AccountNumber>string</AccountNumber>
          <AccountStatus>string</AccountStatus>
          <CriticalAccountCode>string</CriticalAccountCode>
          <PrimaryContact>
            <ContactType>string</ContactType>
            <Prefix>string</Prefix>
            <FirstName>string</FirstName>
            <MiddleInitial>string</MiddleInitial>
            <LastName>string</LastName>
            <Suffix>string</Suffix>
            <FullName>string</FullName>
            <PrimaryContact xsi:nil="true" />
            <SecondaryContact xsi:nil="true" />
            <Email xsi:nil="true" />
            <CreatedDate>date</CreatedDate>
            <Memo>string</Memo>
            <SSN>string</SSN>
            <CSRId>string</CSRId>
            <CriticalContactFlag>boolean</CriticalContactFlag>
            <StatusCode>string</StatusCode>
            <CriticalExpirationDate>date</CriticalExpirationDate>
            <Address xsi:nil="true" />
            <Address xsi:nil="true" />
            <OtherPhone xsi:nil="true" />
            <OtherPhone xsi:nil="true" />
            <Fax xsi:nil="true" />
            <Fax xsi:nil="true" />
            <EmployerName>string</EmployerName>
            <DriverLicense xsi:nil="true" />
            <DriverLicense xsi:nil="true" />
          </PrimaryContact>
          <ServiceAddress>
            <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>
          </ServiceAddress>
          <OperatingCenter>
            <OpCenterCode>string</OpCenterCode>
            <RegionCode>string</RegionCode>
            <RegionName>string</RegionName>
            <CompanyCode>string</CompanyCode>
            <DivisionCode>string</DivisionCode>
            <DivisionName>string</DivisionName>
          </OperatingCenter>
          <OutageMessages>
            <OutageId>string</OutageId>
            <MessageType>string</MessageType>
            <MessageToPlay>string</MessageToPlay>
            <OutageDate>dateTime</OutageDate>
            <EstimatedRestorationDate>dateTime</EstimatedRestorationDate>
            <EstimatedRestorationDateString>string</EstimatedRestorationDateString>
            <TroubleCode>string</TroubleCode>
            <CallBackRequestFlag>boolean</CallBackRequestFlag>
            <CallBackPhone xsi:nil="true" />
            <CallBackResponseFlag>boolean</CallBackResponseFlag>
            <CancelFlag>boolean</CancelFlag>
            <OutageRemarks xsi:nil="true" />
            <IsExistsFlag>boolean</IsExistsFlag>
            <CaseNotesCode>string</CaseNotesCode>
            <AreaMessage>string</AreaMessage>
            <AreaMessageRestorationDateTime>dateTime</AreaMessageRestorationDateTime>
            <AreaMessageRestorationDateTimeString>string</AreaMessageRestorationDateTimeString>
            <PrevMessageInstanceId>string</PrevMessageInstanceId>
            <StatusUpdatedDate>dateTime</StatusUpdatedDate>
            <StatusUpdatedDateString>string</StatusUpdatedDateString>
            <ByPassIndicator xsi:nil="true" />
            <ComponentID>string</ComponentID>
            <FeederSwitchID>string</FeederSwitchID>
          </OutageMessages>
          <OutageMessages>
            <OutageId>string</OutageId>
            <MessageType>string</MessageType>
            <MessageToPlay>string</MessageToPlay>
            <OutageDate>dateTime</OutageDate>
            <EstimatedRestorationDate>dateTime</EstimatedRestorationDate>
            <EstimatedRestorationDateString>string</EstimatedRestorationDateString>
            <TroubleCode>string</TroubleCode>
            <CallBackRequestFlag>boolean</CallBackRequestFlag>
            <CallBackPhone xsi:nil="true" />
            <CallBackResponseFlag>boolean</CallBackResponseFlag>
            <CancelFlag>boolean</CancelFlag>
            <OutageRemarks xsi:nil="true" />
            <IsExistsFlag>boolean</IsExistsFlag>
            <CaseNotesCode>string</CaseNotesCode>
            <AreaMessage>string</AreaMessage>
            <AreaMessageRestorationDateTime>dateTime</AreaMessageRestorationDateTime>
            <AreaMessageRestorationDateTimeString>string</AreaMessageRestorationDateTimeString>
            <PrevMessageInstanceId>string</PrevMessageInstanceId>
            <StatusUpdatedDate>dateTime</StatusUpdatedDate>
            <StatusUpdatedDateString>string</StatusUpdatedDateString>
            <ByPassIndicator xsi:nil="true" />
            <ComponentID>string</ComponentID>
            <FeederSwitchID>string</FeederSwitchID>
          </OutageMessages>
          <Premise>
            <PremiseNumber>string</PremiseNumber>
            <DrivingDirections>string</DrivingDirections>
            <DrivingDirectionsKey>string</DrivingDirectionsKey>
            <LocationId xsi:nil="true" />
            <LocationTypeCode>string</LocationTypeCode>
            <ReadingRouteCode>string</ReadingRouteCode>
            <ReadingRouteSequenceNumber>string</ReadingRouteSequenceNumber>
            <GWACode>string</GWACode>
            <Meters xsi:nil="true" />
            <Meters xsi:nil="true" />
            <BuildingNumber>string</BuildingNumber>
            <LockSequenceNumber>int</LockSequenceNumber>
          </Premise>
          <Customer>
            <CustomerNumber>string</CustomerNumber>
          </Customer>
          <Bill>
            <BillGroup>string</BillGroup>
          </Bill>
          <LockSequenceNumber>int</LockSequenceNumber>
        </Account>
      </lightingOutageRequest>
    </CreateLightingOutageMessage>
  </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>
    <CreateLightingOutageMessageResponse xmlns="http://ws.southernco.com/CustSvc-iHub">
      <CreateLightingOutageMessageResult>
        <BaseResponse xmlns="">
          <MessageDateTime>dateTime</MessageDateTime>
          <ResponseCode>string</ResponseCode>
          <ResponseDescription>string</ResponseDescription>
          <ErrorData>
            <ErrorCode>string</ErrorCode>
            <ErrorDescription>string</ErrorDescription>
            <NativeErrorDetail>string</NativeErrorDetail>
          </ErrorData>
        </BaseResponse>
      </CreateLightingOutageMessageResult>
    </CreateLightingOutageMessageResponse>
  </soap12:Body>
</soap12:Envelope>