SMSDomain API – account
Specs
The technical specification defining the payloads in this section can be found in the Service Delivery Platform API under the topic "SMS Domain API WSDL & XSD".
Use cases
Create account
Creates an account in the SDP. Full account details can be provided. A number of users (at least one) can be created under the Account in the same request.
Parameters
You must include the following parameters:
Parameter | Description |
---|---|
account | Full account description as defined in Account. |
user | List of 1..n users as described in User. |
Response
Returns the created account instance as defined in Account.
Example
Sample create account request, where the client provides the accountNumber
:
<soapenv:Header/>
<soapenv:Body>
<sms:CreateAccount>
<account>
<accountNumber>Beeline Account 1</accountNumber>
<status>ACTIVE</status>
<maxMPDeviceAllowed>5</maxMPDeviceAllowed>
</account>
<user><uid/>
<name>Beeline</name>
<password>484e76d0b1b36e26982fb33311895795c40324a95edc27db8739ab1f1a758bfe</password>
<pin>3310</pin>
<defaultUser>true</defaultUser>
<hashSalt>salt</hashSalt>
<loginId>Beeline@loginID5</loginId>
<type>SUP</type>
<purchaseAbility>ALLOWED</purchaseAbility>
</user>
</sms:CreateAccount>
</soapenv:Body>
Sample create account response, where SDP has assigned a UID to the Account instance:
<soapenv:Header/>
<soapenv:Body>
<acc:Account>
<account>
<uid>55</uid>
<accountNumber>Beeline Account 1</accountNumber>
<status>ACTIVE</status>
<accessPointSpecification>
<uid>1</uid>
</accessPointSpecification>
<maxMPDeviceAllowed>5</maxMPDeviceAllowed>
<modificationDate>2012-05-22T09:30:10+01</modificationDate>
</account>
</acc:Account>
</soapenv:Body>
Retrieve account
Retrieval operation of accounts is available through the following APIs in the account service:
- Get Account By Account Number
- Get Account By Account UID
- Get Account By Account Specification
- Get Account By Origin Key and Origin Id
- Get Account By User UID
Update account
Updates an existing account in the SDP. Only RW parameters can be modified.
Parameters
You must include the following parameters:
Parameter | Description |
---|---|
account | Account to update as defined in Account. At least one of the following fields is mandatory: |
Response
Empty response payload.
Example
Sample update account request, given the accountNumber
, to increase the account's credit limit:
<soapenv:Header/>
<soapenv:Body>
<sms:UpdateAccount>
<account>
<uid>55</uid>
<accountNumber>Beeline Account 1</accountNumber>
<creditLimit>2000.0</creditLimit>
</account>
</sms:UpdateAccount>
</soapenv:Body>
Sample update account response:
<soapenv:Header/>
<soapenv:Body/>
Delete account
Deletes an existing account, given an Account Specification.
This sets the account status to CANCELLED rather than physically deleting the entity from the database. This enables any outstanding billing actions to complete, and ensures the integrity of the operator's records.
Parameters
You must include the following parameters:
Parameter | Description |
---|---|
accountSpecification | Account to update as defined an Account Specification. At least one of the following fields is mandatory: |
Response
Empty response payload.
Example
Sample delete account request, given the accountNumber
inside the account specification:
<soapenv:Header/>
<soapenv:Body>
<sms:DeleteAccount>
<accountSpecification>
<accountNumber>Beeline Account 1</accountNumber>
</accountSpecification>
</sms:DeleteAccount>
</soapenv:Body>
Sample delete account response:
<soapenv:Header/>
<soapenv:Body/>
Suspend account
Suspends an existing account, given an Account Specification.
This sets the account status to SUSPENDED. The account is not permitted to sign on when in this state. Access to content is temporarily denied.
Parameters
You must include the following parameters:
Parameter | Description |
---|---|
accountSpecification | Account to update as defined in AccountSpecification. At least one of the following fields is mandatory: accountNumber, accountUID, originKeyAndId. |
Response
Empty response payload.
Example
Sample suspend account request, given the accountNumber
inside the account specification:
<soapenv:Header/>
<soapenv:Body>
<sms:SuspendAccount>
<accountSpecification>
<accountNumber>Beeline Account 1</accountNumber>
</accountSpecification>
</sms:SuspendAccount>
</soapenv:Body>
Sample suspend account response:
<soapenv:Header/>
<soapenv:Body/>
Reactivate account
Reactivates a suspended account, given an Account Specification.
This sets the account status to ACTIVE. The account is returned to a normal operational state.
Parameters
You must include the following parameters:
Parameter | Description |
---|---|
accountSpecification | Account to update as defined in AccountSpecification. At least one of the following fields is mandatory: accountNumber, accountUID, originKeyAndId. |
Response
Empty response payload.
Example
Sample reactivate account request, given the accountNumber
inside the account specification:
<soapenv:Header/>
<soapenv:Body>
<sms:ReactivateAccount>
<accountSpecification>
<accountNumber>Beeline Account 1</accountNumber>
</accountSpecification>
</sms:ReactivateAccount>
</soapenv:Body>
Sample reactivate account response:
<soapenv:Header/>
<soapenv:Body/>
Cancel account
Cancels an account, given an Account Specification.
This sets the account status to CANCELLED state from which the account cannot be restored. The account details are retained for billing and reporting purposes even after cancellation.
Parameters
You must include the following parameters:
Parameter | Description |
---|---|
accountSpecification | Account to update as defined in AccountSpecification. At least one of the following fields is mandatory: accountNumber, accountUID, originKeyAndId. |
Response
Empty response payload.
Example
Cancel an account request, given the accountNumber
inside the account specification:
<soapenv:Header/>
<soapenv:Body>
<sms:CancelAccount>
<accountSpecification>
<accountNumber>Beeline Account 1</accountNumber>
</accountSpecification>
</sms:CancelAccount>
</soapenv:Body>
Sample cancel account response:
<soapenv:Header/>
<soapenv:Body/>
Add products to account
Adds product entitlements to a specified account, given an Account Specification.
Parameters
You must include the following parameters:
Parameter | Description |
---|---|
accountSpecification | Account to update as defined in AccountSpecification. At least one of the following fields is mandatory: accountNumber, accountUID, originKeyAndId. |
products | One or more Products offerings. |
Response
Empty response payload.
Example
Adds products to an account request, given the accountNumber
inside the account specification and the identity of the products required:
<soapenv:Header/>
<soapenv:Body>
<sms:AddProductsToAccount>
<accountSpecification>
<accountNumber>Beeline Account 1</accountNumber>
</accountSpecification>
<products>
<originSpecification>
<originKey>352632454</originKey>
<originId>1</originKey>
</originSpecification>
</products>
</sms:AddProductsToAccount>
</soapenv:Body>
Sample add products to account response:
<soapenv:Header/>
<soapenv:Body/>
Remove products from account
Remove product entitlements from a specified account, given an Account Specification.
Parameters
You must include the following parameters:
Parameter | Description |
---|---|
accountSpecification | Account to update as defined in AccountSpecification. At least one of the following fields is mandatory: accountNumber, accountUID, originKeyAndId. |
products | One or more Products offerings. |
Response
Empty response payload.
Example
Removes Products from an account request, given the accountNumber
inside the account specification and the identity of the products required:
<soapenv:Header/>
<soapenv:Body>
<sms:RemoveProductsFromAccount>
<accountSpecification>
<accountNumber>Beeline Account 1</accountNumber>
</accountSpecification>
<products>
<originSpecification>
<originKey>352632454</originKey>
<originId>1</originKey>
</originSpecification>
</products>
</sms:RemoveProductsFromAccount>
</soapenv:Body>
Sample remove products from account response:
<soapenv:Header/>
<soapenv:Body/>
Set zip code
Updates the account with the given zip code and sends the related command to the devices in the account.
Parameters
You must include the following parameters:
Parameter | Description |
---|---|
accountSpecification | The account identified via AccountSpecification. |
Response
Empty response payload.
Example
Sample SetZipCode
request:
<soapenv:Header/>
<soapenv:Body>
<sms:SetZipCode>
<accountSpecification>
<accountNumber>Beeline Account 1</accountNumber>
</accountSpecification>
<zipCode>1037</zipCode>
</sms:SetZipCode>
</soapenv:Body>
Set network by account
Sets the network value provided in the request to all the devices in the account.
Performs the following checks:
- The account is ACTIVE or RESTRICTED
- The network is a numeric value in the 0-999 range
Parameters
You must include the following parameters:
Parameter | Description |
---|---|
accountSpecification | The account identified via AccountSpecification. |
network | Network identifier to which the device belongs (operator specific). |
Response
Empty response payload.
Example
Sample SetNetworkByAccount
request:
<soapenv:Header/>
<soapenv:Body>
<sms:SetNetworkByAccount>
<accountSpecification>
<accountNumber>Beeline Account 1</accountNumber>
</accountSpecification>
<network>555</network>
</sms:SetNetworkByAccount>
</soapenv:Body>
Generate IRD for account
Sends the provided command for all the active devices with a smartcard in the account.
Performs the following checks:
- The account is ACTIVE or RESTRICTED
Parameters
You must include the following parameters:
Parameter | Description |
---|---|
accountSpecification | The account identified via AccountSpecification. |
commandId | Identifier of the command to be sent. |
operationId | Operation identifier (CAS specific). |
payload | Any payload required (CAS specific). |
Response
Empty response payload.
Example
Sample GenerateIrdForAccount
request:
<soapenv:Header/>
<soapenv:Body>
<sms:GenerateIrdForAccount>
<accountSpecification>
<accountNumber>Beeline Account 1</accountNumber>
</accountSpecification>
<commandId>5</commandId>
<operationId>22</operationId>
<payload></payload>
</sms:GenerateIrdForAccount>
</soapenv:Body>