Request Information

URI Parameters

None.

Body Parameters

AddOperatorRequest

AddOperatorRequest
NameDescriptionTypeAdditional information
FirstName

First Name.

string

Required

MiddleName

Middle Name.

string

None.

LastName

Last Name

string

Required

EmployeeId

Employee ID

string

None.

Login

Login.

string

Required

Password

Password.

string

Required

PriorityLevel

Priority Level

integer

Required

LocationId

Location Id

string

None.

TouchKeyId

TouchKey Id

string

None.

Request Formats

application/json, text/json

Sample:
{
  "FirstName": "sample string 1",
  "MiddleName": "sample string 2",
  "LastName": "sample string 3",
  "EmployeeId": "sample string 4",
  "Login": "sample string 5",
  "Password": "sample string 6",
  "PriorityLevel": 7,
  "LocationId": "sample string 8",
  "TouchKeyId": "sample string 9"
}

application/xml, text/xml

Sample:
<AddOperatorRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">
  <EmployeeId>sample string 4</EmployeeId>
  <FirstName>sample string 1</FirstName>
  <LastName>sample string 3</LastName>
  <LocationId>sample string 8</LocationId>
  <Login>sample string 5</Login>
  <MiddleName>sample string 2</MiddleName>
  <Password>sample string 6</Password>
  <PriorityLevel>7</PriorityLevel>
  <TouchKeyId>sample string 9</TouchKeyId>
</AddOperatorRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddOperatorResponse

AddOperatorResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

AddOperatorResponseBody

None.

Response Header Description

ResponseHeader
NameDescriptionTypeAdditional information
Message

Message

string

None.

StatusCode

Status code

ResponseStatus

None.

Status

Status

string

None.

ErrorId

Error id

string

None.

Response Body Description

AddOperatorResponseBody
NameDescriptionTypeAdditional information
OperatorSaved

Flag to show if operator was successfully saved

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "OperatorSaved": true
  }
}

application/xml, text/xml

Sample:
<AddOperatorResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
  <Body>
    <OperatorSaved>true</OperatorSaved>
  </Body>
  <Header>
    <ErrorId>sample string 3</ErrorId>
    <Message>sample string 1</Message>
    <Status>sample string 2</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</AddOperatorResponse>

© 2025 Sargent and Greenleaf