 |
Consumption Analytics Documentation |
|
Consumption Analytics Documentation |
Retrieves detailed information for a discount or surcharge specified by its ID.
GET http://<ccServerURL>/rest/v2/discounts/<userId>
| Name | Type | Description | |
|---|---|---|---|
| URL path parameters (required) | userId | integer | The ID of the discount or surcharge to retrieve. |
None
application/xml
Details for the specified discount or surcharge, as XML text with the root element discount or JAXB type com.cloudcruiser.server.webservices.v2.dto.discount.Discount.
This XML schema describes a discount or surcharge.
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns1="http://www.cloudcruiser.com/webservices/v2/Common" xmlns:tns="http://www.cloudcruiser.com/webservices/v2/Discount"attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://www.cloudcruiser.com/webservices/v2/Discount">
<xs:import/>
<xs:import namespace="http://www.cloudcruiser.com/webservices/v2/Common"/>
<xs:element name="discount" type="tns:Discount"/>
<xs:element name="discountList">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:discount"/>
</xs:sequence>
<xs:attribute name="totalCount" type="xs:int"/>
<xs:attribute name="retrievedCount" type="xs:int"/>
</xs:complexType>
</xs:element>
<xs:complexType name="Discount">
<xs:sequence>
<xs:element name="name" type="xs:string"/>
<xs:element minOccurs="0" name="description" type="xs:string"/>
<xs:element default="DISCOUNT" name="type" type="xs:string"/>
<xs:element default="PERCENTAGE" name="unitsType" type="xs:string"/>
<xs:element name="value" type="xs:double"/>
<xs:element default="true" name="allServices" type="xs:boolean"/>
<xs:element minOccurs="0" name="appliedServices">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="service" type="ns1:Service"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="id" type="xs:int"/>
</xs:complexType>
</xs:schema>
GET http://localhost:8080/rest/v2/discounts/10001
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<discount xmlns="http://www.cloudcruiser.com/webservices/v2/Discount" id="10001">
<name>Extended_Discount</name>
<description>A 7% discount for all services</description>
<type>DISCOUNT</type>
<unitsType>PERCENTAGE</unitsType>
<value>7.0</value>
<allServices>true</allServices>
</discount>