Get customers

URL query parameters (optional)

• accountId : The partial accountId that the retrieved accountIds will contain (case-insensative)
• ratePlan : The rate plan name of customer account to retrieve
• accountLevel : The account level value or description of the customer account to retrieve

Request body

None

Content-Type

application/xml

Response body

XML text with root element customers 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="customers">

  <xs:complexType>

    <xs:sequence>

      <xs:element maxOccurs="unbounded" minOccurs="0" name="customer" type="tns:CustomerSummary"/>

    </xs:sequence>

    <xs:attribute name="retrievedCount" type="xs:int"/>

  </xs:complexType>

</xs:element>

<xs:complexType name="CustomerSummary">

  <xs:all>

    <xs:element name="accountId" type="xs:string"/>

    <xs:element minOccurs="0" name="description" type="xs:string"/>

  </xs:all>

  <xs:attribute name="id" type="xs:int"/>

</xs:complexType>

</xs:schema>

JAXB type

com.cloudcruiser.server.webservices.v1.dto.customer.Customers

URL

http://localhost:8080/rest/v1/customers?accountId=B-AA&ratePlan=default&accountLevel=3

Response body

<?xml version="1.0" encoding="UTF-8"?>

<customers xmlns="http://www.cloudcruiser.com/webservices/v1/Customer" retrievedCount="6">

  <customer id="19">

    <accountId>B-AA-KKKK</accountId>

    <description>Business Unit A, Division K</description>

  </customer>

  <customer id="20">

    <accountId>B-AA-LLLL</accountId>

    <description>Business Unit A, Division L</description>

  </customer>

  <customer id="21">

    <accountId>B-AA-MMMM</accountId>

    <description>Business Unit A, Division M</description>

  </customer>

  <customer id="22">

    <accountId>B-AA-NNNN</accountId>

    <description>Business Unit A, Division N</description>

  </customer>

  <customer id="23">

    <accountId>B-AA-OOOO</accountId>

    <description>Business Unit A, Division O</description>

  </customer>

  <customer id="24">

    <accountId>B-AA-PPPP</accountId>

    <description>Business Unit A, Division P</description>

  </customer>

</customers>

Java

Customers customers = customerServiceProxy.getCustomers("B-AA", "default", "3");