Package Rights API

Package API to validate if the session is valid and the viewer’s have the necessary rights to the package. This API should be called when the application starts to validate if the user has rights and is login to EON-XR.

Request Syntax

Post /PackageExternal/PackageRights

Content-type: application/json

{
    "Token": "string"
}

Request Body

The request accepts the following data in JSON format.

Example Values

Content-type: application/json

{
    "token": "a570a9e74bbc43c3b180e63b0afb704c"
}

Properties Details

Token

Description:

The Token value that was pass from the --token argument. Refer to Option List for more information.

Type:

string

Required:

Yes

Example:

a570a9e74bbc43c3b180e63b0afb704c

Responses Syntax

Content-type: application/json

{
    "Status": number,
    "Message": "string",
}

Example Values

Code: 200

Content-type: application/json

{
    "Status": 1,
    "Message": "Valid"
}

Properties Details

status

Description:

Returns the status for the request.

Possible Values:

  • “1” - Rights validation successfully

  • “0” - Failure to validate the request, see message property for more information

Type:

number

Required:

Yes

Example:

0 or 1

message

Description:

Returns the corresponding Description for each of the request status.

Possible Values:

  • “Valid” - Describe Package session is successfully validated, and the corresponding status is “1”.

  • “Not Valid” - Describe Package session validation is unsuccessful, and the corresponding status is “0”.

  • “Invalid parameters” - Describe Request parameters are invalid or missing parameters. The corresponding status is “0”.

  • “Exception error” - Describe an unhandled exception has occurred, and the corresponding status is “0”.

Type:

number

Required:

Yes

Example:

“Not Valid”