AlbaApi

<back to all web services

ListItemGetReq

The following routes are available for this service:
All Verbs/faq/{ListId}/{Country}/{Code}
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 ListItem(Entity):
    list_id: Optional[str] = None
    country: Optional[str] = None
    related_id: Optional[str] = None
    code: Optional[str] = None
    custom: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListItemGetReq:
    list_id: Optional[str] = None
    country: Optional[str] = None
    code: Optional[str] = None

Python ListItemGetReq 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 /faq/{ListId}/{Country}/{Code} HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ListItemGetReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AlbaApi.ServiceModel">
  <Code>String</Code>
  <Country>String</Country>
  <ListId>String</ListId>
</ListItemGetReq>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ListItem 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>
  <Code>String</Code>
  <Country>String</Country>
  <Custom>String</Custom>
  <ListId>String</ListId>
  <RelatedId>String</RelatedId>
</ListItem>