5.7 DeviceTriggering API
29.1223GPPRelease 18T8 reference point for Northbound APIsTS
5.7.1 Overview
The DeviceTriggering API is a RESTful API that allows the SCS/AS to deliver specific device trigger to the SCEF; it allows the SCS/AS to replace or recall the pending device trigger via the SCEF. If the corresponding device trigger delivery report is received by the SCEF, it also allows the SCEF to indicate the trigger delivery result to the SCS/AS.
The DeviceTriggering API defines a set of data models, resources and the related procedure for the creation and management of the device triggering. The corresponding JSON schema for the representation of the resources and operations defined by the DeviceTriggering API is provided in its complete form in Annex A.7.
5.7.2 Data model
5.7.2.1 Resource data types
5.7.2.1.1 Introduction
This clause defines data structures to be used in resource representations, including subscription resources.
Table 5.7.2.1.1-1 specifies data types re-used by the DeviceTriggering API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the DeviceTriggering API.
Table 5.7.2.1.1-1: DeviceTriggering API re-used Data Types
Data type |
Reference |
Comments |
SupportedFeatures |
3GPP TS 29.571 [45] |
Used to negotiate the applicability of the optional features defined in table 5.7.4-1. |
Table 5.7.2.1.1-2 specifies the data types defined for the DeviceTriggering API.
Table 5.7.2.1.1-2: DeviceTriggering API specific Data Types
Data type |
Clause defined |
Description |
Applicability |
DeliveryResult |
5.7.2.2.3 |
Represents the result of the delivery of a device triggering request. |
|
DeviceTriggering |
5.7.2.1.2 |
Represents device triggering related information. |
|
DeviceTriggeringDeliveryReportNotification |
5.7.2.1.3 |
Represents a device triggering delivery report notification. |
|
DeviceTriggeringPatch |
5.7.2.1.4 |
Represents the parameters to request the modification of an Individual Device Triggering Transaction resource. |
PatchUpdate |
Priority |
5.7.2.2.4 |
Represents the priority indication for a trigger payload. |
5.7.2.1.2 Type: DeviceTriggering
This type represents device triggering request. The same structure is used in the request and response.
Table 5.7.2.1.2-1: Definition of type DeviceTriggering
Attribute name |
Data type |
Cardinality |
Description |
Applicability (NOTE) |
self |
Link |
0..1 |
Link to the resource "Individual Device Triggering Transaction". This parameter shall be supplied by the SCEF in HTTP responses. |
|
externalId |
ExternalId |
0..1 |
Uniquely identifies a user as defined in Clause 4.6.2 of 3GPP TS 23.682 [2]. (NOTE 2) |
|
msisdn |
Msisdn |
0..1 |
Identifies the MS internal PSTN/ISDN number allocated for a UE. (NOTE 2) |
|
supportedFeatures |
SupportedFeatures |
0..1 |
Used to negotiate the supported optional features of the API as described in clause 5.2.7. This attribute shall be provided in the POST request and in the response of successful resource creation. |
|
validityPeriod |
DurationSec |
1 |
The validity time in seconds for the specific action requested. |
|
priority |
Priority |
1 |
Identifies the priority of the device trigger. |
|
applicationPortId |
Port |
1 |
This is used to uniquely identify the triggering application addressed in the device for destination port. See clause 9.2.3.24.4 in 3GPP TS 23.040 [43] for further details. |
|
appSrcPortId |
Port |
0..1 |
This is used to uniquely identify the triggering application addressed in the device for originator port. See clause 9.2.3.24.4 in 3GPP TS 23.040 [43] for further details. |
|
triggerPayload |
Bytes |
1 |
The device triggering payload. |
|
notificationDestination |
Link |
1 |
A URI indicating the notification destination for T8 notifications. |
|
requestTestNotification |
boolean |
0..1 |
Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise. |
Notification_test_event |
websockNotifConfig |
WebsockNotifConfig |
0..1 |
Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 5.2.5.4. |
Notification_websocket |
deliveryResult |
DeliveryResult |
0..1 |
The delivery result shall be included in the HTTP responses that indicate the delivery status of the device triggering. |
|
NOTE 1: Properties marked with a feature as defined in clause 5.7.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. NOTE 2: One of the properties "externalId" or "msisdn" shall be included. |
5.7.2.1.3 Type: DeviceTriggeringDeliveryReportNotification
This type represents device triggering delivery report notification.
Table 5.7.2.1.4-1: Definition of type DeviceTriggeringDeliveryReportNotification
Attribute name |
Data type |
Cardinality |
Description |
Applicability (NOTE) |
transaction |
Link |
1 |
Link to the related device triggering transaction resource to which this notification is related. |
|
Result |
DeliveryResult |
1 |
OK, unknown or diverse failures |
|
NOTE: Properties marked with a feature as defined in clause 5.3.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. |
5.7.2.1.4 Type: DeviceTriggeringPatch
This type represents the parameters to request the modification of an Individual Device Triggering Transaction resource.
Table 5.7.2.1.4-1: Definition of type DeviceTriggeringPatch
Attribute name |
Data type |
Cardinality |
Description |
Applicability (NOTE 1) |
validityPeriod |
DurationSec |
1 |
The validity time in seconds for the specific action requested. |
|
priority |
Priority |
1 |
Identifies the priority of the device triggering request. |
|
applicationPortId |
Port |
1 |
This is used to uniquely identify the triggering application addressed in the device for the destination port. See clause 9.2.3.24.4 in 3GPP TS 23.040 [43] for further details. |
|
appSrcPortId |
Port |
0..1 |
This is used to uniquely identify the triggering application addressed in the device for the originator port. See clause 9.2.3.24.4 in 3GPP TS 23.040 [43] for further details. |
|
triggerPayload |
Bytes |
1 |
The modified device triggering payload. |
|
notificationDestination |
Link |
1 |
A URI indicating the notification destination for T8 notifications. |
|
NOTE 1: Properties marked with a feature as defined in clause 5.7.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. |
5.7.2.2 Referenced simple data types and enumerations
5.7.2.2.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses. In addition, data types and enumerations defined in clause 5.2.1 can be referenced.
5.7.2.2.2 Simple data types
The simple data types defined in table 5.7.2.2.2-1 shall be supported.
Table 5.7.2.2.2-1: Simple data types
Type name |
Description |
5.7.2.2.3 Enumeration: DeliveryResult
The enumeration DeliveryResult represents the result of the delivery of a device triggering request
Table 5.7.2.2.3-1: Enumeration DeliveryResult
Enumeration value |
Description |
Applicability (NOTE) |
SUCCESS |
The SCEF includes this value in a device triggering notification. The value indicates that the device action request was successfully completed. |
|
UNKNOWN |
The SCEF includes this value in a device triggering notification. The value indicates any unspecified errors. |
|
FAILURE |
The SCEF includes this value in a device triggering notification. The value indicates that this trigger encountered a delivery error and is deemed permanently undeliverable. |
|
TRIGGERED |
The SCEF includes this value in the response for a successful device triggering request. The value indicates that device triggering request is accepted by the SCEF. |
|
EXPIRED |
The SCEF includes this value in a device triggering notification. The value indicates that the validity period expired before the trigger could be delivered. |
|
UNCONFIRMED |
The SCEF includes this value in a device triggering notification. The value indicates that the delivery of the device action request is not confirmed. |
|
REPLACED |
The SCEF includes this value in the response for a successful device triggering replacement request. The value indicates that the device triggering replacement request is accepted by the SCEF. |
|
TERMINATE |
The SCEF includes this value in the response for a successful device triggering cancellation request. The value indicates that the delivery of the device action request is terminated by the SCS/AS. |
|
NOTE: Properties marked with a feature as defined in clause 5.7.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. |
5.7.2.2.4 Enumeration: Priority
The enumeration Priority represents the priority indication for a trigger payload.
Table 5.7.2.2.4-1: Enumeration Priority
Enumeration value |
Description |
Applicability (NOTE) |
NO_PRIORITY |
This value indicates that the device trigger has no priority. |
|
PRIORITY |
This value indicates that the device trigger has priority. |
|
NOTE: Properties marked with a feature as defined in clause 5.7.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. |
5.7.3 Resource structure
5.7.3.1 General
All resource URIs of this API should have the following root:
{apiRoot}/3gpp-device-triggering/v1
"apiRoot" is set as described in clause 5.2.4. All resource URIs in the clauses below are defined relative to the above root URI.
The following resources and HTTP methods are supported for this API:
Table 5.7.3.1-1: Resources and methods overview
Resource name |
Resource URI |
HTTP method |
HTTP initiator |
Meaning |
Device Triggering Transactions |
/{scsAsId}/transactions |
GET |
SCS/AS |
Read all active device triggering transaction resources for a given SCS/AS |
POST |
SCS/AS |
Create a new device triggering transaction resource |
||
Individual Device Triggering Transaction |
/{scsAsId}/transactions/{transactionId} |
PUT |
SCS/AS |
Replace an existing Individual Device Triggering Transaction resource and the corresponding device triggering request |
PATCH |
SCS/AS |
Modify an existing Individual Device Triggering Transaction resource and the corresponding device triggering request. |
||
GET |
SCS/AS |
Read a device triggering transaction resource |
||
DELETE |
SCS/AS |
Delete an existing device triggering transaction resource and cancel the device triggering |
5.7.3.2 Resource: Device Triggering Transactions
5.7.3.2.1 Introduction
This resource allows the SCS/AS to read all active resources related to device triggering, and create a resource for a device triggering transaction with the SCEF.
5.7.3.2.2 Resource definition
Resource URI: {apiRoot}/3gpp-device-triggering/v1/{scsAsId}/transactions
This resource shall support the resource URI variables defined in table 5.7.3.2.2-1.
Table 5.7.3.2.2-1: Resource URI variables for resource "Device Triggering Transactions"
Name |
Data type |
Definition |
apiRoot |
string |
See clause 5.2.4. |
scsAsId |
string |
Identifier of the SCS/AS. |
5.7.3.2.3 Resource methods
5.7.3.2.3.1 GET
The GET method allows to read all active device triggering transactions for a given SCS/AS. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message.
This method shall support the URI query parameters, request and response data structures, and response codes, as specified in table 5.7.3.2.3.1-1 and table 5.7.3.2.3.1-2.
Table 5.7.3.2.3.1-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
Cardinality |
Remarks |
none specified |
Table 5.7.3.2.3.1-2: Data structures supported by the GET request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
none |
||||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
array(DeviceTriggering) |
0..N |
200 OK |
The device triggering transactions information for the SCS/AS in the request URI are returned. |
|
none |
307 Temporary Redirect |
Temporary redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
none |
308 Permanent Redirect |
Permanent redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. |
Table 5.7.3.2.3.1-3: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
Table 5.7.3.2.3.1-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
5.7.3.2.3.2 PUT
This HTTP method is not supported for the resource.
5.7.3.2.3.3 PATCH
This HTTP method is not supported for the resource.
5.7.3.2.3.4 POST
To create a long-term transaction for a device triggering, the SCS/AS shall use the HTTP POST method on the "transactions" collection resource as follows:
– the body of the message is encoded in JSON format with the data structure defined in table 5.7.2.1.2-1.
The possible response messages from the SCEF, depending on whether the POST request is successful or unsuccessful, are shown in Table 5.7.3.2.3.4-1.
Table 5.7.3.2.3.4-1: Data structures supported by the POST request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
DeviceTriggering |
1 |
Parameters to request a device triggering delivery. |
||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
DeviceTriggering |
1 |
201 Created |
The long term transaction for the device triggering was created successfully. The SCEF shall return a data structure of type "DeviceTriggering" in the response payload body. The URI of the created resource shall be returned in the "Location" HTTP header |
|
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. |
Table 5.7.3.2.3.4-2: Headers supported by the 201 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/3gpp-device-triggering/v1/{scsAsId}/transactions/{transactionId} |
5.7.3.2.3.5 DELETE
This HTTP method is not supported for the resource.
5.7.3.3 Resource: Individual Device Triggering Transaction
5.7.3.3.1 Introduction
This resource allows the SCS/AS to operate a specific pending device triggering by using a long-term transaction.
5.7.3.3.2 Resource definition
Resource URI: {apiRoot}/3gpp-device-triggering/v1/{scsAsId}/transactions/{transactionId}
This resource shall support the resource URI variables defined in table 5.7.3.3.2-1.
Table 5.7.3.3.2-1: Resource URI variables for resource "Individual Device Triggering Transaction"
Name |
Data type |
Definition |
apiRoot |
string |
See clause 5.2.4. |
scsAsId |
string |
Identifier of the SCS/AS. |
transactionId |
string |
Identifier of the transaction resource. The transactionId corresponds to the stage 2 TLTRI. |
5.7.3.3.3 Resource methods
5.7.3.3.3.1 GET
The GET method allows to read an individual device triggering transaction resource to obtain details of an active transaction. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message.
This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.7.3.3.3.1-1 and table 5.7.3.3.3.1-2.
Table 5.7.3.3.3.1-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
Cardinality |
Remarks |
none specified |
Table 5.7.3.3.3.1-2: Data structures supported by the GET request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
none |
||||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
DeviceTriggering |
1 |
200 OK |
The device triggering transaction information related to the request URI is returned. |
|
none |
307 Temporary Redirect |
Temporary redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
none |
308 Permanent Redirect |
Permanent redirection, during transaction retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. |
Table 5.7.3.3.3.1-3: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
Table 5.7.3.3.3.1-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
5.7.3.3.3.2 PUT
A pending device triggering delivery can be replaced by the SCS/AS. To replace the pending device triggering, the SCS/AS shall use the HTTP PUT method on the "transaction" instance resource as follows with the body of the message encoded in JSON format including the data structure defined in table 5.7.2.1.2-1
The properties "msisdn" or "externalId" shall remain unchanged from previously provided value.
The possible response messages from the SCEF, depending on whether the PUT request is successful or unsuccessful, are shown in Table 5.7.3.3.3.2-1.
Table 5.7.3.3.3.2-1: Data structures supported by the PUT request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
DeviceTriggering |
1 |
Parameters to replace a device triggering with the SCEF. |
||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
DeviceTriggering |
1 |
200 OK |
The device triggering was replaced successfully. The SCEF shall return an updated representation of the resource within the DeviceTriggering data structure includingthe "deliveryResult" attribute in the response message body. |
|
none |
204 No Content |
The device triggering was updated successfully. |
||
none |
307 Temporary Redirect |
Temporary redirection, during transaction modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
none |
308 Permanent Redirect |
Permanent redirection, during transaction modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. |
Table 5.7.3.3.3.2-2: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
Table 5.7.3.3.3.2-3: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
5.7.3.3.3.3 PATCH
A pending device triggering delivery can be modified by the SCS/AS. If the "PatchUpdate" feature defined in clause 5.7.4 is supported, to partially modify a pending device triggering, delivery, the SCS/AS shall use the HTTP PATCH method on the concerned Individual Device Triggering Transaction resource as follows with the body of the message is encoded in JSON format including the data structure defined in table 5.7.2.1.4-1
The possible response messages from the SCEF, depending on whether the PATCH request is successful or unsuccessful, are shown in Table 5.7.3.3.3.3-1.
Table 5.7.3.3.3.3-1: Data structures supported by the PATCH request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
DeviceTriggeringPatch |
1 |
Parameters to request the modification of a pending device triggering delivery. |
||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
DeviceTriggering |
1 |
200 OK |
The Individual Device Triggering Transaction resource was successfully modified and a representation of the modified Individual Device Triggering Transaction resource within the DeviceTriggering data structure including the "deliveryResult" attribute is returned by the SCEF in the response message body. |
|
n/a |
204 No Content |
The Individual Device Triggering Transaction resource was successfully modified no content is to be sent in the response message body. |
||
n/a |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
n/a |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply. |
Table 5.7.3.3.3.3-2: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
Table 5.7.3.3.3.3-3: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
5.7.3.3.3.4 POST
This HTTP method is not supported for the resource.
5.7.3.3.3.5 DELETE
To cancel an ongoing device triggering delivery, the SCS/AS shall use the HTTP DELETE method on the individual "transaction" resource which is indicated by the URI in the Location header of the HTTP POST response:
The possible response messages from the SCEF, depending on whether the DELETE request is successful or unsuccessful, are shown in Table 5.7.3.3.3.5-1.
Table 5.7.3.3.3.5-1: Data structures supported by the DELETE request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
none |
. |
|||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
DeviceTriggering |
1 |
200 OK |
The Device Triggering delivery was cancelled successfully. The SCEF shall return a data structure of type "DeviceTriggering" with a "TERMINATE" status in the response body. |
|
None |
204 No Content |
The Device Triggering was cancelled successfully. The SCEF shall not return a response payload. |
||
none |
307 Temporary Redirect |
Temporary redirection, during transaction termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
none |
308 Permanent Redirect |
Permanent redirection, during transaction termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. |
Table 5.7.3.3.3.5-2: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
Table 5.7.3.3.3.5-3: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located in an alternative SCEF. |
5.7.3.4 Void
5.7.3A Notifications
5.7.3A.1 General
The notifications provided by the DeviceTriggering API are specified in this clause.
Table 5.7.3A-1: Notifications overview
Notification |
Callback URI |
HTTP method or custom operation |
Description (service operation) |
Device Triggering Delivery Report Notification |
{notification_uri} |
POST |
Report a device triggering delivery report to SCS/AS. |
5.7.3A.2 Device Triggering Delivery Report Notification
5.7.3A.2.1 Description
The Device Triggering Delivery Report Notification allows the SCEF to send notifications about device triggering delivery report events to the SCS/AS.
5.7.3A.2.2 Target URI
The Callback URI "{notification_uri}" shall be used with the callback URI variables defined in table 5.7.3A.2.2-1.
Table 5.7.3A.2.2-1: Callback URI variables
Name |
Data type |
Definition |
notification_uri |
Link |
A URI indicating the notification destination URI where T8 notification requests shall be delivered. This URI shall be provided within the "notificationDestination" attribute in the DeviceTriggering type. |
5.7.3A.2.3 Standard Methods
5.7.3A.2.3.1 Notification via POST
To report the delivery status of the device trigging delivery, the SCEF shall use the HTTP POST method on the notification endpoint as follows:
– the body of the message is encoded in JSON format with the data structure defined in table 5.7.2.1.4-1.
This method shall support the request data structures specified in table 5.7.3A.2.3.1-1 and the response data structures and response codes specified in table 5.7.3A.2.3.1-2.
Table 5.7.3A.2.3.1-1: Data structures supported by the POST Request Body
Data type |
Cardinality |
Description |
DeviceTriggeringDeliveryReportNotification |
1 |
The Device Triggering delivery report. |
Table 5.7.3A.2.3.1-2: Data structures supported by the POST Response Body
Data type |
Cardinality |
Response codes |
Description |
Acknowledgement |
1 |
200 OK |
The successful acknowledgement of the notification. |
(None) |
204 No Content |
The successful acknowledgement of the notification without a body. |
|
none |
307 Temporary Redirect |
Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent. Redirection handling is described in clause 5.2.10. |
|
none |
308 Permanent Redirect |
Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent. Redirection handling is described in clause 5.2.10. |
|
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. |
Table 5.7.3A.2.3.1-3: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. |
Table 5.7.3A.2.3.1-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. |
5.7.3a.2.3.2 Notification via Websocket
If supported by both SCS/AS and SCEF and successfully negotiated, the DeviceTriggeringDeliveryReportNotification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4.
5.7.4 Used Features
The table below defines the features applicable to the DeviceTriggering API. Those features are negotiated as described in clause 5.2.7.
Table 5.7.4-1: Features used by DeviceTriggering API
Feature Number |
Feature |
Description |
1 |
Notification_websocket |
The delivery of notifications over Websocket is supported according to clause 5.2.5.4. This feature requires that the Notification_test_event featute is also supported. |
2 |
Notification_test_event |
The testing of notification connection is supported according to clause 5.2.5.3. |
3 |
PatchUpdate |
Indicates the support of enhancements to the northbound interfaces (e.g. support the partial modification of an existing subscription resource). |
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification". Description: A clear textual description of the feature. |
5.7.5 Error handling
5.7.5.1 General
HTTP error handling shall be supported as specified in clause 5.2.6.
In addition, the requirements in the following clauses shall apply.
5.7.5.2 Protocol Errors
In this Release of the specification, there are no additional protocol errors applicable for the DeviceTriggering API.
5.7.5.3 Application Errors
The application errors defined for DeviceTriggering API are listed in table 5.7.5.3-1.
Table 5.7.5.3-1: Application errors
Application Error |
HTTP status code |
Description |
Applicability |