Get Service Order Status¶

Overview¶

Check progress status of Host-based Security Service Order.

{endpoint}/API/ScreenEventHBSOrderProgressRate?tenant_id={tenant_id}&locale={locale}&soid={soid}

X-Auth-Token: <token_id>

Request Parameters¶
item	Required	type	format	description
tenant_id	yes	String	UUID	Tenant ID of the owner (UUID)
soId	yes	String	-	This value is returned value of when you execute API of Order Host-based Security, Change menu or quantity, or Cancel the order
locale	no	String	-	Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is "en".

This request does not include a request body.

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 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.
progressRate	String	-	Percentage of Service Order Progress Status
status	integer	-	This value indicates normal or abnormal. 1:normal, 2:abnormal

When locale is "ja"

{
    "code": "DEP-01",
    "message": "正常終了",
    "progressRate": "20",
    "status": 1
}

When locale is "en"

{
    "code": "DEP-01",
    "message": "Successful completion",
    "progressRate": "20",
    "status": 1
}

When locale is "ja"

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

When locale is "en"

{
    "code": "DEP-E",
    "message": "System error has occurred. Excuse me, please contact us at the ticket system.",
    "status": 2,
}