Trendsic Platform Service

<back to all web services

MaterialUsageRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/Material/{MaterialID}/usage
import 'package:servicestack/servicestack.dart';

class MaterialUsageEntry implements IConvertible
{
    String? Scope;
    int? ProjectID;
    String? ProjectName;
    int? JobID;
    String? JobName;
    int? Quantity;
    String? UsageDate;

    MaterialUsageEntry({this.Scope,this.ProjectID,this.ProjectName,this.JobID,this.JobName,this.Quantity,this.UsageDate});
    MaterialUsageEntry.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Scope = json['Scope'];
        ProjectID = json['ProjectID'];
        ProjectName = json['ProjectName'];
        JobID = json['JobID'];
        JobName = json['JobName'];
        Quantity = json['Quantity'];
        UsageDate = json['UsageDate'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Scope': Scope,
        'ProjectID': ProjectID,
        'ProjectName': ProjectName,
        'JobID': JobID,
        'JobName': JobName,
        'Quantity': Quantity,
        'UsageDate': UsageDate
    };

    getTypeName() => "MaterialUsageEntry";
    TypeContext? context = _ctx;
}

class MaterialUsageResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<MaterialUsageEntry>? Usage = [];

    MaterialUsageResponse({this.ResponseStatus,this.Usage});
    MaterialUsageResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        Usage = JsonConverters.fromJson(json['Usage'],'List<MaterialUsageEntry>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Usage': JsonConverters.toJson(Usage,'List<MaterialUsageEntry>',context!)
    };

    getTypeName() => "MaterialUsageResponse";
    TypeContext? context = _ctx;
}

class MaterialUsageRequest implements IConvertible
{
    int? MaterialID;

    MaterialUsageRequest({this.MaterialID});
    MaterialUsageRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        MaterialID = json['MaterialID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'MaterialID': MaterialID
    };

    getTypeName() => "MaterialUsageRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'MaterialUsageEntry': TypeInfo(TypeOf.Class, create:() => MaterialUsageEntry()),
    'MaterialUsageResponse': TypeInfo(TypeOf.Class, create:() => MaterialUsageResponse()),
    'List<MaterialUsageEntry>': TypeInfo(TypeOf.Class, create:() => <MaterialUsageEntry>[]),
    'MaterialUsageRequest': TypeInfo(TypeOf.Class, create:() => MaterialUsageRequest()),
});

Dart MaterialUsageRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/Material/{MaterialID}/usage HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Usage":[{"Scope":"String","ProjectID":0,"ProjectName":"String","JobID":0,"JobName":"String","Quantity":0,"UsageDate":"String"}]}