Users

Provides access to Task Force user management functions for third-party applications. Because this service deals with functionality accessible to the account pseudo-admin, its methods can operate using the Task Force account's password as an access password if the access user login specified is "admin".

Methods:

• CreateAccountUser - Creates a Task Force Account User with the specified parameters.
• CreateClientUser - Creates a Task Force Client User with the specified parameters.
• ListAccountUsers - Returns a list of Task Force Account Users.
• ListClientUsers - Returns a list of Task Force Client Users.
• UpdateAccountUser - Updates a Task Force Account User with the specified parameters.
• UpdateClientUser - Updates a Task Force Client User with the specified parameters.

General Notes: All Scaffold web methods require that the Content Type of your request is "application/scaffold+json". The Host and Content-Length headers are not required. Scaffold's response Content-Type will always be "application/json". The formatting of JSON shown in the examples on this page is not enforced in requests or necessarily followed in responses--it is only shown as such to enhance human readability--assume that you can send (and may receive) any legal JSON that has the same object, property, and array structures.

CreateAccountUser

Creates a Task Force Account User with the specified parameters.

Parameters:

• accessAccountLogin - The login of the account against which this command will be executed.
• accessUserLogin - The login of a user within the account with permission to execute this command.
• accessPassword - The password of the user as specified by the accountLogin and userLogin parameters.
• name - The name of the user.
• login - The login of the user.
• password - The password of the user.
• email - The e-mail address of the user.
• enabled - True if the user is enabled; otherwise, false.
• admin - True if the user has the Admin privilege; otherwise, false.
• fiscal - True if the user has the explicit Fiscal privilege; otherwise, false.
• manager - True if the user has the explicit Manager privilege; otherwise, false.
• supervisorIds - The user IDs of this user's supervisors.
• superviseeIds - The user IDs of this user's supervisees.

Example Request:

POST /API/Users.aspx/CreateAccountUser HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 342

{
  "accessAccountLogin": "string",
  "accessUserLogin": "string",
  "accessPassword": "string",
  "name": "string",
  "login": "string",
  "password": "string",
  "email": "string",
  "enabled": false,
  "admin": false,
  "fiscal": false,
  "manager": false,
  "supervisorIds": [
    0
  ],
  "superviseeIds": [
    0
  ]
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 43

{
  "Response": 0,
  "Error": "string"
}

CreateClientUser

Creates a Task Force Client User with the specified parameters.

Parameters:

• accessAccountLogin - The login of the account against which this command will be executed.
• accessUserLogin - The login of a user within the account with permission to execute this command.
• accessPassword - The password of the user as specified by the accountLogin and userLogin parameters.
• name - The name of the user.
• login - The login of the user.
• password - The password of the user.
• email - The e-mail address of the user.
• enabled - True if the user is enabled; otherwise, false.
• clientOrganization - The organization of the client user.
• clientInvoiceAddress - The invoicing address of the client user.

Example Request:

POST /API/Users.aspx/CreateClientUser HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 284

{
  "accessAccountLogin": "string",
  "accessUserLogin": "string",
  "accessPassword": "string",
  "name": "string",
  "login": "string",
  "password": "string",
  "email": "string",
  "enabled": false,
  "clientOrganization": "string",
  "clientInvoiceAddress": "string"
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 43

{
  "Response": 0,
  "Error": "string"
}

ListAccountUsers

Returns a list of Task Force Account Users.

Parameters:

• accountLogin - The login of the account against which this command will be executed.
• userLogin - The login of a user within the account with permission to execute this command.
• password - The password of the user as specified by the accountLogin and userLogin parameters.

Example Request:

POST /API/Users.aspx/ListAccountUsers HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 83

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string"
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 345

{
  "Response": [
    {
      "Admin": false,
      "Fiscal": false,
      "Manager": false,
      "SupervisorIds": [
        0
      ],
      "SuperviseeIds": [
        0
      ],
      "Id": 0,
      "Name": "string",
      "Login": "string",
      "Email": "string",
      "Enabled": false
    }
  ],
  "Error": "string"
}

ListClientUsers

Returns a list of Task Force Client Users.

Parameters:

• accountLogin - The login of the account against which this command will be executed.
• userLogin - The login of a user within the account with permission to execute this command.
• password - The password of the user as specified by the accountLogin and userLogin parameters.

Example Request:

POST /API/Users.aspx/ListClientUsers HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 83

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string"
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 259

{
  "Response": [
    {
      "ClientOrganization": "string",
      "ClientInvoiceAddress": "string",
      "Id": 0,
      "Name": "string",
      "Login": "string",
      "Email": "string",
      "Enabled": false
    }
  ],
  "Error": "string"
}

UpdateAccountUser

Updates a Task Force Account User with the specified parameters.

Parameters:

• accessAccountLogin - The login of the account against which this command will be executed.
• accessUserLogin - The login of a user within the account with permission to execute this command.
• accessPassword - The password of the user as specified by the accountLogin and userLogin parameters.
• id - The user's ID.
• name - The name of the user.
• login - The login of the user.
• password - The password of the user. Specify null or an empty string to refrain from resetting the user's password.
• email - The e-mail address of the user.
• enabled - True if the user is enabled; otherwise, false.
• admin - True if the user has the Admin privilege; otherwise, false.
• fiscal - True if the user has the explicit Fiscal privilege; otherwise, false.
• manager - True if the user has the explicit Manager privilege; otherwise, false.
• supervisorIds - The user IDs of this user's supervisors.
• superviseeIds - The user IDs of this user's supervisees.

Example Request:

POST /API/Users.aspx/UpdateAccountUser HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 354

{
  "accessAccountLogin": "string",
  "accessUserLogin": "string",
  "accessPassword": "string",
  "id": 0,
  "name": "string",
  "login": "string",
  "password": "string",
  "email": "string",
  "enabled": false,
  "admin": false,
  "fiscal": false,
  "manager": false,
  "supervisorIds": [
    0
  ],
  "superviseeIds": [
    0
  ]
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 25

{
  "Error": "string"
}

UpdateClientUser

Updates a Task Force Client User with the specified parameters.

Parameters:

• accessAccountLogin - The login of the account against which this command will be executed.
• accessUserLogin - The login of a user within the account with permission to execute this command.
• accessPassword - The password of the user as specified by the accountLogin and userLogin parameters.
• id - The user's ID.
• name - The name of the user.
• login - The login of the user.
• password - The password of the user. Specify null or an empty string to refrain from resetting the user's password.
• email - The e-mail address of the user.
• enabled - True if the user is enabled; otherwise, false.
• clientOrganization - The organization of the client user.
• clientInvoiceAddress - The invoicing address of the client user.

Example Request:

POST /API/Users.aspx/UpdateClientUser HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 296

{
  "accessAccountLogin": "string",
  "accessUserLogin": "string",
  "accessPassword": "string",
  "id": 0,
  "name": "string",
  "login": "string",
  "password": "string",
  "email": "string",
  "enabled": false,
  "clientOrganization": "string",
  "clientInvoiceAddress": "string"
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 25

{
  "Error": "string"
}