AlbaApi

<back to all web services

ResolveReq

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

Python ResolveReq DTOs

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

HTTP + JSV

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

POST /resolve/changelog HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	changeLogs: 
	[
		{
			referenceId: String,
			country: String,
			language: String,
			section: String,
			itemCode: String,
			itemId: String,
			history: 
			[
				{
					updatedBy: String,
					dateCreated: 0001-01-01,
					element: String,
					old: String,
					new: String,
					status: String,
					approvedBy: String,
					dateApproved: 0001-01-01
				}
			],
			id: String
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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