AlbaApi

<back to all web services

ChangeLogReq

The following routes are available for this service:
GET/changelog
GET/changelog/{Country}/{Language}
GET/changelog/{Country}/{Language}/{Section}
GET/changelog/{Country}/{Language}/{Section}/{ItemCode}
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 Entity(IEntity):
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ChangeHistory:
    updated_by: Optional[str] = None
    date_created: Optional[datetime.datetime] = None
    element: Optional[str] = None
    old: Optional[str] = None
    new: Optional[str] = None
    status: Optional[str] = None
    approved_by: Optional[str] = None
    date_approved: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ChangeLog(Entity):
    reference_id: Optional[str] = None
    country: Optional[str] = None
    language: Optional[str] = None
    section: Optional[str] = None
    item_code: Optional[str] = None
    item_id: Optional[str] = None
    history: Optional[List[ChangeHistory]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ChangeLogReq:
    country: Optional[str] = None
    language: Optional[str] = None
    section: Optional[str] = None
    item_code: Optional[str] = None

Python ChangeLogReq DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /changelog HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"referenceId":"String","country":"String","language":"String","section":"String","itemCode":"String","itemId":"String","history":[{"updatedBy":"String","dateCreated":"0001-01-01T00:00:00.0000000","element":"String","old":"String","new":"String","status":"String","approvedBy":"String","dateApproved":"0001-01-01T00:00:00.0000000"}],"id":"String"}