PayloadID

Location /api/apps/{appID}/users/{accountType}:{address}/payloads/{payloadID}
This resource represent the ID of payload generated. With this payloadID you can retrieve the information of APNS push message greater than 2048 bytes.

Request Headers (Applies to all methods)

Authorization
header
Required: Yes

GET

/api/apps/{appID}/users/{accountType}:{address}/payloads/{payloadID}

Description

Retrieval all the information of push message

Security

Can be accessed with administrator credentials or user credentials with the same UserID.

Headers
Name Required? type Description
Authorization Yes string Authorization header. OAuth2 Bearer token
Responses
200

Content-Type (None)

The message retrieved
404

Content-Type application/vnd.kii.PushPayloadIDNotFoundException+json

The payloadID did not exists
Contents
Name Type Description
errorCode string Error code "PAYLOAD_ID_NOT_FOUND".
message string The error message.
userID string The userID
payloadID string The requested payloadID
appID string The ID of the application.
401

Content-Type application/vnd.kii.UnauthorizedAccessException+json

Not authorized to retrieve the message.
Contents
Name Type Description
errorCode string Error code "UNAUTHORIZED".
message string The error message.
authenticatedAppID string The authenticated appID.
authenticatedPrincipalID string The authenticated principal ID (userID or thingID).

DELETE

/api/apps/{appID}/users/{accountType}:{address}/payloads/{payloadID}

Description

Delete the payloadID

Security

Can be accessed with administrator credentials or user credentials with the same UserID.

Headers
Name Required? type Description
Authorization Yes string Authorization header. OAuth2 Bearer token
Responses
204

Content-Type (None)

PayloadID deleted
Note This response has no contents.
404

Content-Type application/vnd.kii.PushPayloadIDNotFoundException+json

The payloadID did not exists
Contents
Name Type Description
errorCode string Error code "PAYLOAD_ID_NOT_FOUND".
message string The error message.
userID string The userID
payloadID string The requested payloadID
appID string The ID of the application.
401

Content-Type application/vnd.kii.UnauthorizedAccessException+json

Not authorized to retrieve the message.
Contents
Name Type Description
errorCode string Error code "UNAUTHORIZED".
message string The error message.
authenticatedAppID string The authenticated appID.
authenticatedPrincipalID string The authenticated principal ID (userID or thingID).