diff --git a/code/API_definitions/device-status.yaml b/code/API_definitions/device-status.yaml index 3071def2..77a02255 100644 --- a/code/API_definitions/device-status.yaml +++ b/code/API_definitions/device-status.yaml @@ -45,6 +45,7 @@ info: - `CONNECTED_DATA`, if device is connected to the network via data usage - `NOT_CONNECTED`, if device is not connected to the network + * **LastStatusTime** : This property specifies the time when the status was last checked. Its inclusion in the response indicates that the information may not be current, while its absence suggests that the status information is fresh. # API Functionality The API exposes following capabilities: @@ -151,12 +152,15 @@ paths: examples: Connected-With-SMS: value: + lastStatusTime: "2024-02-20T10:41:38.657Z" connectivityStatus: CONNECTED_SMS Connected-With-DATA: value: + lastStatusTime: "2024-02-20T10:41:38.657Z" connectivityStatus: CONNECTED_DATA Not-Connected: value: + lastStatusTime: "2024-02-20T10:41:38.657Z" connectivityStatus: NOT_CONNECTED "400": $ref: "#/components/responses/Generic400" @@ -201,16 +205,19 @@ paths: examples: No-Country-Name: value: + lastStatusTime: "2024-02-20T10:41:38.657Z" roaming: true countryCode: 901 countryName: [] Single-Country-Code: value: + lastStatusTime: "2024-02-20T10:41:38.657Z" roaming: true countryCode: 262 countryName: ["DE"] Multiple-Country-Codes: value: + lastStatusTime: "2024-02-20T10:41:38.657Z" roaming: true countryCode: 340 countryName: ["BL", "GF", "GP", "MF", "MQ"] @@ -469,6 +476,8 @@ components: required: - roaming properties: + lastStatusTime: + $ref: "#/components/schemas/LastStatusTime" roaming: $ref: "#/components/schemas/ActiveRoaming" countryCode: @@ -476,6 +485,12 @@ components: countryName: $ref: "#/components/schemas/CountryName" + LastStatusTime: + description: Last time that the associated device roaming status/connectivity was checked and, if necessary, updated + type: string + format: date-time + example: "2024-02-20T10:41:38.657Z" + ActiveRoaming: description: Roaming status. True, if it is roaming type: boolean @@ -485,6 +500,8 @@ components: required: - connectivityStatus properties: + lastStatusTime: + $ref: "#/components/schemas/LastStatusTime" connectivityStatus: $ref: "#/components/schemas/ConnectivityStatus" @@ -828,11 +845,11 @@ components: type: string format: date-time description: | - Timestamp of when the occurrence happened. - If the time of the occurrence cannot be determined then this attribute MAY be set to some other time (such as the current time) by the CloudEvents producer, - however all producers for the same source MUST be consistent in this respect. In other words, - either they all use the actual time of the occurrence or they all use the same algorithm to determine the value used. - It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone. + Timestamp of when the occurrence happened. + If the time of the occurrence cannot be determined then this attribute MAY be set to some other time (such as the current time) by the CloudEvents producer, + however all producers for the same source MUST be consistent in this respect. In other words, + either they all use the actual time of the occurrence or they all use the same algorithm to determine the value used. + It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z) example: "2018-04-05T17:31:00Z"