/
program_get_invitation (session, program {, version=null})

program_get_invitation (session, program {, version=null})

Owned by Pedro Jose Sanchez Luling
Last updated: Feb 12, 2021

Generates a SHARED KEY OBJECT that can be used as an invitation to a PROGRAM.

The shared key generated is an encrypted string that can be used in account_create() or in session_init().

When a user creates a new account (via  account_create() ) or logs in the system (via session_init() ) indicating the invitation shared key, a new SUBSCRIPTION to the PROGRAM will be generated. The SUBSCRIPTION will belong to a private TEAM of the USER. This means that only that USER will be able to create new ADMISSIONS in that SUBSCRIPTION

Input

parameters:

  • session: a token obtained by calling session_init()
  • program: Identifier of the PROGRAM for which the invitation will be generated
  • version: Usually NULL. An specific version of a PROGRAM can be indicated, but in most of the cases it is not necessary and the last version of the PROGRAM will be used

Output

parameters:

  • result: If everything is ok, returns an encrypted SHARED KEY OBJECT that contains the invitation information
  • ErrorMsg: In case of error, the description of the error in the language provided in the lang parameter
  • ErrorCode: In case of error, one of the possible ERROR CODES

Request

sample:

program_get_invitation ( “LCAAAAAAAAAAAA”, 12);

Response

sample:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<result>7aadshas7duihqovsn8</result>
<ErrorMsg></ErrorMsg>
<ErrorCode></ErrorCode>

Notes:

Currently it is not possible to create new accounts 'from scratch'. It is necessary that the account has been pre-created by adding a CASE , USER or ASSOCIATE

Return Error codes

ERROR CODE

INVALID_TOKEN

The session token provided is not valid
PROGRAM.NOT_FOUNDThe specified PROGRAM does not exist

INSUFFICIENT_PRIVILEGES

The account already exists and the verification is pending. In this case, the shared key necessary to validate the account is also returned in the response

Related content