Support Sessions
Show
GET /support_sessions/#{id}.format

Description

User can retrieve support session information.
Authentication is required to use this method.


Arguments

  1. OAuth (mandatory): OAuth authentication params
  2. session id (mandatory): session unique identifier

Response example

Status:200

<support_session>
        <id> 123456789</id>
        <code>123qaz</code>
        <state>planned</state>
        <customer>CustomerName</customer>
        <customer_mail>test@ntr.com</customer_mail>
        <language>en</language>
        <planned_init_time>2010-07-21T16:36:37Z</planned_init_time>
        <planned_end_time>2010-07-21T16:51:37Z</ planned_end_time>
        <init_time>2010-07-21T16:41:52Z</init_time>
        <end_time>2010-07-21T16:56:01Z</end_time>
        <note>This is a note</note>
        <user_id>10</user_id>
</support_session>
Response values

  1. id: unique session ID
  2. code: session code used by the customer to access the session 
  3. state: session status
    • planned
    • ongoing
    • finished
  4. customer: customer name
  5. customer_mail: customer email address
  6. language: session binary in the language specified
    • en - English
    • es - Spanish
    • it - Italian
    • ge - German
    • fr - French 
  7. planned_init_time: scheduled time this session will start
  8. planned_end_time: scheduled time this session will end
  9. init_time: time session started
  10. end_time: time session ended
  11. note: session notes entered by the user
  12. user_id: user identificator that has created the session

Error Codes

  1. 1300 - Support Session not found (404)


List All
GET /support_sessions.format

Description

User can obtain a collection of sessions. Authentication is required to use this method.


Arguments

  1. OAuth (mandatory): OAuth authentication params

Response example

Status: 200

<support_sessions>
        <support_session>

                …

        </support_session>
        <support_session>

                …

        </support_session>
</support_sessions>


Create
POST / support_sessions.format

Description

User can create a support session.
Authentication is required to use this method.


Arguments

  1. OAuth (mandatory): OAuth authentication params 
  2. customer (mandatory): customer name.
  3. customer_mail (optional): customer email address. If specified NTR will send an invitation to the session to the customer.
  4. language (mandatory): session binary in the language specified
    • en - English
    • es - Spanish
    • it - Italian
    • ge - German
    • fr - French
  5. planned_init_time (optional): scheduled time session will start. If not specified this value will be current server time 
  6. planned_end_time (optional): scheduled time session will end. If not specified the session code will last for 15 minutes.

Request example

<support_session>
        <customer>CustomerName</customer>
        <customer_mail>test@ntr.com</customer_mail>
        <language>en</language>
        <planned_init_time>2010-07-21T16:36:37Z</planned_init_time>
        <planned_end_time>2010-07-21T16:51:37Z</ planned_end_time>
</support_session>
Response example

Status:201

Location: https://apifree.ntrglobal.com/support_sessions/#{new-session-id}.xml
Error Codes

  1. 1301- customer can't be blank (422)
  2. 1302- language can't be blank (422)


Update
PUT /support_sessions/#{id}.format

Description

User can update existing support session information.
Authentication is required to use this method.


Arguments

  1. OAuth (mandatory): OAuth authentication params 
  2. customer (optional): customer name. If not specified this field is not stored.
  3. customer_mail (optional): customer email
  4. language (optional): session binary in the language specified
    • en - English 
    • es - Spanish
    • it - Italian
    • ge - German
    • fr - French
  5. planned_init_time (optional): scheduled time session will start
  6. planned_end_time (optional): scheduled time session will end. If not specified the session code will last for 15 minutes.

Request example

<support_session>
        <customer>CustomerName</customer>
        <planned_init_time>2010-07-21T16:36:37Z</planned_init_time>
</support_session>

Response example

Status:200
Error Codes

  1. 1002 - parameter not valid (403)
  2. 1300 - support session not found (404)


Destroy
DELETE / support_sessions/#{id}.format

Description

User can remove a not finished session.
Authentication is required to use this method.


Arguments

  1. OAuth (mandatory): OAuth authentication params
  2. session id (mandatory): unique session ID

Response example

Status:200
Error Codes

  1. 1300 - support session not found (404)