Get Order Information


Overview

Get Order Information that tied to tenant id.


API Operation Object

  • Host-based Security

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/API/ScreenEventHBSOrderInfoGet?tenant_id={tenant_id}&locale={locale}

HTTP Request Header

X-Auth-Token: <token_id>

Request Parameter

Request Parameters
item Required type format description
tenant_id yes String UUID Tenant ID of the owner (UUID)
locale no String - Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is "en".

Sample Request Body

This request does not include a request body.


Response

HTTP Response Code

Response Codes
Response Code Description
200 OK
400 Request format is invalid
401 Unauthorized
500 Internal Server Error
511 Internal Server Error (Fail Service Order etc.)

Response Parameter

Response Parameters
item type format description
code String - This code is for determining the details of the error.DEP-**: Successful Completion DEP-E**: Error has occurred
message String - This message is shown when error has occurred.
region String - Region tenant you specified belongs to.
tenant_name String - Tenant Name
tenant_description String - Description for this tenant
contract_id String - Contract ID which this tenant belongs to
service_order_service String - In-use menu.
max_agent_value string - Maximum usage of Agent
time_zone string - Time zone
customer_name String - Customer Name
mailaddress String - Contact e-mail address
dsm_lang String - Language of Deep Security Manager
tenant_flg boolean - Internal Use. (true: Already applied, false: Not applied.)
status integer - This value indicates normal or abnormal. 1:normal, 2:abnormal

Sample Response Body

Normal Response

When locale is "ja"

{
    "status": 1,
    "message": "正常終了",
    "code": "DEP-01",
    "region": "jp1",
    "tenant_name": "SOTestTenant",
    "tenant_description": "SOTest用テナント",
    "contract_id": "econ0000002279",
    "service_order_service": "Managed Anti-Virus",
    "max_agent_value": "1",
    "time_zone": "Etc/GMT",
    "mailaddress": "test@rfg.co.jp",
    "dsm_lang": "ja",
    "tenant_flg": true,
}

When locale is "en"
{
    "status": 1,
    "message": "Successful completion",
    "code": "DEP-01",
    "region": "jp1",
    "tenant_name": "SOTestTenant",
    "tenant_description": "SOTest用テナント",
    "contract_id": "econ0000002279",
    "service_order_service": "Managed Anti-Virus",
    "max_agent_value": "1",
    "time_zone": "Etc/GMT",
    "mailaddress": "test@rfg.co.jp",
    "dsm_lang": "ja",
    "tenant_flg": true,
}

Error Response

When locale is "ja"

{
    "code": "DEP-E",
    "message": "システムエラーが発生しました。恐れ入りますが、チケットシステムでご連絡ください。",
    "records": 0,
    "rows": [],
    "status": 2
}

When locale is "en"
{
    "code": "DEP-E",
    "message": "System error has occurred. Excuse me, please contact us at the ticket system.",
    "records": 0,
    "rows": [],
    "status": 2
}