Cloud Cruiser became HPE Consumption Analytics on Nov. 1st. You'll still see the old name in places while we update this site.

 

 

Consumption Analytics Documentation

Home > Cloud Cruiser 3 > REST API reference > Customers > Get a customer by ID

Get a customer by ID

Retrieves the detailed information of the customer specified by their ID.

URL syntax

http://<ccServerURL
>/rest/v1/customers/customer/<id
>

HTTP method

GET

Request

URL path parameters (required)

id (type: int )

Request body

None

Response

Content-Type
application/xml
Response body

XML text with root element customer and the following XML schema:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.cloudcruiser.com/webservices/v1/Customer" targetNamespace="http://www.cloudcruiser.com/webservices/v1/Customer">
<xs:element name="customer" type="tns:Customer"/>
<xs:complexType name="Customer">
  <xs:sequence>
    <xs:element name="accountId" type="xs:string"/>
    <xs:element name="active" type="xs:boolean"/>
    <xs:element name="accountLevel">
      <xs:complexType>
        <xs:sequence/>
        <xs:attribute name="description" type="xs:string" use="required"/>
        <xs:attribute name="level" type="xs:short"/>
      </xs:complexType>
    </xs:element>
    <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="accountingDay" type="xs:short"/>
    <xs:element minOccurs="0" 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:sequence>
  <xs:attribute name="id" type="xs:int"/>
</xs:complexType>
</xs:schema>
JAXB type
com.cloudcruiser.server.webservices.v1.dto.customer.Customer

Example

URL
http://localhost:8080/rest/v1/customers/customer/112
Response body
<?xml version="1.0" encoding="UTF-8"?>
<customer xmlns="http://www.cloudcruiser.com/webservices/v1/Customer" id="112">
<accountId>B-AA-KKKK-11-vm000</accountId>
<active>true</active>
<accountLevel description="VM Name" level="5"/>
<ratePlan name="default" id="1"/>
<accountingDay>1</accountingDay>
<fiscalStartMonth>1</fiscalStartMonth>
<description>VM Host B-AA-KKKK-11-vm000</description>
</customer>
Java
Customer customer = customerServiceProxy.getCustomerById(112);
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
© Copyright 2018 Hewlett Packard Enterprise Development LP