GetCallbackRegistrations

Returns the name and endpoint URL of all callback services associated with a given account.

Request Parameters

Parameter Type Description
AccountName
required
string The name of the account for which a list of registered callback services will be returned. An account name is usually numeric, and must include any leading zeros.

Response Parameters

Parameter Type Description
Registrations CallbackRegistration A list of URLs that are registered for callback services for the account.
AccountName string The name of the account for which callback messages will be sent.
ServiceName string The name of the callback service, which identifies the type and format of messages that will be sent to the registered URL.
Url string The address of the callback listening service where the M2M Platform will send callback messages for the service type.
Username string The username defined when a URL was registered for a specific callback service, or an empty element if no username was defined.
Password string The password defined when a URL was registered for a specific callback service, or an empty element if no password was defined.
ExtendedAttributes ExtendedAttributesObj Any extended attributes configured for the callback service.
Key string The key for an extended attribute.
Value string The value of an extended attribute.

Example SOAP Request

<soapenv:Envelope 
  xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:v2="http://nphase.com/unifiedwebservice/v2" 
  xmlns:nph="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.CallbackRegistrationService">
  <soapenv:Header>
    <v2:token>current_session_token</v2:token>
  </soapenv:Header>
  <soapenv:Body>
    <v2:GetCallbackRegistrations>
      <v2:Input>
        <nph:AccountName>account_name</nph:AccountName>
      </v2:Input>
    </v2:GetCallbackRegistrations>
  </soapenv:Body>
</soapenv:Envelope>

Example SOAP Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetCallbackRegistrationsResponse xmlns="http://nphase.com/unifiedwebservice/v2">
      <Output xmlns:a="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.CallbackRegistrationService" 
        xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:Registrations>
          <a:CallbackRegistration>
            <a:AccountName>account_name</a:AccountName>
            <a:ServiceName>DeviceUsage</a:ServiceName>
            <a:Url>http://10.120.102.183:50559/Callback/API/CallbackService.asmx</a:Url>
            <a:Username/>
            <a:Password/>
            <a:ExtendedAttributes i:nil="true" xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common"/>
          </a:CallbackRegistration>
          <a:CallbackRegistration>
            <a:AccountName>account_name</a:AccountName>
            <a:ServiceName>CarrierService</a:ServiceName>
            <a:Url>http://10.120.102.147:50569/Callback/API/CallbackService.asmx</a:Url>
            <a:Username/>
            <a:Password/>
            <a:ExtendedAttributes i:nil="true" xmlns:b="http://schemas.datacontract.org/2004/07/NPhase.UnifiedWebService.APIs.v2.Contract.Common"/>
          </a:CallbackRegistration>
        </a:Registrations>
      </Output>
    </GetCallbackRegistrationsResponse>
  </s:Body>
</s:Envelope>

Request Schema Diagram

Response Schema Diagram