CustomerCareService Web Service

CustomerCareService

Click here for a complete list of operations.

CreateCallLog

Create Call Log

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

<?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>
    <CreateCallLog xmlns="http://ws.southernco.com/CustSvc-iHub">
      <CreateCallLogRequest>
        <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>
        <CustomerCallLog xmlns="">
          <Requestor>
            <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" />
          </Requestor>
          <CSRId>string</CSRId>
          <CreatedDateTime>dateTime</CreatedDateTime>
          <LogText>string</LogText>
          <RequestType>int</RequestType>
          <Customer>
            <CustomerId>string</CustomerId>
            <CustomerName>string</CustomerName>
            <CustomerNumber>string</CustomerNumber>
            <DBA>string</DBA>
            <Contact xsi:nil="true" />
            <Contact xsi:nil="true" />
            <RepId>string</RepId>
          </Customer>
          <Premise>
            <PremiseNumber>string</PremiseNumber>
            <PremiseAddress xsi:nil="true" />
            <Contact xsi:nil="true" />
            <Contact xsi:nil="true" />
          </Premise>
          <Account>
            <AccountNumber>string</AccountNumber>
            <AccountType>string</AccountType>
            <AccountStatus>string</AccountStatus>
            <BillingAddress xsi:nil="true" />
            <PrimaryContact xsi:nil="true" />
            <ServiceAddress xsi:nil="true" />
            <OperatingCenter xsi:nil="true" />
          </Account>
        </CustomerCallLog>
      </CreateCallLogRequest>
    </CreateCallLog>
  </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>
    <CreateCallLogResponse xmlns="http://ws.southernco.com/CustSvc-iHub">
      <CreateCallLogResult>
        <BaseResponse xmlns="">
          <MessageDateTime>dateTime</MessageDateTime>
          <ResponseCode>string</ResponseCode>
          <ResponseDescription>string</ResponseDescription>
          <ErrorData>
            <ErrorCode>string</ErrorCode>
            <ErrorDescription>string</ErrorDescription>
            <NativeErrorDetail>string</NativeErrorDetail>
          </ErrorData>
        </BaseResponse>
      </CreateCallLogResult>
    </CreateCallLogResponse>
  </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>
    <CreateCallLog xmlns="http://ws.southernco.com/CustSvc-iHub">
      <CreateCallLogRequest>
        <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>
        <CustomerCallLog xmlns="">
          <Requestor>
            <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" />
          </Requestor>
          <CSRId>string</CSRId>
          <CreatedDateTime>dateTime</CreatedDateTime>
          <LogText>string</LogText>
          <RequestType>int</RequestType>
          <Customer>
            <CustomerId>string</CustomerId>
            <CustomerName>string</CustomerName>
            <CustomerNumber>string</CustomerNumber>
            <DBA>string</DBA>
            <Contact xsi:nil="true" />
            <Contact xsi:nil="true" />
            <RepId>string</RepId>
          </Customer>
          <Premise>
            <PremiseNumber>string</PremiseNumber>
            <PremiseAddress xsi:nil="true" />
            <Contact xsi:nil="true" />
            <Contact xsi:nil="true" />
          </Premise>
          <Account>
            <AccountNumber>string</AccountNumber>
            <AccountType>string</AccountType>
            <AccountStatus>string</AccountStatus>
            <BillingAddress xsi:nil="true" />
            <PrimaryContact xsi:nil="true" />
            <ServiceAddress xsi:nil="true" />
            <OperatingCenter xsi:nil="true" />
          </Account>
        </CustomerCallLog>
      </CreateCallLogRequest>
    </CreateCallLog>
  </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>
    <CreateCallLogResponse xmlns="http://ws.southernco.com/CustSvc-iHub">
      <CreateCallLogResult>
        <BaseResponse xmlns="">
          <MessageDateTime>dateTime</MessageDateTime>
          <ResponseCode>string</ResponseCode>
          <ResponseDescription>string</ResponseDescription>
          <ErrorData>
            <ErrorCode>string</ErrorCode>
            <ErrorDescription>string</ErrorDescription>
            <NativeErrorDetail>string</NativeErrorDetail>
          </ErrorData>
        </BaseResponse>
      </CreateCallLogResult>
    </CreateCallLogResponse>
  </soap12:Body>
</soap12:Envelope>