Sessions

Description

This resource is for internal sessions management, allowed for administrative superusers only.

Attributes

Name	Type	Description
resource_uri	reference	read only
id	string	read only. Session key / ID
expire_date	timestamp	read only
user	object	user information object
user.resource_uri	reference	read only
user.id	integer	user internal ID
user.username	string	username
user.email	string	user e-mail address
user.gender	string	user gender. Can be “mr”, “ms”, “mrs”
user.first_name	string	user first name
user.last_name	string	user last name
user.type	string	user type. Can be “candidate”, “customer”
user.status	string	user current status, respective to the user type
user.activation_key	string	candidate activation code
user.current_question	string	candidate first unanswered question
user.company_identifier	string	company identifier for such user
user.project_language	string	ISO 639-1 language code for the interview. It can also include the country code, suffixed after a dash sign. i.e. “de”, “en”, “en-us”, “fr”

List

/sessions/

Methods

• GET

Example response

{"meta":{
    "total_count":1,
    "previous":null,
    "next":null
 },
 "objects":[
   {"resource_uri":"https://alpha.interview-suite.com/api/v3/sessions/1234567890abcdef1234567890abcdef12345678/",
    "id":"1234567890abcdef1234567890abcdef12345678",
    "expire_date":"2015-06-19T12:24:11Z",
    "user":{
       "resource_uri": "https://alpha.interview-suite.com/api/v3/companies/4/projects/35/candidates/2/",
       "id": 23,
       "gender": "Mr.",
       "username": "jorge123",
       "company_identifier": "alpha",
       "project_language": "de",
       "first_name": "Jorge",
       "last_name": "da Capadocia",
       "email": "jorge.capadocia@viasto.com",
       "type": "candidate",
       "status": "interviewed",
       "activation_key": "dcb9b7bc11a1a1154fad4d463f22ea47",
       "current_question": "https://alpha.interview-suite.com/api/v3/companies/4/projects/35/questions/75/"
    }
   }
  ]
}

Object

/sessions/{{sessionId}}/

Methods

• GET

Example response

{"resource_uri":"https://alpha.interview-suite.com/api/v3/sessions/1234567890abcdef1234567890abcdef12345678/",
 "expire_date":"2015-06-19T12:24:11Z",
 "id":"1234567890abcdef1234567890abcdef12345678",
 "user":{
    "resource_uri": "https://alpha.interview-suite.com/api/v3/companies/4/projects/35/candidates/2/",
    "id": 23,
    "gender": "Mr.",
    "username": "jorge123",
    "company_identifier": "alpha",
    "project_language": "de",
    "first_name": "Jorge",
    "last_name": "da Capadocia",
    "email": "jorge.capadocia@viasto.com",
    "type": "candidate",
    "status": "interviewed",
    "activation_key": "dcb9b7bc11a1a1154fad4d463f22ea47",
    "current_question": "https://alpha.interview-suite.com/api/v3/companies/4/projects/35/questions/75/"
 }
}