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

POST BROWSE_AUDIT_TRAIL_WITH_FILTER

Retrieves all of the audit trail records from the database. The list of records returned will be filtered by NumberOfHoursBackwardForShowingAuditTrail and NumberOfAuditTrailRecordsToShow being set in the web config file. Result is filtered by NumberOfHoursBackwardForShowingAuditTrail and NumberOfAuditTrailRecordsToShow from web config settings.

Request Information

URI Parameters

None.

Body Parameters

BrowseAuditTrailRequest
NameDescriptionTypeAdditional information
FilterColumn

string

None.
FilterString

string

None.
SortOrder

SortOrder

None.
SortColumn

string

None.
Page

PageNumber

 integer

Range: inclusive between 1 and 100000
PageSize

Page Size

 integer

Range: inclusive between 1 and 100000

Request Formats

application/json, text/json

Sample: 
{
  "FilterColumn": "sample string 1",
  "FilterString": "sample string 2",
  "SortOrder": 0,
  "SortColumn": "sample string 3",
  "Page": 4,
  "PageSize": 5
}

application/xml, text/xml

Sample: 
<BrowseAuditTrailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests.AuditTrail">
  <Page xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests">4</Page>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests">5</PageSize>
  <SortColumn xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests">sample string 3</SortColumn>
  <SortOrder xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests">Ascending</SortOrder>
  <FilterColumn xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests">sample string 1</FilterColumn>
  <FilterString xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Requests">sample string 2</FilterString>
</BrowseAuditTrailRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BrowseAuditTrailResponse

BrowseAuditTrailResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.
Body

BrowseAuditTrailResponseBody

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

BrowseAuditTrailResponseBody
NameDescriptionTypeAdditional information
LastHourAuditTrailCount

integer

None.
Audits

List of Audit Trail

 Collection of OperAuditModel

None.
ViewableAuditTrailCount

integer

None.
TotalCount

Total records count.

 integer

None.
PageSize

Page size.

 integer

None.
Page

Page

 integer

None.
PageCount

Number of pages.

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "LastHourAuditTrailCount": 1,
    "Audits": [
      {
        "AuditId": 1,
        "Name": "sample string 2",
        "AuditDate": "2025-05-28T13:42:20.8349599-07:00",
        "ChangeType": "sample string 3",
        "UserType": "sample string 4",
        "LoginName": "sample string 5",
        "LocationId": "sample string 6",
        "FunctionId": "sample string 7",
        "AccessorId": 8
      },
      {
        "AuditId": 1,
        "Name": "sample string 2",
        "AuditDate": "2025-05-28T13:42:20.8349599-07:00",
        "ChangeType": "sample string 3",
        "UserType": "sample string 4",
        "LoginName": "sample string 5",
        "LocationId": "sample string 6",
        "FunctionId": "sample string 7",
        "AccessorId": 8
      }
    ],
    "ViewableAuditTrailCount": 2,
    "TotalCount": 3,
    "PageSize": 4,
    "Page": 5,
    "PageCount": 6
  }
}

application/xml, text/xml

Sample: 
<BrowseAuditTrailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models.Responses">
  <Body>
    <Page>5</Page>
    <PageCount>6</PageCount>
    <PageSize>4</PageSize>
    <TotalCount>3</TotalCount>
    <Audits xmlns:d3p1="http://schemas.datacontract.org/2004/07/SaG.OTC.API.Models">
      <d3p1:OperAuditModel>
        <d3p1:AccessorId>8</d3p1:AccessorId>
        <d3p1:AuditDate>2025-05-28T13:42:20.8349599-07:00</d3p1:AuditDate>
        <d3p1:AuditId>1</d3p1:AuditId>
        <d3p1:ChangeType>sample string 3</d3p1:ChangeType>
        <d3p1:FunctionId>sample string 7</d3p1:FunctionId>
        <d3p1:LocationId>sample string 6</d3p1:LocationId>
        <d3p1:LoginName>sample string 5</d3p1:LoginName>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:UserType>sample string 4</d3p1:UserType>
      </d3p1:OperAuditModel>
      <d3p1:OperAuditModel>
        <d3p1:AccessorId>8</d3p1:AccessorId>
        <d3p1:AuditDate>2025-05-28T13:42:20.8349599-07:00</d3p1:AuditDate>
        <d3p1:AuditId>1</d3p1:AuditId>
        <d3p1:ChangeType>sample string 3</d3p1:ChangeType>
        <d3p1:FunctionId>sample string 7</d3p1:FunctionId>
        <d3p1:LocationId>sample string 6</d3p1:LocationId>
        <d3p1:LoginName>sample string 5</d3p1:LoginName>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:UserType>sample string 4</d3p1:UserType>
      </d3p1:OperAuditModel>
    </Audits>
    <LastHourAuditTrailCount>1</LastHourAuditTrailCount>
    <ViewableAuditTrailCount>2</ViewableAuditTrailCount>
  </Body>
  <Header>
    <ErrorId>sample string 3</ErrorId>
    <Message>sample string 1</Message>
    <Status>sample string 2</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</BrowseAuditTrailResponse>
© 2025 Sargent and Greenleaf