Requests, Responses and Schemas

ChangeCredentialUsernameRequest

This API changes the networkId (username) for a subscriber's credential..

Schema

<ChangeCredentialUsernameRequest>
			<audit> AuditType </audit> [0..1] ?
			<networkId> xsd:string </networkId> [1] ?
			<oldNetworkId> xsd:string </oldNetworkId> [1]
</ChangeCredentialUsernameRequest>

Example

<se:Envelope xmlns:se="http://schemas.xmlsoap.org/soap/envelope/">
  <se:Body>
    <ChangeCredentialUsernameRequest xmlns="http://broadhop.com/unifiedapi/soap/types">
      <audit>
        <id>username</id>
        <comment>comment</comment>
      </audit>
      <networkId>newUniqueIdentifier</networkId>
      <oldNetworkId>uniqueIdentifier</oldNetworkId>
    </ChangeCredentialUsernameRequest>
  </se:Body>
</se:Envelope>

CreateSubscriberRequest

This API creates a subscriber in the USuM database. It also allows provisioning initial quota/balance using the CreateBalance element.

Schema

<CreateSubscriberRequest>
			<audit> AuditType </audit> [0..1] ?
			<subscriber> SubscriberType </subscriber> [1]
</CreateSubscriberRequest>

Example

Minimun Required Fields

<se:Envelope xmlns:se="http://schemas.xmlsoap.org/soap/envelope/">
  <se:Body>
    <CreateSubscriberRequest xmlns="http://broadhop.com/unifiedapi/soap/types">
      <audit>
        <id>username</id>
        <comment>comment</comment>
      </audit>
      <subscriber>
        <credential>
          <networkId>uniqueIdentifier</networkId>
          <password>password</password>
        </credential>
        <status>ACTIVE</status>
      </subscriber>
    </CreateSubscriberRequest>
  </se:Body>
</se:Envelope>

DeleteSubscriberRequest

This API deletes a subscriber from the USuM database.

Schema

<DeleteSubscriberRequest>
			<audit> AuditType </audit> [0..1] ?
			<networkId> xsd:string </networkId> [1] ?
			<hardDelete> xsd:boolean </hardDelete> [0..1] ?
</DeleteSubscriberRequest>

Example

<se:Envelope xmlns:se="http://schemas.xmlsoap.org/soap/envelope/">
  <se:Body>
    <DeleteSubscriberRequest xmlns="http://broadhop.com/unifiedapi/soap/types">
      <audit>
        <id>username</id>
        <comment>comment</comment>
      </audit>
      <networkId>uniqueIdentifier</networkId>
      <hardDelete>false</hardDelete>
    </DeleteSubscriberRequest>
  </se:Body>
</se:Envelope>

GetSubscriberRequest

This API retrieves a subscriber from the USuM database.


Note


Success Response

The GetSubscriber API returns error code 0 (success) even if no subscriber is found.


Schema

<GetSubscriberRequest>
			<audit> AuditType </audit> [0..1] ?
			<networkId> xsd:string </networkId> [1] ?
			<returnSessions> xsd:boolean </returnSessions> [0..1] ?
			<returnBalances> xsd:boolean </returnBalances> [0..1] ?
			<includeExpiredData> xsd:boolean </includeExpiredData> [0..1] ?
			<excludeReservationsFromCreditTotal> xsd:boolean </excludeReservationsFromCreditTotal> [0..1] ?
</GetSubscriberRequest>

Example

<se:Envelope xmlns:se="http://schemas.xmlsoap.org/soap/envelope/">
  <se:Body>
    <GetSubscriberRequest xmlns="http://broadhop.com/unifiedapi/soap/types">
      <audit>
        <id>username</id>
        <comment>comment</comment>
      </audit>
      <networkId>uniqueIdentifier</networkId>
      <returnSessions>false</returnSessions>
      <returnBalances>true</returnBalances>
      <includeExpiredData>false</includeExpiredData>
      <excludeReservationsFromCreditTotal>true</excludeReservationsFromCreditTotal>
    </GetSubscriberRequest>
  </se:Body>
</se:Envelope>