Home > Cloud Cruiser 3 > REST API reference > Rate plans > Get a rate plan by ID

Get a rate plan by ID

Retrieves a rate plan specified by its ID.

URL syntax

http://<ccServerURL>/rest/v1/ratePlans/ratePlan/<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 ratePlan and the following XML schema:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.cloudcruiser.com/webservices/v1/RatePlan" targetNamespace="http://www.cloudcruiser.com/webservices/v1/RatePlan">
<xs:element name="ratePlan" type="tns:RatePlan"/>
<xs:complexType name="RatePlan">
  <xs:all>
    <xs:element name="name" type="xs:string"/>
    <xs:element name="defaultPlan" type="xs:boolean"/>
  </xs:all>
  <xs:attribute name="id" type="xs:int"/>
</xs:complexType>
</xs:schema>
JAXB type
com.cloudcruiser.server.webservices.v1.dto.ratePlan.RatePlan

Example

URL
http://localhost:8080/rest/v1/ratePlans/ratePlan/2
Response body
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ratePlan xmlns="http://www.cloudcruiser.com/webservices/v1/RatePlan" id="2">
  <name>Customer 1</name>
  <defaultPlan>false</defaultPlan>
</ratePlan>
Java
RatePlan ratePlan = ratePlanServiceProxy.getRatePlan(2);
Last modified

Tags

This page has no custom tags.

Classifications

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