All Verbs | /customers |
---|
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 Customer:
id: Optional[str] = None
company_name: Optional[str] = None
contact_name: Optional[str] = None
contact_title: Optional[str] = None
address: Optional[str] = None
city: Optional[str] = None
region: Optional[str] = None
postal_code: Optional[str] = None
country: Optional[str] = None
phone: Optional[str] = None
fax: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomersResponse:
results: Optional[List[Customer]] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAllCustomers(IGet):
pass
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /customers HTTP/1.1
Host: northwind.netcore.io
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetAllCustomers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Northwind.ServiceModel" />
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <CustomersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Northwind.ServiceModel"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Northwind.ServiceModel.Types"> <d2p1:Customer> <d2p1:Address>String</d2p1:Address> <d2p1:City>String</d2p1:City> <d2p1:CompanyName>String</d2p1:CompanyName> <d2p1:ContactName>String</d2p1:ContactName> <d2p1:ContactTitle>String</d2p1:ContactTitle> <d2p1:Country>String</d2p1:Country> <d2p1:Fax>String</d2p1:Fax> <d2p1:Id>String</d2p1:Id> <d2p1:Phone>String</d2p1:Phone> <d2p1:PostalCode>String</d2p1:PostalCode> <d2p1:Region>String</d2p1:Region> </d2p1:Customer> </Results> </CustomersResponse>