A Series One Time Code (OTC)
  1. Help
  2. POST ADD_ADMINISTRATOR

POST ADD_ADMINISTRATOR

Request Information

URI Parameters

None.

Body Parameters

AddAdministratorRequest
NameDescriptionTypeAdditional information
FirstName

First Name.

 string

Required
MiddleName

Middle Name .

 string

None.
LastName

Last Name.

 string

Required
EmployeeId

EmployeeId.

 string

Required
Login

Login.

 string

Required
Password

Password.

 string

Required

Max length: 12
EmailAddress

Email Address.

 string

None.
PriorityLevel

Priority Level.

 integer

Required
IsLocked

Is Locked.

 boolean

Required

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",
  "EmailAddress": "sample string 7",
  "PriorityLevel": 8,
  "IsLocked": true
}

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddAdministratorResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.
Body

AddAdministratorResponseBody

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

AddAdministratorResponseBody
NameDescriptionTypeAdditional information
AdministratorSaved

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": {
    "AdministratorSaved": true
  }
}

application/xml, text/xml

Sample: 
<AddAdministratorResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Responses.Administrator">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Responses.Administrator" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Responses">
    <d2p1:AdministratorSaved>true</d2p1:AdministratorSaved>
  </Body>
  <Header xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Responses">
    <ErrorId>sample string 3</ErrorId>
    <Message>sample string 1</Message>
    <Status>sample string 2</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</AddAdministratorResponse>
© 2025 Sargent and Greenleaf