Get Proposal

Overview

Get Proposal

Classification

  • Get

API Operation Object

  • Proposal

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v1/proposal/detail/{tenant_id}/{service_id}/{OrderId}

HTTP Request Header

Format

X-Auth-Token: <token_id>
Language: <language_id>

HTTP Request Body

  • none

Request Parameter

Request Parameters
name style format description required/optional
tenant_id URL String(UUID) Tenant which the user have role. required
service_id URL int Choose ‘service_id’ below required
OrderId URL String String required
token_id Header String(token_id) - required
language_id Header int Choose ‘language_id’ below required
service_id
service_id Service Name
1 HULFT
3 SAP HANA
4 Global Server Load Balance (Global Traffic Management)
5 Power Systems
6 Arcserve
8 FastDNS
10 VMware Cloud Foundation
11 Oracle License (Physical CPU Charge)
12 Oracle License (vCPU Charge)
13 Hybrid Cloud with GCP
language_id
language_id Language
1 Japanese
2 English

Response

HTTP Response Header

Format

HTTP/1.1 <response code> <message> (ex. 200 OK)
  • <response_code>: see “HTTP Responses” section
  • <message>: message based on the response code

Response Code

Response Codes
response code condition
200 normal end
400 Bad Request
403 Unauthorized
404 not found a specified item

HTTP Response Body

Format

{
    "Proposals": {
        "OrderId": "OrderId",
        "ServiceId": 4,
        "StatusId": 1,
        "TenantId": "af08757d-318e-4769-a1da-1d917aabb901",
        "ChargeStartDate": null,
        "ChargeEndDate": null,
        "ChargeChangeDate": null,
        "ChargeExpectedDate": null,
        "DeleteDate": null,
        "ProposalDate": "2017-05-09T10:52:14.847",
        "UpdateDate": "2017-05-17T08:01:02.327",
        "ProposalXml": "{xml_data}"
    }
}

Response Parameter

Response Parameters
item format description
OrderId String ID to identify the Order unit
ServiceId int service_id
StatusId int status_id
TenantId String(UUID)) tenant_id
ChargeStartDate datetime ChargeStartDate(Only SAP HANA)
ChargeEndDate datetime ChargeEndDate(Only SAP HANA)
ChargeChangeDate datetime Internal Use
ChargeExpectedDate datetime ChargeExpectedDate(Only SAP HANA)
DeleteDate datetime DeleteOrderDate(Only SAP HANA)
ProposalDate datetime OrderDate
ProposalXml xml same with Get Proposal List API (except for ArcServe)

XML format

“\r\n” is output after each tag
same with Get Proposal List API (except for ArcServe)
  • ArcServe

Multiple setting of ArcserveModel and LicenseKey

<?xml version="1.0"?>
<ArcserveModels xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Language>{Language}</Language>
  <CustomerEMailAddress>{CustomerEMailAddress}</CustomerEMailAddress>
  <CompanyName>{CompanyName}</CompanyName>
  <ProductId>{ProductId}</ProductId>
  <ProductName>{ProductName}</ProductName>
  <ProductNameEn>{ProductNameEn}</ProductNameEn>
  <SupportDeskId>{SupportDeskId}</SupportDeskId>
  <SupportDeskName>{SupportDeskName}</SupportDeskName>
  <SupportDeskNameEn>{SupportDeskNameEn}</SupportDeskNameEn>
  <ArcserveOrderId>{ArcserveOrderId}</ArcserveOrderId>
  <Models>
    <ArcserveModel>
      <Uuid>{Uuid}</Uuid>
      <StatusId>{StatusId}</StatusId>
      <StatusName>{StatusName}</StatusName>
      <StatusNameEn>{StatusNameEn}</StatusNameEn>
      <LicenseId>{LicenseId}</LicenseId>
      <LicenseName1>{LicenseName1}</LicenseName1>
      <LicenseName1En>{LicenseName1En}</LicenseName1En>
      <LicenseName2>{LicenseName2}</LicenseName2>
      <LicenseName2En>{LicenseName2En}</LicenseName2En>
      <LicenseName3>{LicenseName3}</LicenseName3>
      <LicenseName3En>{LicenseName3En}</LicenseName3En>
      <QuantityWin>{QuantityWin}</QuantityWin>
      <QuantityLin>{QuantityLin}</QuantityLin>
      <ChargeStartDate>{ChargeStartDate}</ChargeStartDate>
      <ChargeEndDate>{ChargeEndDate}</ChargeEndDate>
      <ProposalDate>{ProposalDate}</ProposalDate>
      <DeleteDate>{DeleteDate}</DeleteDate>
      <LicenseKeys>
        <LicenseKey>
          <Key>{Key}</Key>
          <Name1>{Name1}</Name1>
          <Name1En>{Name1En}</Name1En>
          <Name2>{Name2}</Name2>
          <Name2En>{Name2En}</Name2En>
        </LicenseKey>
      </LicenseKeys>
    </ArcserveModel>
  </Models>
</ArcserveModels>
Item description
name description format
Language Corresponding language ‘ja’or’en’
CustomerEMailAddress e-mail address -
CompanyName Company Name -
ProductId ID of Product -
ProductName Name of Product -
ProductNameEn Name of Product(English) -
SupportDeskId ID of SupportDesks -
SupportDeskName Name of SupportDesks -
SupportDeskNameEn Name of SupportDesks(English) -
ArcserveOrderId ArcServe’s Order ID -
Uuid uuid to identify this item UUID
StatusId status id -
StatusName status name -
StatusNameEn status name(English) -
LicenseId ID of License -
LicenseName1 Name of License -
LicenseName1En Name of License(English) -
LicenseName2 Name of License(Usage Type) -
LicenseName2En Name of License(Usage Type)(English) -
LicenseName3 Name of License(Agent OS) -
LicenseName3En Name of License(Agent OS)(English) -
QuantityWin Total quantity of Windows OS of this License -
QuantityLin Total quantity of Linux OS of this License -
ChargeStartDate ChargeStartDate Datetime
ChargeEndDate ChargeEndDate Datetime
ProposalDate ProposalDate Datetime
DeleteDate DeleteDate Datetime
Key License Key -
Name1 Name of Product -
Name1En Name of Product(English) -
Name2 Kind of license key -
Name2En Kind of license key(English) -