Request Information

URI Parameters

None.

Body Parameters

AccessOperatorRequest
NameDescriptionTypeAdditional information
ClientId

API client consumer id

string

Required

ClientSecret

API client consumer secret

string

Required

AccessToken

Access Token

string

Required

Request Formats

application/json, text/json

Sample:
{
  "ClientId": "o7p7zumt2qa5xfybvhepeyexg26ijdua",
  "ClientSecret": "aWw2ZnJ4ZGR3YWN1MDdobzZyc2llbng2d3Ayc29nZTc=",
  "AccessToken": "2j4ksda234kjsafdsaf14sfsdag1=="
}

application/xml, text/xml

Sample:
<AccessOperatorRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests">
  <AccessToken>2j4ksda234kjsafdsaf14sfsdag1==</AccessToken>
  <ClientId>o7p7zumt2qa5xfybvhepeyexg26ijdua</ClientId>
  <ClientSecret>aWw2ZnJ4ZGR3YWN1MDdobzZyc2llbng2d3Ayc29nZTc=</ClientSecret>
</AccessOperatorRequest>

application/x-www-form-urlencoded

Sample:
ClientId=o7p7zumt2qa5xfybvhepeyexg26ijdua&ClientSecret=aWw2ZnJ4ZGR3YWN1MDdobzZyc2llbng2d3Ayc29nZTc=&AccessToken=2j4ksda234kjsafdsaf14sfsdag1==

Response Information

Resource Description

AccessOperatorResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

AccessOperatorResponseBody

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

AccessOperatorResponseBody
NameDescriptionTypeAdditional information
Operator

Operator

None.

Response Formats

application/json, text/json

Sample:
{
  "Header": {
    "Message": "",
    "StatusCode": 0,
    "Status": "Ok",
    "ErrorId": null
  },
  "Body": {
    "Operator": {
      "AccessorId": 1,
      "Accessor": {
        "AccessorId": 1,
        "FirstName": "John",
        "MiddleName": "Andrew",
        "LastName": "Smith",
        "EmployeeId": "10K",
        "AccessorType": "USER"
      },
      "Login": "1234",
      "Password": "pass1234",
      "PriorityLevel": 4,
      "LocationId": "999999",
      "IsAPIManager": true,
      "AllowAPIAccess": true
    }
  }
}

application/xml, text/xml

Sample:
<AccessOperatorResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
  <Body>
    <Operator xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.Business.Models">
      <d3p1:Accessor>
        <d3p1:AccessorId>1</d3p1:AccessorId>
        <d3p1:AccessorType>USER</d3p1:AccessorType>
        <d3p1:EmployeeId>10K</d3p1:EmployeeId>
        <d3p1:FirstName>John</d3p1:FirstName>
        <d3p1:LastName>Smith</d3p1:LastName>
        <d3p1:MiddleName>Andrew</d3p1:MiddleName>
      </d3p1:Accessor>
      <d3p1:AccessorId>1</d3p1:AccessorId>
      <d3p1:AllowAPIAccess>true</d3p1:AllowAPIAccess>
      <d3p1:IsAPIManager>true</d3p1:IsAPIManager>
      <d3p1:LocationId>999999</d3p1:LocationId>
      <d3p1:Login>1234</d3p1:Login>
      <d3p1:Password>pass1234</d3p1:Password>
      <d3p1:PriorityLevel>4</d3p1:PriorityLevel>
    </Operator>
  </Body>
  <Header>
    <ErrorId i:nil="true" />
    <Message></Message>
    <Status>Ok</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</AccessOperatorResponse>

© 2025 Sargent and Greenleaf