Kojirer State Notification Service 1.0.0 documentation

Kojirer State Notification Service 1.0.0

KojirerでDonやOrderの状態を同期するためのサービス

Servers

WebSockets://api.kojirer.arcircle.f5.si/wsWebSocketsproduction
本番環境

Operations

REQUEST order
Orderの状態についての通知をリクエストする。サーバーはリクエストを受け取ると、直ちに現在の状態を通知する。そしてリクエストがあったセッションについて、状態変化時に通知を送信する。

Operation IDrequestActiveOrderStateNotification
Available only on servers:
- production
object
method
GET
Accepts the following message:
notificationRequest
application/json
Message IDnotificationRequest
object
type
string
Allowed values:
"request"
object [Request Option]
リクエスト時に設定するオプション

include
boolean
通知内容に子オブジェクトを含むかどうか

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "request", "data": { "include": true } }

This example has been generated automatically.
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be provided via this designated address: order
Address: order
Available only on servers:
production
Messages:
#0notificationRequest
application/json
Message IDnotificationRequest
object
type
string
Allowed values:
"request"
object [Request Option]
リクエスト時に設定するオプション

include
boolean
通知内容に子オブジェクトを含むかどうか

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "request", "data": { "include": true } }

This example has been generated automatically.
#1activeOrderState
application/json
Message IDactiveOrderState
object
type
string
Allowed values:
"state"
object
array<object [Order]>
object [Order]
Orderオブジェクト

id
required
string
OrderのユニークなID

call_num
required
integer
Orderの呼び出し番号

state
required
string
Orderの現在の状態

Allowed values:
"ordered"
"ready"
"delivered"
"cancelled"
array<object [Don]>
Orderに紐づいているDonの配列通知リクエスト時に 'includes: true' オプションを付与すると含まれる

object [Don]
Donオブジェクト

id
required
string
DonのユニークなID

state
required
string
Donの現在の状態

Allowed values:
"ordered"
"cooking"
"cooked"
"delivered"
"cancelled"
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "state", "data": { "orders": [ { "id": "string", "call_num": 0, "state": "ordered", "dons": [ { "id": "string", "state": "ordered" } ] } ] } }

This example has been generated automatically.
object
method
GET

activeOrderState
application/json
Message IDactiveOrderState
object
type
string
Allowed values:
"state"
object
array<object [Order]>
object [Order]
Orderオブジェクト

id
required
string
OrderのユニークなID

call_num
required
integer
Orderの呼び出し番号

state
required
string
Orderの現在の状態

Allowed values:
"ordered"
"ready"
"delivered"
"cancelled"
array<object [Don]>
Orderに紐づいているDonの配列通知リクエスト時に 'includes: true' オプションを付与すると含まれる

object [Don]
Donオブジェクト

id
required
string
DonのユニークなID

state
required
string
Donの現在の状態

Allowed values:
"ordered"
"cooking"
"cooked"
"delivered"
"cancelled"
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "state", "data": { "orders": [ { "id": "string", "call_num": 0, "state": "ordered", "dons": [ { "id": "string", "state": "ordered" } ] } ] } }

This example has been generated automatically.
REQUEST don
Donの状態についての通知をリクエストする。サーバーはリクエストを受け取ると、直ちに現在の状態を通知する。そしてリクエストがあったセッションについて、状態変化時に通知を送信する。

Operation IDrequestActiveDonStateNotification
Available only on servers:
- production
object
method
GET
Accepts the following message:
notificationRequest
application/json
Message IDnotificationRequest
object
type
string
Allowed values:
"request"
object [Request Option]
リクエスト時に設定するオプション

include
boolean
通知内容に子オブジェクトを含むかどうか

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "request", "data": { "include": true } }

This example has been generated automatically.
REPLY INFORMATION
REPLY CHANNEL INFORMATION
Reply will be provided via this designated address: don
Address: don
Available only on servers:
production
Messages:
#0notificationRequest
application/json
Message IDnotificationRequest
object
type
string
Allowed values:
"request"
object [Request Option]
リクエスト時に設定するオプション

include
boolean
通知内容に子オブジェクトを含むかどうか

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "request", "data": { "include": true } }

This example has been generated automatically.
#1activeDonState
application/json
Message IDactiveDonState
object
type
string
Allowed values:
"state"
object
array<object [Don]>
object [Don]
Donオブジェクト

id
required
string
DonのユニークなID

state
required
string
Donの現在の状態

Allowed values:
"ordered"
"cooking"
"cooked"
"delivered"
"cancelled"
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "state", "data": { "dons": [ { "id": "string", "state": "ordered" } ] } }

This example has been generated automatically.
object
method
GET

activeDonState
application/json
Message IDactiveDonState
object
type
string
Allowed values:
"state"
object
array<object [Don]>
object [Don]
Donオブジェクト

id
required
string
DonのユニークなID

state
required
string
Donの現在の状態

Allowed values:
"ordered"
"cooking"
"cooked"
"delivered"
"cancelled"
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "state", "data": { "dons": [ { "id": "string", "state": "ordered" } ] } }

This example has been generated automatically.
RECEIVE order
Orderの状態についての通知

Operation IDnotifyActiveOrderState
Available only on servers:
- production
object
method
GET
Accepts the following message:
activeOrderState
application/json
Message IDactiveOrderState
object
type
string
Allowed values:
"state"
object
array<object [Order]>
object [Order]
Orderオブジェクト

id
required
string
OrderのユニークなID

call_num
required
integer
Orderの呼び出し番号

state
required
string
Orderの現在の状態

Allowed values:
"ordered"
"ready"
"delivered"
"cancelled"
array<object [Don]>
Orderに紐づいているDonの配列通知リクエスト時に 'includes: true' オプションを付与すると含まれる

object [Don]
Donオブジェクト

id
required
string
DonのユニークなID

state
required
string
Donの現在の状態

Allowed values:
"ordered"
"cooking"
"cooked"
"delivered"
"cancelled"
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "state", "data": { "orders": [ { "id": "string", "call_num": 0, "state": "ordered", "dons": [ { "id": "string", "state": "ordered" } ] } ] } }

This example has been generated automatically.
RECEIVE don
Donの状態についての通知

Operation IDnotifyActiveDonState
Available only on servers:
- production
object
method
GET
Accepts the following message:
activeDonState
application/json
Message IDactiveDonState
object
type
string
Allowed values:
"state"
object
array<object [Don]>
object [Don]
Donオブジェクト

id
required
string
DonのユニークなID

state
required
string
Donの現在の状態

Allowed values:
"ordered"
"cooking"
"cooked"
"delivered"
"cancelled"
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "state", "data": { "dons": [ { "id": "string", "state": "ordered" } ] } }

This example has been generated automatically.

Messages

#1requestNotification
- application/json
Message IDrequestNotification
object
type
string
Allowed values:
"request"
object [Request Option]
リクエスト時に設定するオプション

include
boolean
通知内容に子オブジェクトを含むかどうか

Additional properties are allowed.
Additional properties are allowed.
#2orderState
- application/json
Message IDorderState
object
type
string
Allowed values:
"state"
object
array<object [Order]>
object [Order]
Orderオブジェクト

id
required
string
OrderのユニークなID

call_num
required
integer
Orderの呼び出し番号

state
required
string
Orderの現在の状態

Allowed values:
"ordered"
"ready"
"delivered"
"cancelled"
array<object [Don]>
Orderに紐づいているDonの配列通知リクエスト時に 'includes: true' オプションを付与すると含まれる

object [Don]
Donオブジェクト

id
required
string
DonのユニークなID

state
required
string
Donの現在の状態

Allowed values:
"ordered"
"cooking"
"cooked"
"delivered"
"cancelled"
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#3donState
- application/json
Message IDdonState
object
type
string
Allowed values:
"state"
object
array<object [Don]>
object [Don]
Donオブジェクト

id
required
string
DonのユニークなID

state
required
string
Donの現在の状態

Allowed values:
"ordered"
"cooking"
"cooked"
"delivered"
"cancelled"
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.

Schemas

object [Request Option]
リクエスト時に設定するオプション

include
boolean
通知内容に子オブジェクトを含むかどうか

Additional properties are allowed.
object [Order]
Orderオブジェクト

id
required
string
OrderのユニークなID

call_num
required
integer
Orderの呼び出し番号

state
required
string
Orderの現在の状態

Allowed values:
"ordered"
"ready"
"delivered"
"cancelled"
array<object [Don]>
Orderに紐づいているDonの配列通知リクエスト時に 'includes: true' オプションを付与すると含まれる

object [Don]
Donオブジェクト

id
required
string
DonのユニークなID

state
required
string
Donの現在の状態

Allowed values:
"ordered"
"cooking"
"cooked"
"delivered"
"cancelled"
Additional properties are allowed.
Additional properties are allowed.
object [Don]
Donオブジェクト

id
required
string
DonのユニークなID

state
required
string
Donの現在の状態

Allowed values:
"ordered"
"cooking"
"cooked"
"delivered"
"cancelled"
Additional properties are allowed.

Kojirer State Notification Service 1.0.0

Servers

Operations

REQUEST order

Examples

This example has been generated automatically.

REPLY CHANNEL INFORMATION

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

REQUEST don

Examples

This example has been generated automatically.

REPLY CHANNEL INFORMATION

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

Examples

This example has been generated automatically.

RECEIVE order

Examples

This example has been generated automatically.

RECEIVE don

Examples

This example has been generated automatically.

Messages

Schemas