Documentation Powered by ReDoc

キャンペーン申込 API (1.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: (c) 2023 NTT Communications Corporation All Rights Reserved. Terms of Service

概要

  • 本APIでは、キャンペーン申込の参照・操作が可能です。

campaigns

キャンペーン情報取得API

キャンペーン情報を取得するAPI

query Parameters
campaignType
string

キャンペーン種別

resourceId
string

リソースID

header Parameters
X-Auth-Tokens
required
string

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

404

Not Found

get/v1/campaigns
https://api.ntt.com/sdpf-ztgict/v1/campaigns

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "campaigns":
    [
    ]
}

キャンペーン申込API

キャンペーンを申し込むAPI

header Parameters
X-Auth-Tokens
required
string

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json
campaignType
required
string
Value: "guaranteeOneRankUp"

キャンペーン種別

resourceType
required
string
Value: "guarantee"

リソース種別

resourceId
required
string Z[0-9]{9}

リソースID

campaignInfo
GuaranteeOneRankUpCampaign (object)

キャンペーン情報 内容はキャンペーン種別により異なる

Responses

200

OK

post/v1/campaigns
https://api.ntt.com/sdpf-ztgict/v1/campaigns

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "campaignType": "guaranteeOneRankUp",
  • "resourceType": "guarantee",
  • "resourceId": "Z123456789",
  • "campaignInfo":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "campaignType": "guaranteeOneRankUp",
  • "resourceType": "guarantee",
  • "resourceId": "Z123456789",
  • "startTime": "2024-10-01T00:00:00+00:00",
  • "expirationTime": "2024-12-31T23:59:59+00:00",
  • "campaignInfo":
    {
    }
}

キャンペーン廃止API

申込済みのキャンペーンを廃止API

header Parameters
X-Auth-Tokens
required
string

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json
campaignType
string
Value: "guaranteeOneRankUp"

キャンペーン種別

resourceType
string
Value: "guarantee"

リソース種別

resourceId
string Z[0-9]{9}

リソースID

Responses

204

No Content

delete/v1/campaigns
https://api.ntt.com/sdpf-ztgict/v1/campaigns

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "campaignType": "guaranteeOneRankUp",
  • "resourceType": "guarantee",
  • "resourceId": "Z123456789"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "campaignType": "guaranteeOneRankUp",
  • "resourceType": "guarantee",
  • "resourceId": "Z123456789",
  • "startTime": "2024-10-01T00:00:00+00:00",
  • "expirationTime": "2024-12-31T23:59:59+00:00",
  • "campaignInfo":
    {
    }
}