Server

<back to all web services

PutDeviceConsumption

Deviceconsumptions
Requires Authentication
The following routes are available for this service:
PUT/api/v1/deviceconsumptions
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 PutDeviceConsumptionResponse:
    response_status: Optional[ResponseStatus] = None


class DeviceReadingKind(str, Enum):
    ZA = 'ZA'
    HA = 'HA'
    MO = 'MO'
    EB = 'EB'
    AB = 'AB'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeviceConsumption:
    guid: Optional[str] = None
    device_reading: Optional[float] = None
    device_reading_date: Optional[datetime.datetime] = None
    device_reading_kind: Optional[DeviceReadingKind] = None
    change_date: Optional[datetime.datetime] = None
    note: Optional[str] = None
    ampoule_colour: Optional[str] = None
    device_guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RelatedTo:
    guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PutDeviceConsumption(IHasBearerToken):
    # @ApiMember(IsRequired=true, ParameterType="body")
    device_consumption: Optional[DeviceConsumption] = None

    # @ApiMember(IsRequired=true, ParameterType="body")
    related_to_device: Optional[RelatedTo] = None

    # @ApiMember(IsRequired=true, ParameterType="body")
    bearer_token: Optional[str] = None

Python PutDeviceConsumption 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.

PUT /api/v1/deviceconsumptions HTTP/1.1 
Host: beson-servdesk.eras-online.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	deviceConsumption: 
	{
		guid: 00000000000000000000000000000000,
		deviceReading: 0,
		deviceReadingDate: 0001-01-01T00:00:00Z,
		deviceReadingKind: ZA,
		changeDate: 0001-01-01T00:00:00Z,
		note: String,
		ampouleColour: String,
		deviceGuid: String
	},
	relatedToDevice: 
	{
		guid: 00000000000000000000000000000000
	},
	bearerToken: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}