Admin API Methods

addKey

This Operation will add keys to the given resource object.On successful execution, Resource object will be returned with the added key in it. On an exception, the key will not be added.

addUserToCustomer

This function will add a user to a customer.

createBillingEntity

This function will create a billing entity object.

createCluster

Create a record for the specified cluster

createCustomer

This function will create a customer, processing a promotion code if necessary.

createInterworkingNetwork

This function will create an Internetworking VLAN.

createInvoice

This function will create and return a Invoice

createPaymentCardDetails

This function will create and return a payment card details.

createPaymentMethod

This function will create and return a paymentMethod

createProduct

This function will create and return a product

createProductOffer

This function will create and return a product offer.

createPromotion

This function will create and returns a promotion.

createPromotionCode

This function will create and returns a promotion code.

createReferralPromoCode

This function will return a the newly created Referral promocode Object.

createReferralPromotion

This function will return a the newly created Referral promotion Object.

createStorageUnit

Create a storage unit

createTransactionLog

This function will create and return a record for log

createUser

This function will create a user/contact with the given user details and returns the newly created User.

deleteCluster

Removes the records for all resources in the specified cluster. Users should be warned of the consequences before issuing this call.

deletePromoCode

This function will remove the given promotion code.

deleteReferralPromoCode

This function will remove the given referral promo code.

deleteResource

This Operation will delete an existing resource object.If cascade is set to true, its a deep delete On successful execution, true is returned. On an exception, the resource is not deleted.

deleteTransactionLogs

This Operation will delete existing transation logs.Deletes records that matches the filter On successful execution, true is returned. On an exception, the logs are not deleted.

doQuery

This function will query the database, aggregating and grouping results if relevant.

doUnitTransaction

This function will return a newly created Unit Transaction Object.

getCustomer

This function will return the customer object for a customer given its UUID.

getPurchasedUnits

This function searches for a list of units purchased within a given date range and for a given Billing Entity ID.

getUser

This function returns details about existing User.

listBillingEntities

This function searches for a list of billing entities matching a given search filter.

listCurrencies

This function searches for a list of currencies matching a given search filter.

listCustomer

This function searches for a list of existing customers.

listInvoices

This function searches for a list of invoices matching a given search filter.

listProductOffers

This function searches for a list of product offers matching a given search filter.

listProductPurchases

This function searches for a list of product purchases matching a given search filter.

listProducts

This function will list the available products

listPromoCode

This function will return list of promotion codes which meets the filter criteria.

listReferralPromoCode

This function will return list of referral promocodes which meets the filter criteria.

listResources

This Operation will return list of resources after satisfying the filter conditions

listTransactionLogs

This function searches for a list of transaction logs matching a given search filter.

listUnitTransactions

This function searches for a list of unit transactions.

listUnitTransactionSummary

This function searches for a list of unit transaction summaries matching a given search filter.

listUser

This function searches for a list of existing users.

lockUser

This function will move a user into the Locked group.

markInvoiceStatus

This function marks an existing invoice status either pending,paid,unpaid or void.

markProductPurchaseInactive

This function marks an existing product purchase as invalid.

modifyCluster

This function updates a cluster object with the supplied details.

modifyPaymentMethod

This function will modify a paymentMethod

modifyProduct

This function will modify a products description or active state. Product components cannot be updated

modifyProductOffer

This function will modify and return modified product offer.

publishImage

This function will publish an image to a customer, Billing Entity or the platform as a whole.

purchaseProduct

This function will create a new product purchase.

removeCluster

Removes the record for the specified cluster

removeKey

This Operation will remove keys from the given resource object.

removeStorageUnit

Removes the storage unit

removeUserFromCustomer

This function will remove a user from a customer.

revokeImage

This function will revoke an image from an authoritative entity ie Customer or Billing.

sendEmail

This function will send out an email dependent upon the input parameters passed.

setOSProductOffer

This function asoociates a chargeable OS product offer to an image.

unlockUser

This function will remove a user from the Locked group.

updateBillingEntity

This function updates a billing entity object with the supplied details.

updateCustomer

This function will update an existing customer using the supplied fields and return the updated customer object.

updateEmailTemplate

This function will create an email template object.

updatePaymentCardDetails

This function will modify and return updated payment card details.

updatePromotion

This function will update an existing promotion object.

updateReferralPromoCode

This function will update an existing referral promo code with the changed fields and returns the updated object.

updateReferralPromotion

This function will update an existing ReferralPromotion with the changed fields and returns the updated ReferralPromotion object.

updateUser

This function will update a user's details and returns the updated user.

validateCustomer

This function sets the validation string to a customer.