regis

<back to all web services

AuditRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Audit
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AuditResponse:
    response_status: Optional[ResponseStatus] = None
    uuid: Optional[str] = None
    ip_address: Optional[str] = None
    url: Optional[str] = None
    controller: Optional[str] = None
    action: Optional[str] = None
    item_id: Optional[str] = None
    timestamp: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AuditsResponse:
    response_status: Optional[ResponseStatus] = None
    audits: Optional[List[AuditResponse]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AuditRequest:
    uuid: Optional[str] = None
    created_since_date: datetime.datetime = datetime.datetime(1, 1, 1)
    controller: Optional[str] = None
    action: Optional[str] = None
    item_id: Optional[str] = None

Python AuditRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Audit HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String","created_since_date":"0001-01-01T00:00:00.0000000","controller":"String","action":"String","item_id":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"audits":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","ip_address":"String","url":"String","controller":"String","action":"String","item_id":"String","timestamp":"0001-01-01T00:00:00.0000000"}]}