Trendsic Platform Service

<back to all web services

EquipmentUsageRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/Equipment/{EquipmentID}/usage
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 EquipmentUsageEntry:
    project_job_equipment_i_d: int = 0
    project_i_d: int = 0
    project_name: Optional[str] = None
    job_i_d: int = 0
    job_name: Optional[str] = None
    status_i_d: Optional[int] = None
    start_date: Optional[datetime.datetime] = None
    end_date: Optional[datetime.datetime] = None
    booking_count: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EquipmentUsageResponse:
    response_status: Optional[ResponseStatus] = None
    usage: List[EquipmentUsageEntry] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EquipmentUsageRequest:
    equipment_i_d: int = 0

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

GET /v1/Equipment/{EquipmentID}/usage HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	},
	Usage: 
	[
		{
			ProjectJobEquipmentID: 0,
			ProjectID: 0,
			ProjectName: String,
			JobID: 0,
			JobName: String,
			StatusID: 0,
			StartDate: 0001-01-01,
			EndDate: 0001-01-01,
			BookingCount: 0
		}
	]
}