Self-Signup is a feature designed to give organizations a workflow for Learners to enroll in training by using a signup code, referred to as a "token". Signup tokens let organizations specify the following:

• Token code string
• What training Learners get enrolled into after claiming the token
• How many Learners may claim the code for redemption
• How long the signup code lasts before it expires

The API endpoints documented here are designed for the management of Self-Signup Tokens.

Important Note: Token Type must be an integer value of either 1, 2, 3 or 4. 

• 1 = Course
• 2 = Team
• 3 = Learning Path
• 4 = Collection listing

Get Tokens

Get a list of the tokens that can be used for self-signup.

Request Uri:

GET /tokens?

Response Body: (XML)

<Tokens> 
 <Token> 
  <TokenId>string [max length 50]</TokenId>
  <TokenCode>string[max length 250]</TokenCode> 
  <TokenType>integer</TokenType> 
  <TokenTypeId>string [max length 50]</TokenTypeId> 
  <Active>true/false</Active> 
  <MaximumActivations>integer</MaximumActivations> 
  <TokenExpiration>YYYY-MM-DDTHH:MM:SS</TokenExpiration> 
 </Token> 
 <Token> 
  ....... 
 </Token> 
</Tokens>

Get a Token

Get a specific token that can be used for self-signup.

Request Uri

GET /tokens/{tokenid}?

Response Body: (XML)

<Tokens> 
 <Token> 
  <TokenId>string [max length 50]</TokenId>
  <TokenCode>string[max length 250]</TokenCode> 
  <TokenType>integer</TokenType> 
  <TokenTypeId>string [max length 50]</TokenTypeId> 
  <Active>true/false</Active> 
  <MaximumActivations>integer</MaximumActivations> 
  <TokenExpiration>YYYY-MM-DD HH:MM:SS</TokenExpiration> 
 </Token> 
<Token> 

Create Tokens

Create one or more tokens to be used for self-signup.

Request Uri

POST /tokens?

Request Body: (XML)

<Tokens> 
 <Token> 
  <TokenCode>string[max length 250]</TokenCode> 
  <TokenType>integer</TokenType> 
  <TokenTypeId>string [max length 50]</TokenTypeId> 
  <Active>true/false</Active> 
  <MaximumActivations>integer</MaximumActivations> 
  <TokenExpiration>YYYY-MM-DD HH:MM:SS</TokenExpiration> 
 </Token> 
 <Token> 
  ....... 
 </Token> 
</Tokens>

Response Body: (XML)

<Tokens> 
 <Token> 
  <TokenId>string [max length 50]</TokenId>
  <TokenCode>string[max length 250]</TokenCode> 
  <TokenType>integer</TokenType> 
  <TokenTypeId>string [max length 50]</TokenTypeId> 
  <Active>true/false</Active> 
  <MaximumActivations>integer</MaximumActivations> 
  <TokenExpiration>YYYY-MM-DD HH:MM:SS</TokenExpiration> 
 </Token> 
 <Token> 
  ....... 
 </Token> 
</Tokens>

Update Tokens

Update one or more tokens to be used for self-signup.

Request Uri

PUT /tokens?source=MyApp

Request Body: (XML)

<Tokens> 
 <Token> 
   <TokenId>string [max length 50]</TokenId>
   <TokenCode>string[max length 250]</TokenCode> 
   <TokenType>integer</TokenType> 
   <TokenTypeId>string [max length 50]</TokenTypeId> 
   <Active>true/false</Active> 
   <MaximumActivations>integer</MaximumActivations> 
   <TokenExpiration>YYYY-MM-DD HH:MM:SS</TokenExpiration> 
 </Token> 
 <Token> 
   ....... 
 </Token> 
</Tokens>

Response Body: (XML)

<Tokens> 
 <Token> 
  <TokenId>string [max length 50]</TokenId>
  <TokenCode>string[max length 250]</TokenCode> 
  <TokenType>integer</TokenType> 
  <TokenTypeId>string [max length 50]</TokenTypeId> 
  <Active>true/false</Active> 
  <MaximumActivations>integer</MaximumActivations> 
  <TokenExpiration>YYYY-MM-DD HH:MM:SS</TokenExpiration> 
 </Token> 
 <Token> 
  ....... 
 </Token> 
</Tokens>