POST api/Account

Request Information

URI Parameters

None.

Body Parameters

EmployeeLogin
NameDescriptionTypeAdditional information
UserId

string

None.

Password

string

None.

DeviceID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "UserId": "sample string 1",
  "Password": "sample string 2",
  "DeviceID": "sample string 3"
}

application/xml, text/xml

Sample:
<EmployeeLogin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <DeviceID>sample string 3</DeviceID>
  <Password>sample string 2</Password>
  <UserId>sample string 1</UserId>
</EmployeeLogin>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EmployeeItem
NameDescriptionTypeAdditional information
MissionId

string

None.

EmployeeNumber

string

None.

EmployeeJDENumber

string

None.

EmployeeName

string

None.

JobCode

string

None.

BranchCode

string

None.

BranchName

string

None.

RegionCode

string

None.

RegionName

string

None.

DivisionCode

string

None.

DivisionName

string

None.

EmployeeStatus

string

None.

EmployeeRole

string

None.

EmployeeRoleName

string

None.

EmployeeBranchName

string

None.

BUType

string

None.

TicketID

string

None.

ReturnMessage

string

None.

MetricsAccessTo

Collection of UserRoleMetrics

None.

Response Formats

application/json, text/json

Sample:
{
  "MissionId": "sample string 1",
  "EmployeeNumber": "sample string 2",
  "EmployeeJDENumber": "sample string 3",
  "EmployeeName": "sample string 4",
  "JobCode": "sample string 5",
  "BranchCode": "sample string 6",
  "BranchName": "sample string 7",
  "RegionCode": "sample string 8",
  "RegionName": "sample string 9",
  "DivisionCode": "sample string 10",
  "DivisionName": "sample string 11",
  "EmployeeStatus": "sample string 12",
  "EmployeeRole": "sample string 13",
  "EmployeeRoleName": "sample string 14",
  "EmployeeBranchName": "sample string 15",
  "BUType": "sample string 16",
  "TicketID": "sample string 17",
  "ReturnMessage": "sample string 18",
  "MetricsAccessTo": [
    {
      "MetricCode": "sample string 1",
      "MetricName": "sample string 2",
      "MetricCategory": "sample string 3",
      "MetricRequiresTarget": "sample string 4"
    },
    {
      "MetricCode": "sample string 1",
      "MetricName": "sample string 2",
      "MetricCategory": "sample string 3",
      "MetricRequiresTarget": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<EmployeeItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <BUType>sample string 16</BUType>
  <BranchCode>sample string 6</BranchCode>
  <BranchName>sample string 7</BranchName>
  <DivisionCode>sample string 10</DivisionCode>
  <DivisionName>sample string 11</DivisionName>
  <EmployeeBranchName>sample string 15</EmployeeBranchName>
  <EmployeeJDENumber>sample string 3</EmployeeJDENumber>
  <EmployeeName>sample string 4</EmployeeName>
  <EmployeeNumber>sample string 2</EmployeeNumber>
  <EmployeeRole>sample string 13</EmployeeRole>
  <EmployeeRoleName>sample string 14</EmployeeRoleName>
  <EmployeeStatus>sample string 12</EmployeeStatus>
  <JobCode>sample string 5</JobCode>
  <MetricsAccessTo>
    <UserRoleMetrics>
      <MetricCategory>sample string 3</MetricCategory>
      <MetricCode>sample string 1</MetricCode>
      <MetricName>sample string 2</MetricName>
      <MetricRequiresTarget>sample string 4</MetricRequiresTarget>
    </UserRoleMetrics>
    <UserRoleMetrics>
      <MetricCategory>sample string 3</MetricCategory>
      <MetricCode>sample string 1</MetricCode>
      <MetricName>sample string 2</MetricName>
      <MetricRequiresTarget>sample string 4</MetricRequiresTarget>
    </UserRoleMetrics>
  </MetricsAccessTo>
  <MissionId>sample string 1</MissionId>
  <RegionCode>sample string 8</RegionCode>
  <RegionName>sample string 9</RegionName>
  <ReturnMessage>sample string 18</ReturnMessage>
  <TicketID>sample string 17</TicketID>
</EmployeeItem>