Get Proposal List

Overview

Get Proposal List

Classification

  • Get

API Operation Object

  • Proposal

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v1/proposal/list/{tenant_id}/{service_id}

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
token_id Header String (token_id) - required
language_id Header int Choose 'language_id' below required
service_id
service_id Service Name
1 HULFT
5 Power Systems
6 Arcserve UDP
8 FastDNS
13 Hybrid Cloud with GCP
16 Hybrid Cloud with AWS
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 Success
400 Bad Request
403 Forbidden
404 Not Found

HTTP Response Body

Format

{
    "Proposalses": [
        {
            "OrderId": "OrderId",
            "ServiceId": 4,
            "StatusId": 1,
            "TenantId": "bca6c342-0e24-4cb0-8d6c-a2091a190972",
            "ChargeChangeDate": null,
            "ProposalDate": "2017-05-01T10:52:14.847",
            "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
ChargeChangeDate datetime Internal Use
ProposalDate datetime OrderDate
ProposalXml xml 'XML format' below

XML format

"\r\n" is output after each tag

  • HULFT

Multiple setting of HulftModel

<?xml version="1.0"?>
<HulftModels xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderId>{OrderId}</OrderId>
  <CustomerEMailAddress>{e-mail address}</CustomerEMailAddress>
  <Language>{language(ja/en)}</Language>
  <Models>
    <HulftModel>
      <Uuid>{Uuid}</Uuid>
      <Serial>{Serial}</Serial>
      <Dc>{Dc}</Dc>
      <Product>{Product name}</Product>
      <Cluster>{Cluster}</Cluster>
      <Aes>{Aes}</Aes>
      <Script>{Script}</Script>
      <LicensePack>{LicensePack}</LicensePack>
      <Name>{Name}</Name>
      <RowNumber>{RowNumber}</RowNumber>
      <ParentSerial>{ParentSerial}</ParentSerial>
      <Number>{Number}</Number>
      <ProposalDate>{ProposalDate}</ProposalDate>
      <DeleteDate>{DeleteDate}</DeleteDate>
      <ChargeStartDate>{ChargeStartDate}</ChargeStartDate>
      <ChargeEndDate>{ChargeEndDate}</ChargeEndDate>
      <Status>{Status}</Status>
      <StatusName>{StatusName}</StatusName>
      <OriginalAuthId>{AuthId}</OriginalAuthId>
      <OriginalSpCode>{SpCode}</OriginalSpCode>
    </HulftModel>
  </Models>
</HulftModels>
Item description
name description format
OrderId OrderId to identify this proposal -
CustomerEMailAddress e-mail address -
Language Corresponding language 'ja'or'en'
Uuid uuid to identify this item UUID
Serial Serial no -
Dc Region name -
Product Product name -
Cluster Existence of cluster -
Aes Existence of AES -
Script Existence of Script -
LicensePack License Pack -
Name Item name -
RowNumber number to identify this row number
ParentSerial Parent SerialNo -
Number number of add plans number
ProposalDate ProposalDate Datetime
DeleteDate DeleteDate Datetime
ChargeStartDate ChargeStartDate Datetime
ChargeEndDate ChargeEndDate Datetime
Status status id number
StatusName status name -
OriginalAuthId AuthId -
OriginalSpCode SpCode -
  • Power Systems / FastDNS

Multiple setting of GenericModel

<?xml version="1.0"?>
<GenericModels xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderId>{OrderId}</OrderId>
  <CustomerEMailAddress>{CustomerEMailAddress}</CustomerEMailAddress>
  <Language>{Language}</Language>
  <Models>
    <GenericModel>
      <Uuid>{Uuid}</Uuid>
      <Id>{Id}</Id>
      <Name>2FQDN Plan</Name>
      <RowNumber>{RowNumber}</RowNumber>
      <Number>{Number}</Number>
      <ProposalDate>{ProposalDate}</ProposalDate>
      <DeleteDate>{DeleteDate}</DeleteDate>
      <ChargeStartDate>{ChargeStartDate}</ChargeStartDate>
      <ChargeEndDate>{ChargeEndDate}</ChargeEndDate>
      <Status>{Status}</Status>
      <StatusName>{StatusName}</StatusName>
    </GenericModel>
  </Models>
</GenericModels>
Item description
name description format
OrderId OrderId to identify this proposal (reqired when update) -
CustomerEMailAddress e-mail address -
Language Corresponding language 'ja'or'en'
Uuid uuid to identify this item UUID
Id ID of Plans. Choose 'Id' below  
Name Plan name -
RowNumber number to identify this row (from 1 to ...) number
Number number of add plans number
ProposalDate ProposalDate Datetime
DeleteDate DeleteDate Datetime
ChargeStartDate ChargeStartDate Datetime
ChargeEndDate ChargeEndDate Datetime
Status status id -
StatusName status name -
  • Arcserve UDP

Multiple setting of ArcserveModel

<?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>
    </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
1.1. Proposal Management
Get Proposal