Skip to content

Latest commit

 

History

History
506 lines (337 loc) · 10.9 KB

SeatsApi.md

File metadata and controls

506 lines (337 loc) · 10.9 KB

TractionToolsApiV1.SeatsApi

All URIs are relative to https://tt-devs.com

Method HTTP request Description
seatsAttachDirectReport POST /api/v1/seats/{SEAT_ID}/directreport/{USER_ID} Add a user below a seat
seatsAttachPosition POST /api/v1/seats/{SEAT_ID}/position/{POSITION_ID} Set the position for a seat
seatsAttachUser POST /api/v1/seats/{SEAT_ID}/user/{USER_ID} Set a user for a seat
seatsDetachUser DELETE /api/v1/seats/{SEAT_ID}/user Remove user from a seat
seatsGetPosition GET /api/v1/seats/{SEAT_ID}/position Get the position attached to a seat
seatsGetSeat GET /api/v1/seats/{SEAT_ID} Get a particular seat
seatsGetSeatUser GET /api/v1/seats/{SEAT_ID}/user Get the user for a seat
seatsGetSeatsForMe GET /api/v1/seats/user/mine Get your seats
seatsGetSeatsForUser GET /api/v1/seats/user/{USER_ID} Get seats for a user
seatsRemovePosition DELETE /api/v1/seats/{SEAT_ID}/position Remove position for a seat
seatsRemoveSeat DELETE /api/v1/seats/{SEAT_ID} Delete a seat from the accountability chart

seatsAttachDirectReport

Seat seatsAttachDirectReport(SEAT_ID, USER_ID)

Add a user below a seat

Example

var TractionToolsApiV1 = require('traction_tools_api___v1');

var apiInstance = new TractionToolsApiV1.SeatsApi();

var SEAT_ID = 789; // Number | Seat ID

var USER_ID = 789; // Number | User ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.seatsAttachDirectReport(SEAT_ID, USER_ID, callback);

Parameters

Name Type Description Notes
SEAT_ID Number Seat ID
USER_ID Number User ID

Return type

Seat

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json

seatsAttachPosition

seatsAttachPosition(SEAT_ID, POSITION_ID)

Set the position for a seat

Example

var TractionToolsApiV1 = require('traction_tools_api___v1');

var apiInstance = new TractionToolsApiV1.SeatsApi();

var SEAT_ID = 789; // Number | Seat ID

var POSITION_ID = 789; // Number | Position ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.seatsAttachPosition(SEAT_ID, POSITION_ID, callback);

Parameters

Name Type Description Notes
SEAT_ID Number Seat ID
POSITION_ID Number Position ID

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

seatsAttachUser

seatsAttachUser(SEAT_ID, USER_ID)

Set a user for a seat

Example

var TractionToolsApiV1 = require('traction_tools_api___v1');

var apiInstance = new TractionToolsApiV1.SeatsApi();

var SEAT_ID = 789; // Number | Seat ID

var USER_ID = 789; // Number | User ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.seatsAttachUser(SEAT_ID, USER_ID, callback);

Parameters

Name Type Description Notes
SEAT_ID Number Seat ID
USER_ID Number User ID

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

seatsDetachUser

seatsDetachUser(SEAT_ID)

Remove user from a seat

Example

var TractionToolsApiV1 = require('traction_tools_api___v1');

var apiInstance = new TractionToolsApiV1.SeatsApi();

var SEAT_ID = 789; // Number | Seat ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.seatsDetachUser(SEAT_ID, callback);

Parameters

Name Type Description Notes
SEAT_ID Number Seat ID

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

seatsGetPosition

Position seatsGetPosition(SEAT_ID)

Get the position attached to a seat

Example

var TractionToolsApiV1 = require('traction_tools_api___v1');

var apiInstance = new TractionToolsApiV1.SeatsApi();

var SEAT_ID = 789; // Number | Seat ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.seatsGetPosition(SEAT_ID, callback);

Parameters

Name Type Description Notes
SEAT_ID Number Seat ID

Return type

Position

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json

seatsGetSeat

Seat seatsGetSeat(SEAT_ID)

Get a particular seat

Example

var TractionToolsApiV1 = require('traction_tools_api___v1');

var apiInstance = new TractionToolsApiV1.SeatsApi();

var SEAT_ID = 789; // Number | Seat ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.seatsGetSeat(SEAT_ID, callback);

Parameters

Name Type Description Notes
SEAT_ID Number Seat ID

Return type

Seat

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json

seatsGetSeatUser

User seatsGetSeatUser(SEAT_ID)

Get the user for a seat

Example

var TractionToolsApiV1 = require('traction_tools_api___v1');

var apiInstance = new TractionToolsApiV1.SeatsApi();

var SEAT_ID = 789; // Number | Seat ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.seatsGetSeatUser(SEAT_ID, callback);

Parameters

Name Type Description Notes
SEAT_ID Number Seat ID

Return type

User

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json

seatsGetSeatsForMe

[Seat] seatsGetSeatsForMe()

Get your seats

Example

var TractionToolsApiV1 = require('traction_tools_api___v1');

var apiInstance = new TractionToolsApiV1.SeatsApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.seatsGetSeatsForMe(callback);

Parameters

This endpoint does not need any parameter.

Return type

[Seat]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json

seatsGetSeatsForUser

[Seat] seatsGetSeatsForUser(USER_ID)

Get seats for a user

Example

var TractionToolsApiV1 = require('traction_tools_api___v1');

var apiInstance = new TractionToolsApiV1.SeatsApi();

var USER_ID = 789; // Number | User ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.seatsGetSeatsForUser(USER_ID, callback);

Parameters

Name Type Description Notes
USER_ID Number User ID

Return type

[Seat]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json

seatsRemovePosition

seatsRemovePosition(SEAT_ID)

Remove position for a seat

Example

var TractionToolsApiV1 = require('traction_tools_api___v1');

var apiInstance = new TractionToolsApiV1.SeatsApi();

var SEAT_ID = 789; // Number | Seat ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.seatsRemovePosition(SEAT_ID, callback);

Parameters

Name Type Description Notes
SEAT_ID Number Seat ID

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

seatsRemoveSeat

seatsRemoveSeat(SEAT_ID)

Delete a seat from the accountability chart

Example

var TractionToolsApiV1 = require('traction_tools_api___v1');

var apiInstance = new TractionToolsApiV1.SeatsApi();

var SEAT_ID = 789; // Number | Seat ID


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.seatsRemoveSeat(SEAT_ID, callback);

Parameters

Name Type Description Notes
SEAT_ID Number Seat ID

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined