![]() |
Consumption Analytics Documentation |
Retrieves summary information for the customers specified by the query parameters. If no parameters are supplied, retrieves information for all customers.
In version 4.0: GET http://<
ccServerURL>/rest/v2/customers
In version 4.1 and later: GET http://<ccServerURL>/rest/v2/customers/summaries
Name | Type | Description | |
---|---|---|---|
URL query parameters (optional) | accountId | string | The beginning portion of the account ID of the customers to retrieve, with account levels separated by the pipe character (| ). This parameter is case insensitive. |
accountLevel | string | The account structure level of the customers to retrieve. You can specify the level by name or number. | |
ratePlan | string | The name of the rate plan associated with the customers to retrieve |
None
application/xml
Summary information for the specified customers, as XML text with the root element customerSummaryList
or JAXB type com.cloudcruiser.server.webservices.v2.dto.customer.CustomerSummaryList
.
For Cloud Cruiser 4.1 and later, this XML schema describes a customer or list of customers.
<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/Customer" attributeFormDefault="unqualified"elementFormDefault="qualified" targetNamespace="http://www.cloudcruiser.com/webservices/v2/Customer"> <xs:import namespace="http://www.cloudcruiser.com/webservices/v2/Common"/> <xs:import/> <xs:element name="customer" type="tns:Customer"/> <xs:element name="customerList"> <xs:complexType> <xs:sequence> <xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:customer"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="customerSummaryList"> <xs:complexType> <xs:sequence> <xs:element maxOccurs="unbounded" minOccurs="0" name="customerSummary" type="tns:CustomerSummary"/> </xs:sequence> <xs:attribute name="totalCount" type="xs:int" use="required"/> <xs:attribute name="retrievedCount" type="xs:int" use="required"/> </xs:complexType> </xs:element> <xs:complexType name="CustomerSummary"> <xs:sequence> <xs:element name="accountId" type="xs:string"/> <xs:element minOccurs="0" name="description" type="xs:string"/> </xs:sequence> <xs:attribute name="id" type="xs:int" use="required"/> </xs:complexType> <xs:complexType name="Customer"> <xs:sequence> <xs:element name="accountId" type="xs:string"/> <xs:element name="active" type="xs:boolean"/> <xs:element default="1" name="accountingDay" type="xs:short"/> <xs:element default="1" name="fiscalStartMonth" type="xs:short"/> <xs:element minOccurs="0" name="altAccountId" type="xs:string"/> <xs:element minOccurs="0" name="description" type="xs:string"/> <xs:element minOccurs="0" name="flag1" type="xs:string"/> <xs:element minOccurs="0" name="flag2" type="xs:string"/> <xs:element minOccurs="0" name="flag3" type="xs:string"/> <xs:element minOccurs="0" name="flag4" type="xs:string"/> <xs:element minOccurs="0" name="flag5" type="xs:string"/> <xs:element name="ratePlan"> <xs:complexType> <xs:sequence/> <xs:attribute name="name" type="xs:string" use="required"/> <xs:attribute name="id" type="xs:int"/> </xs:complexType> </xs:element> <xs:element minOccurs="0" name="transactions"> <xs:complexType> <xs:sequence> <xs:element maxOccurs="unbounded" name="transaction" type="tns:Transaction"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element minOccurs="0" name="discountInstances"> <xs:complexType> <xs:sequence> <xs:element maxOccurs="unbounded" name="discountInstance" type="tns:DiscountInstance"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element minOccurs="0" name="contacts" type="tns:Contacts"/> </xs:sequence> <xs:attribute name="id" type="xs:int"/> </xs:complexType> <xs:complexType abstract="true" name="Transaction"> <xs:sequence> <xs:element name="service" type="ns1:Service"/> <xs:element default="true" name="active" type="xs:boolean"/> <xs:element minOccurs="0" name="description" type="xs:string"/> <xs:element default="MONEY_AMOUNT" name="amountType" type="xs:string"/> <xs:element name="amount" type="xs:double"/> <xs:element minOccurs="0" name="lastProcessedDate" type="ns1:Date"/> </xs:sequence> <xs:attribute name="id" type="xs:int"/> </xs:complexType> <xs:complexType name="NonRecurringTransaction"> <xs:complexContent> <xs:extension base="tns:Transaction"> <xs:sequence> <xs:element name="transactionDate" type="ns1:Date"/> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="RecurringTransaction"> <xs:complexContent> <xs:extension base="tns:Transaction"> <xs:sequence> <xs:element name="frequencyType" type="xs:string"/> <xs:element name="startDate" type="ns1:StartOfDay"/> <xs:element name="endDate" type="ns1:EndOfDay"/> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:complexType name="DiscountInstance"> <xs:sequence> <xs:element name="active" type="xs:boolean"/> <xs:element name="startDate" type="ns1:StartOfDay"/> <xs:element name="endDate" type="ns1:EndOfDay"/> <xs:element name="discount"> <xs:complexType> <xs:sequence/> <xs:attribute name="name" type="xs:string" use="required"/> <xs:attribute name="id" type="xs:int"/> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name="id" type="xs:int"/> </xs:complexType> <xs:complexType name="Contacts"> <xs:sequence> <xs:element minOccurs="0" name="description" type="xs:string"/> <xs:element maxOccurs="unbounded" minOccurs="0" name="emailContact"> <xs:complexType> <xs:sequence> <xs:element name="emailAddress" type="xs:string"/> <xs:element minOccurs="0" name="description" type="xs:string"/> <xs:element default="false" name="receiveAlerts" type="xs:boolean"/> </xs:sequence> <xs:attribute name="id" type="xs:int"/> </xs:complexType> </xs:element> <xs:element maxOccurs="unbounded" minOccurs="0" name="postalContact"> <xs:complexType> <xs:sequence> <xs:element minOccurs="0" name="description" type="xs:string"/> <xs:element name="address1" type="xs:string"/> <xs:element minOccurs="0" name="address2" type="xs:string"/> <xs:element minOccurs="0" name="address3" type="xs:string"/> <xs:element minOccurs="0" name="address4" type="xs:string"/> <xs:element minOccurs="0" name="address5" type="xs:string"/> </xs:sequence> <xs:attribute name="id" type="xs:int"/> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name="id" type="xs:int"/> </xs:complexType> </xs:schema>
GET http://localhost:8080/rest/v2/customers/summaries
GET http://localhost:8080/rest/v2/customers/summaries?accountId=B|BB
GET http://localhost:8080/rest/v2/customers/summaries?accountLevel=3
<customerSummaryList xmlns="http://www.cloudcruiser.com/webservices/v2/Customer" totalCount="45" retrievedCount="5"> <customerSummary id="90"> <accountId>B|BB</accountId> <description>Business Banking, Dept 2</description> </customerSummary> <customerSummary id="138"> <accountId>B|BB|KKKK|11</accountId> <description>Cust B-BB-KKKK-11</description> </customerSummary> <customerSummary id="141"> <accountId>B|BB|KKKK|11|vm002</accountId> <description>Cust B-BB-KKKK-11-vm002</description> </customerSummary> <customerSummary id="139"> <accountId>B|BB|LLLL|11</accountId> <description>Cust B-BB-LLLL-11</description> </customerSummary> <customerSummary id="140"> <accountId>B|BB|MMMM|11</accountId> <description>Cust B-BB-MMMM-11</description> </customerSummary> </customerSummaryList>
(c) Copyright 2017-2020 Hewlett Packard Enterprise Development LP