Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

GetAdministratorResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

GetAdministratorResponseBody

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

GetAdministratorResponseBody
NameDescriptionTypeAdditional information
Administrator

Administrator entity.

AdministratorViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "Administrator": {
      "AccessorId": 1,
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "LastName": "sample string 4",
      "Login": "sample string 5",
      "Password": "sample string 6",
      "EmployeeId": "sample string 7",
      "AccessorType": "sample string 8",
      "EmailAddress": "sample string 9",
      "PriorityLevel": 10,
      "IsLocked": true,
      "IsRegistrationLocked": true
    }
  }
}

application/xml, text/xml

Sample:
<GetAdministratorResponse 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:Administrator xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models">
      <d3p1:AccessorId>1</d3p1:AccessorId>
      <d3p1:AccessorType>sample string 8</d3p1:AccessorType>
      <d3p1:EmailAddress>sample string 9</d3p1:EmailAddress>
      <d3p1:EmployeeId>sample string 7</d3p1:EmployeeId>
      <d3p1:FirstName>sample string 2</d3p1:FirstName>
      <d3p1:IsLocked>true</d3p1:IsLocked>
      <d3p1:IsRegistrationLocked>true</d3p1:IsRegistrationLocked>
      <d3p1:LastName>sample string 4</d3p1:LastName>
      <d3p1:Login>sample string 5</d3p1:Login>
      <d3p1:MiddleName>sample string 3</d3p1:MiddleName>
      <d3p1:Password>sample string 6</d3p1:Password>
      <d3p1:PriorityLevel>10</d3p1:PriorityLevel>
    </d2p1:Administrator>
  </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>
</GetAdministratorResponse>

© 2025 Sargent and Greenleaf