TicketUserServices

<back to all web services

ApiVersionInfoRequest

Requires Authentication
Requires any of the roles:Admin, TeamAdminRequires the permission:ReadData
The following routes are available for this service:
GET POST/system/apiVersionHistory
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 ApiVersionInfoRequest:
    max_versions: Optional[int] = None
    from_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiVersionInfoResult:
    history: Optional[List[ApiVersionInfo]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiVersionInfo:
    version: Optional[str] = None
    release_time: Optional[datetime.datetime] = None
    version_description: Optional[str] = None
    version_details: Optional[str] = None
    code_changes: Optional[List[ApiCodeChangesInfo]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiCodeChangesInfo:
    code_changes_description: Optional[str] = None
    code_changes_details: Optional[str] = None
    changes_registered: Optional[datetime.datetime] = None

Python ApiVersionInfoRequest DTOs

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

HTTP + XML

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

POST /system/apiVersionHistory HTTP/1.1 
Host: stubbur-autoupdates-live.smartnewapis.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ApiVersionInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <FromDate>0001-01-01T00:00:00</FromDate>
  <MaxVersions>0</MaxVersions>
</ApiVersionInfoRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApiVersionInfoResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <History>
    <ApiVersionInfo>
      <CodeChanges>
        <ApiCodeChangesInfo>
          <ChangesRegistered>0001-01-01T00:00:00</ChangesRegistered>
          <CodeChangesDescription>String</CodeChangesDescription>
          <CodeChangesDetails>String</CodeChangesDetails>
        </ApiCodeChangesInfo>
      </CodeChanges>
      <ReleaseTime>0001-01-01T00:00:00</ReleaseTime>
      <Version>String</Version>
      <VersionDescription>String</VersionDescription>
      <VersionDetails>String</VersionDetails>
    </ApiVersionInfo>
  </History>
</ApiVersionInfoResult>