GET api/v1/eventlog

Gets events that have been made with this application (related to current access token)

Requires authorization!

Response Codes

  • 200 - Successfully got list of events
  • 401 - User is not Authorized

Request Information

URI Parameters

NameDescriptionTypeAdditional information
EventDateFrom

Start datetime

date

None.

EventDateTo

end datetime

date

None.

EventType

Event type

ApiRequestLogEventType

None.

IpAddress

IP address

string

None.

PageSize

Max items in result, default is 10000

integer

Range: inclusive between 1 and 20000

PageNr

Result page nr

integer

Range: inclusive between 1 and 2147483647

Body Parameters

None.

Response Information

Resource Description

Gets events that have been made with this application (related to current access token)
List of EventLogItem objects set to Payload property

ApiResultEventLog
NameDescriptionTypeAdditional information
PageSize

Requested Max items in result

integer

Range: inclusive between 0 and 2147483647

PageNr

Requested page nr

integer

Range: inclusive between 1 and 2147483647

TotalCount

Total number of items found

integer

Required

Range: inclusive between 0 and 2147483647

Count

Number of items returned

integer

Required

Range: inclusive between 0 and 2147483647

Payload

The payload of the response. Type depends on the API request.

Collection of EventLogItem

None.

Success

Indicates if the request was successfull or not. true if the request was handled successfully, false otherwise.

boolean

Required

Errors

Error(s) accociated with the API request.

Collection of ApiError

None.

Response Formats

application/json, text/json

Sample:
{
  "PageSize": 1,
  "PageNr": 2,
  "TotalCount": 3,
  "Count": 4,
  "Payload": [
    {
      "EventDate": "2018-12-11T17:02:28.5402499+02:00",
      "EventType": 1,
      "IpAddress": "sample string-2",
      "Data": "sample string-3"
    },
    {
      "EventDate": "2018-12-11T17:02:28.5402499+02:00",
      "EventType": 1,
      "IpAddress": "sample string-2",
      "Data": "sample string-3"
    }
  ],
  "Success": true,
  "Errors": [
    {
      "Code": 1,
      "Message": "sample string-2",
      "Details": "sample string-3"
    },
    {
      "Code": 1,
      "Message": "sample string-2",
      "Details": "sample string-3"
    }
  ]
}

application/xml, text/xml

Sample:
<ApiResultEventLog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sobralaen.Api.Models">
  <Errors>
    <ApiError>
      <Code>1</Code>
      <Details>sample string-3</Details>
      <Message>sample string-2</Message>
    </ApiError>
    <ApiError>
      <Code>1</Code>
      <Details>sample string-3</Details>
      <Message>sample string-2</Message>
    </ApiError>
  </Errors>
  <Success>true</Success>
  <Payload>
    <EventLogItem>
      <Data>sample string-3</Data>
      <EventDate>2018-12-11T17:02:28.5402499+02:00</EventDate>
      <EventType>MakeBid</EventType>
      <IpAddress>sample string-2</IpAddress>
    </EventLogItem>
    <EventLogItem>
      <Data>sample string-3</Data>
      <EventDate>2018-12-11T17:02:28.5402499+02:00</EventDate>
      <EventType>MakeBid</EventType>
      <IpAddress>sample string-2</IpAddress>
    </EventLogItem>
  </Payload>
  <Count>4</Count>
  <PageNr>2</PageNr>
  <PageSize>1</PageSize>
  <TotalCount>3</TotalCount>
</ApiResultEventLog>