Package com.oracle.communications.brm.cc.ws.deposit

Class CustomerDepositResource

java.lang.Object

com.oracle.communications.brm.cc.ws.deposit.CustomerDepositResource

@Path("/depositManagement/customerDeposit/")
public class CustomerDepositResource
extends Object

This class is the main controller for Customer Deposit API.

Constructor Summary

Constructors

Constructor	Description
CustomerDepositResource()

Method Summary

Modifier and Type	Method	Description
DepositAOC	adviceChargeCustomerDeposit(DepositAOC depositAOC)	Creates new DepositAOC
Response	createCustomerDepositByOrder(DepositOrder depositOrder)	Creates new deposit specification
Response	getCustomerDepositById(String id)	Retrieves details for the customer deposit identified by the specified ID
List<CustomerDeposit>	getCustomerDepositByQP(String serviceRef, String customerRef, String limit, String billProfileRef)	* Retrieves details for the customer deposit identified name or serviceRef or customerRef or billProfileRef
Response	updateCustomerDepositById(DepositOrder depositOrder, String id)	Updates an existing DepositOrder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CustomerDepositResource

public CustomerDepositResource()

Method Details

getCustomerDepositById

@GET
@Path("/{id}")
@Produces({"application/json","application/xml"})
public Response getCustomerDepositById(@PathParam("id")
 String id)

Retrieves details for the customer deposit identified by the specified ID

Parameters:

id - Customer Deposit ID example: 0.0.0.1+-purchased_deposit+1234567

Returns:

payload represented by the CustomerDeposit schema

getCustomerDepositByQP

@GET
@Produces({"application/json","application/xml"})
public List<CustomerDeposit> getCustomerDepositByQP(@QueryParam("serviceRef")
 String serviceRef,
 @QueryParam("customerRef")
 String customerRef,
 @QueryParam("limit")
 String limit,
 @QueryParam("billProfileRef")
 String billProfileRef)

* Retrieves details for the customer deposit identified name or serviceRef or customerRef or billProfileRef

Parameters:

serviceRef - example: 0.0.0.1+-service+123123

customerRef - example: 0.0.0.1+-account+123123

limit - example: 10

billProfileRef - example: 0.0.0.1+-billInfo+123123

Returns:

payload represented by the CustomerDeposit schema

createCustomerDepositByOrder

@POST
@Path("/order")
@Produces({"application/json","application/xml"})
@Consumes({"application/json","application/xml"})
public Response createCustomerDepositByOrder(DepositOrder depositOrder)

Creates new deposit specification

Parameters:

depositOrder - payload representing DepositOrder schema

Returns:

HTTP status CREATED (201) and a response object which contains an Id of newly created DepositOrder is returned on success;exception will be raised on failure.

updateCustomerDepositById

@PATCH
@Path("/{id}")
@Consumes({"application/json","application/xml"})
@Produces({"application/json","application/xml"})
public Response updateCustomerDepositById(DepositOrder depositOrder,
 @PathParam("id")
 String id)

Updates an existing DepositOrder

Parameters:

depositOrder - payload representing DepositOrder schema

id -

Returns:

HTTP status CREATED (201) and a response object which contains an Id of updated DepositOrder is returned on success;exception will be raised on failure.

adviceChargeCustomerDeposit

@POST
@Path("/chargeofadvice")
@Produces({"application/json","application/xml"})
@Consumes({"application/json","application/xml"})
public DepositAOC adviceChargeCustomerDeposit(DepositAOC depositAOC)

Creates new DepositAOC

Parameters:

depositAOC - payload representing DepositAOC schema

Returns:

HTTP status CREATED (200) and a response object which contains an Id of newly created DepositAOC is returned on success;exception will be raised on failure.