Information element | Status | Description |
---|---|---|
PIN client identifier | M | Requestor identifier. |
Security credentials | M | Security credentials of the PIN client. |
PIN identifier | M | Identifier of the PIN. |
Application client identifier | M | Identifier of the application client. |
Application server identifier | M | Identifier of the application server. |
Application session identifier | M | Identifier of the application session. |
Application session descriptor | O | Descriptor of application traffic flows (e.g., IP 4 tuple). |
Target PIN client identifier (see NOTE) | O | Target PIN client identifier. |
NOTE:
Only if target PIN client is known.
|
Information element | Status | Description |
---|---|---|
Successful response (see NOTE 1) | O | Indicates that the request was successful. |
> Target PIN client identifier (see NOTE 2) | O | Target PIN client identifier. |
Failure response (see NOTE 1) | O | Indicates that the request failed. |
> Cause | O | Indicates the cause of the request failure. |
NOTE 1:
Only one of the IE must be included in the response.
NOTE 2:
Only if target PIN client is not provided in the PIN service switch request.
|
Information element | Status | Description |
---|---|---|
PIN server identifier | M | Requestor identifier. |
Security credentials | M | Security credentials of the PIN server. |
PIN identifier | M | Identifier of the PIN. |
Application client identifier | M | Identifier of the application client. |
Application server identifier (see NOTE 1) | O | Identifier of the application server. |
Application session identifier | M | Identifier of the application session. |
Application session descriptor | O | Descriptor of application traffic flows (e.g., IP 4 tuple). |
Target PIN client identifier (see NOTE 2) | M | Target PIN client identifier. |
NOTE 1:
The IE is present if the request is sent to the PIN management client.
NOTE 2:
The IE is present if the request is sent to the application server.
|
Information element | Status | Description |
---|---|---|
Successful response (see NOTE) | O | Indicates that the request was successful. |
Failure response (see NOTE) | O | Indicates that the request failed. |
> Cause | O | Indicates the cause of the request failure. |
NOTE:
Only one of the IE must be included in the response.
|
Information element | Status | Description |
---|---|---|
PINE identifier | M | Requestor identifier. |
Security credentials | M | Security credentials of the PIN management client. |
PIN identifier | M | Identifier of the PIN. |
Application client identifier | M | Identifier of the application client. |
Application server identifier | M | Identifier of the application server. |
PIN gateway client identifier (see NOTE 1) | O | Identifier of the PIN gateway client. |
Application session identifier | M | Identifier of the application session. |
Application session descriptor | O | Descriptor of application traffic flows (e.g., IP 4 tuple). |
Target PIN client identifier (see NOTE 2) | O | Target PIN client identifier. |
Service information (see NOTE 3) | O | PIN service type and PIN service feature. |
NOTE 1:
The IE is present if the request is sent to the target PIN client.
NOTE 2:
The IE is present if the request is sent to the PIN gateway client.
NOTE 3:
The IE is present if the request is sent to the PINE.
|
Information element | Status | Description |
---|---|---|
Successful response (see NOTE) | O | Indicates that the request was successful. |
Failure response (see NOTE) | O | Indicates that the request failed. |
> Cause | O | Indicates the cause of the request failure. |
NOTE:
Only one of the IE must be included in the response.
|
Information element | Status | Description |
---|---|---|
PIN ID | M | The identifier of the PIN. |
Requester PINE ID | M | The identifier of the PIN Element making the request. |
Security credentials | M | Security credentials resulting from a successful authorization for the PIN service. |
MAC address/IP address | O | MAC address/IP address of PINE/PEMC. |
Request PIN service type | M | List the PIN service type that the PINE request to determine the targe PINE for service switch. |
Information element | Status | Description |
---|---|---|
Successful response | O | Indicates that the PIN Service Discovery request was successful. |
> PINE ID(s) | M | The identifier of the PIN Elements that can provide the target PIN service. |
> MAC address(es)/IP address(es) | M | MAC address/IP address of PINEs that can provide the target PIN service. |
Failure response | O | Indicates that the PIN Service Discovery request failed. |
> Cause | M | Provides the cause for PIN Service Discovery request failure. |
Information element | Status | Description |
---|---|---|
Application server ID | M | Unique identifier of the application server. |
Security credentials | M | Security credentials resulting from a successful authorization for the PIN service. |
PIN ID | M | The identifier of PIN. |
Subscribed event | M | Identifies event type for which the subscriber is notified.
Event types:
|
Notification Target Address | M | The Notification target address (e.g., URL) where the notifications destined for the application server should be sent. |
Proposed expiration time | O | Proposed expiration time for the subscription. |
Information element | Status | Description |
---|---|---|
Successful response (see NOTE) | O | Indicates that the subscription request was successful. |
> Subscription ID | M | Subscription identifier corresponding to the subscription. |
> Expiration time | O | Indicates the expiration time of the subscription. To maintain an active subscription, a subscription update is required before the expiration time. |
Failure response (see NOTE) | O | Indicates that the subscription request failed. |
> Cause | O | Indicates the cause of subscription request failure. |
NOTE:
One IE is included in the response.
|
Information element | Status | Description |
---|---|---|
PIN subscription identifier | M | Identifier of the subscription. |
Subscribed event | M | Identifies the event type as described in Table 8.7.3.10-1 for which the notification is sent. |
PIN server identifier | M | Identifier of the PIN server sending the notification. |
PIN identifier | M | Identifier of the PIN. |
Application client identifier | M | Identifier of the application client. |
Application session identifier | M | Identifier of the application session. |
Application session descriptor | O | Descriptor of application traffic flows (e.g., IP 4 tuple). |
Target PIN client identifier | M | Target PIN client identifier. |
Information element | Status | Description |
---|---|---|
Subscription ID | M | Subscription identifier corresponding to the subscription. |
Security credentials | M | Security credentials resulting from a successful authorization for the PIN service. |
PIN ID | O | PIN identifier. |
Subscribed event | O | Identifies the event type as described in Table 8.7.3.10-1 for which the subscriber is notified. |
Notification Target Address | O | The Notification target address (e.g., URL) where the notifications destined for the application server should be sent to. |
Proposed expiration time | O | Proposed expiration time for the subscription. |
Information element | Status | Description |
---|---|---|
Successful response (see NOTE) | O | Indicates that the subscription update request was successful. |
> Expiration time | O | Indicates the expiration time of the subscription. To maintain an active subscription, a subscription update is required before the expiration time. |
Failure response (see NOTE) | O | Indicates that the subscription update request failed. |
> Cause | M | Indicates the cause of subscription update request failure. |
NOTE:
One IE is included in the response.
|
Information element | Status | Description |
---|---|---|
Subscription ID | M | Subscription identifier corresponding to the subscription. |
Security credentials | M | Security credentials resulting from a successful authorization for the PIN service. |
Information element | Status | Description |
---|---|---|
Successful response (see NOTE) | O | Indicates that the unsubscribe request was successful. |
Failure response (see NOTE) | O | Indicates that the unsubscribe request failed. |
> Cause | M | Indicates the cause of unsubscribe request failure. |
NOTE:
One IE is included in the response.
|
API Name | API Operations | Operation Semantics | Consumer(s) |
---|---|---|---|
Ppinserver_ | Subscribe | Subscribe/Notify | AS |
Notify | |||
Update | |||
Unsubscribe |