Trendsic Platform Service

<back to all web services

CloseoutListRequest

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

class CloseoutItem implements IConvertible
{
    int? CloseoutItemID;
    String? CloseoutItemUID;
    int? ProjectID;
    String? ItemKey;
    String? Label;
    String? Detail;
    String? Status;
    bool? IsApplicable;
    int? SortOrder;
    DateTime? CompletedAt;
    String? CompletedBy;
    String? CreatedBy;
    DateTime? CreatedAt;
    DateTime? UpdatedAt;

    CloseoutItem({this.CloseoutItemID,this.CloseoutItemUID,this.ProjectID,this.ItemKey,this.Label,this.Detail,this.Status,this.IsApplicable,this.SortOrder,this.CompletedAt,this.CompletedBy,this.CreatedBy,this.CreatedAt,this.UpdatedAt});
    CloseoutItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CloseoutItemID = json['CloseoutItemID'];
        CloseoutItemUID = json['CloseoutItemUID'];
        ProjectID = json['ProjectID'];
        ItemKey = json['ItemKey'];
        Label = json['Label'];
        Detail = json['Detail'];
        Status = json['Status'];
        IsApplicable = json['IsApplicable'];
        SortOrder = json['SortOrder'];
        CompletedAt = JsonConverters.fromJson(json['CompletedAt'],'DateTime',context!);
        CompletedBy = json['CompletedBy'];
        CreatedBy = json['CreatedBy'];
        CreatedAt = JsonConverters.fromJson(json['CreatedAt'],'DateTime',context!);
        UpdatedAt = JsonConverters.fromJson(json['UpdatedAt'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CloseoutItemID': CloseoutItemID,
        'CloseoutItemUID': CloseoutItemUID,
        'ProjectID': ProjectID,
        'ItemKey': ItemKey,
        'Label': Label,
        'Detail': Detail,
        'Status': Status,
        'IsApplicable': IsApplicable,
        'SortOrder': SortOrder,
        'CompletedAt': JsonConverters.toJson(CompletedAt,'DateTime',context!),
        'CompletedBy': CompletedBy,
        'CreatedBy': CreatedBy,
        'CreatedAt': JsonConverters.toJson(CreatedAt,'DateTime',context!),
        'UpdatedAt': JsonConverters.toJson(UpdatedAt,'DateTime',context!)
    };

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

class CloseoutStatus implements IConvertible
{
    int? ProjectID;
    int? TotalItems;
    int? DoneCount;
    int? OutstandingCount;
    bool? AllClear;
    double? RetainageAmount;
    bool? RetainageReleased;
    int? ReleasedPayApplicationID;
    int? ReleasedInvoiceID;
    DateTime? ReleasedAt;

    CloseoutStatus({this.ProjectID,this.TotalItems,this.DoneCount,this.OutstandingCount,this.AllClear,this.RetainageAmount,this.RetainageReleased,this.ReleasedPayApplicationID,this.ReleasedInvoiceID,this.ReleasedAt});
    CloseoutStatus.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ProjectID = json['ProjectID'];
        TotalItems = json['TotalItems'];
        DoneCount = json['DoneCount'];
        OutstandingCount = json['OutstandingCount'];
        AllClear = json['AllClear'];
        RetainageAmount = JsonConverters.toDouble(json['RetainageAmount']);
        RetainageReleased = json['RetainageReleased'];
        ReleasedPayApplicationID = json['ReleasedPayApplicationID'];
        ReleasedInvoiceID = json['ReleasedInvoiceID'];
        ReleasedAt = JsonConverters.fromJson(json['ReleasedAt'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ProjectID': ProjectID,
        'TotalItems': TotalItems,
        'DoneCount': DoneCount,
        'OutstandingCount': OutstandingCount,
        'AllClear': AllClear,
        'RetainageAmount': RetainageAmount,
        'RetainageReleased': RetainageReleased,
        'ReleasedPayApplicationID': ReleasedPayApplicationID,
        'ReleasedInvoiceID': ReleasedInvoiceID,
        'ReleasedAt': JsonConverters.toJson(ReleasedAt,'DateTime',context!)
    };

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

class CloseoutListResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    int? ProjectID;
    List<CloseoutItem>? Items = [];
    CloseoutStatus? Status;

    CloseoutListResponse({this.ResponseStatus,this.ProjectID,this.Items,this.Status});
    CloseoutListResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        ProjectID = json['ProjectID'];
        Items = JsonConverters.fromJson(json['Items'],'List<CloseoutItem>',context!);
        Status = JsonConverters.fromJson(json['Status'],'CloseoutStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'ProjectID': ProjectID,
        'Items': JsonConverters.toJson(Items,'List<CloseoutItem>',context!),
        'Status': JsonConverters.toJson(Status,'CloseoutStatus',context!)
    };

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

class CloseoutListRequest implements IConvertible
{
    int? ProjectID;

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

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

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

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

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

Dart CloseoutListRequest 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/projects/{ProjectID}/closeout 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
		}
	},
	ProjectID: 0,
	Items: 
	[
		{
			CloseoutItemID: 0,
			CloseoutItemUID: 00000000000000000000000000000000,
			ProjectID: 0,
			ItemKey: String,
			Label: String,
			Detail: String,
			Status: String,
			IsApplicable: False,
			SortOrder: 0,
			CompletedAt: 0001-01-01,
			CompletedBy: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01
		}
	],
	Status: 
	{
		ProjectID: 0,
		TotalItems: 0,
		DoneCount: 0,
		OutstandingCount: 0,
		AllClear: False,
		RetainageAmount: 0,
		RetainageReleased: False,
		ReleasedPayApplicationID: 0,
		ReleasedInvoiceID: 0,
		ReleasedAt: 0001-01-01
	}
}