Parameter |
Mandatory/Optional |
Type |
Description |
|---|---|---|---|
state |
Optional |
String |
Status of the pass. Values: active, inactive, completed, and expired. |
effectTime |
Optional |
String |
UTC time when the pass takes effect. |
expireTime |
Optional |
String |
UTC time when the pass expires. The pass will automatically expire if the set expiration time is earlier than the current time. |
If state is not specified, a pass is active by default. effectTime and expireTime should be both set or not set. expireTime must be later than effectTime. To add an instance, the value of state cannot be expired.
Example
{
"status": {
"state": "active",
"effectTime": "2019-11-13T00:00:00.111Z",
"expireTime": "2019-11-20T00:00:00.111Z"
}
}