AlbaApi

<back to all web services

MergeReq

The following routes are available for this service:
POST/merge/changelog
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 MergeReq:
    change_logs: Optional[List[ChangeLog]] = None

Python MergeReq 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 /merge/changelog HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MergeReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.ServiceModel">
  <ChangeLogs xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
    <d2p1:ChangeLog>
      <Id xmlns="http://schemas.datacontract.org/2004/07/TasSyd.Model.Base">String</Id>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:History>
        <d2p1:ChangeHistory>
          <d2p1:ApprovedBy>String</d2p1:ApprovedBy>
          <d2p1:DateApproved>0001-01-01T00:00:00</d2p1:DateApproved>
          <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
          <d2p1:Element>String</d2p1:Element>
          <d2p1:New>String</d2p1:New>
          <d2p1:Old>String</d2p1:Old>
          <d2p1:Status>String</d2p1:Status>
          <d2p1:UpdatedBy>String</d2p1:UpdatedBy>
        </d2p1:ChangeHistory>
      </d2p1:History>
      <d2p1:ItemCode>String</d2p1:ItemCode>
      <d2p1:ItemId>String</d2p1:ItemId>
      <d2p1:Language>String</d2p1:Language>
      <d2p1:ReferenceId>String</d2p1:ReferenceId>
      <d2p1:Section>String</d2p1:Section>
    </d2p1:ChangeLog>
  </ChangeLogs>
</MergeReq>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ChangeLog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.Model">
  <Id xmlns="http://schemas.datacontract.org/2004/07/TasSyd.Model.Base">String</Id>
  <Country>String</Country>
  <History>
    <ChangeHistory>
      <ApprovedBy>String</ApprovedBy>
      <DateApproved>0001-01-01T00:00:00</DateApproved>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <Element>String</Element>
      <New>String</New>
      <Old>String</Old>
      <Status>String</Status>
      <UpdatedBy>String</UpdatedBy>
    </ChangeHistory>
  </History>
  <ItemCode>String</ItemCode>
  <ItemId>String</ItemId>
  <Language>String</Language>
  <ReferenceId>String</ReferenceId>
  <Section>String</Section>
</ChangeLog>