BokaMera.API.Host

<back to all web services

CreateCompanyCategory

Requires Authentication
The following routes are available for this service:
POST/categoriesCreate company categoriesCreate company categories that a company can belong to.
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 CompanyCategoryQueryResponse:
    id: int = 0
    name: Optional[str] = None
    active: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateCompanyCategory:
    # @ApiMember(Description="Name of the category", IsRequired=true)
    name: Optional[str] = None
    """
    Name of the category
    """

Python CreateCompanyCategory 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 /categories HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateCompanyCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Name>String</Name>
</CreateCompanyCategory>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanyCategoryQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <Id>0</Id>
  <Name>String</Name>
</CompanyCategoryQueryResponse>