Trendsic Platform Service

<back to all web services

MaterialRequest

Requires Authentication
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Material
GET,POST,PUT,DELETE,OPTIONS/v1/Material/{MaterialID}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Location() = 
        member val Id:Guid = new Guid() with get,set
        member val ClientId:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val City:String = null with get,set
        member val State:String = null with get,set
        member val Zip:String = null with get,set
        member val Phone:String = null with get,set
        member val Fax:String = null with get,set
        member val URL:String = null with get,set
        member val Email:String = null with get,set
        member val TimeZone:String = null with get,set
        member val Active:Boolean = new Boolean() with get,set
        member val EntDate:DateTime = new DateTime() with get,set
        member val ModDate:DateTime = new DateTime() with get,set
        member val LocationImage:String = null with get,set

    [<AllowNullLiteral>]
    type Project() = 
        member val ProjectID:Int32 = new Int32() with get,set
        member val ProjectUID:Guid = new Guid() with get,set
        member val ProjectName:String = null with get,set
        member val ImageURL:String = null with get,set
        member val ImageKey:String = null with get,set
        member val ClientName:String = null with get,set
        member val ClientPhone:String = null with get,set
        member val ClientEmail:String = null with get,set
        member val NotifyCustomerOnVisitCompletion:Boolean = new Boolean() with get,set
        member val ClientContactID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ProjectManagerID:Int32 = new Int32() with get,set
        member val ProjectManagerName:String = null with get,set
        member val StartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ActualStartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ActualEndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val JobCount:Int32 = new Int32() with get,set
        member val CrewMemberCount:Int32 = new Int32() with get,set
        member val CrewAvatarsJson:String = null with get,set
        member val CrewNamesSearch:String = null with get,set
        member val EquipmentCount:Int32 = new Int32() with get,set
        member val MaterialCount:Int32 = new Int32() with get,set
        member val ProjectStatusID:Int16 = new Int16() with get,set
        member val ProjectStatusDescription:String = null with get,set
        member val Budget:Decimal = new Decimal() with get,set
        member val CostToDate:Decimal = new Decimal() with get,set
        member val ProjectLocation:String = null with get,set
        member val ProjectType:String = null with get,set
        member val ProjectSponsor:String = null with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ProjectDescription:String = null with get,set
        member val Scope:String = null with get,set
        member val StatusId:Int32 = new Int32() with get,set
        member val BranchId:Guid = new Guid() with get,set
        member val BranchName:String = null with get,set
        member val Location:Location = null with get,set

    [<AllowNullLiteral>]
    type Material() = 
        member val MaterialID:Int32 = new Int32() with get,set
        member val MaterialName:String = null with get,set
        member val MaterialTypeID:Int16 = new Int16() with get,set
        member val MaterialStatusID:Byte = new Byte() with get,set
        member val Quantity:Int32 = new Int32() with get,set
        member val Supplier:String = null with get,set
        member val OrderDate:DateTime = new DateTime() with get,set
        member val DeliveryDate:DateTime = new DateTime() with get,set
        member val OnSiteDate:DateTime = new DateTime() with get,set
        member val MaterialLocation:String = null with get,set
        member val Manufacturer:String = null with get,set
        member val SerialNumber:String = null with get,set
        member val BarCode:String = null with get,set
        member val TrackingInfo:String = null with get,set
        member val MaterialDescription:String = null with get,set
        member val Notes:String = null with get,set
        member val ImageURL:String = null with get,set
        member val DetailsURL:String = null with get,set
        member val CreatedByUID:Guid = new Guid() with get,set
        member val Active:Boolean = new Boolean() with get,set
        member val RecordCreatedDate:DateTime = new DateTime() with get,set
        member val StatusId:Int32 = new Int32() with get,set
        member val MaterialTypeName:String = null with get,set
        member val Cost:Double = new Double() with get,set
        member val MaterialStatusName:String = null with get,set
        member val Projects:ResizeArray<Project> = new ResizeArray<Project>() with get,set

    [<AllowNullLiteral>]
    type MaterialResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Material:ResizeArray<Material> = new ResizeArray<Material>() with get,set

    [<AllowNullLiteral>]
    type MaterialRequest() = 
        member val MaterialID:Int32 = new Int32() with get,set
        member val Material:ResizeArray<Material> = new ResizeArray<Material>() with get,set

F# MaterialRequest 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.

POST /v1/Material HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	MaterialID: 0,
	Material: 
	[
		{
			MaterialID: 0,
			MaterialName: String,
			MaterialTypeID: 0,
			MaterialStatusID: 0,
			Quantity: 0,
			Supplier: String,
			OrderDate: 0001-01-01,
			DeliveryDate: 0001-01-01,
			OnSiteDate: 0001-01-01,
			MaterialLocation: String,
			Manufacturer: String,
			SerialNumber: String,
			BarCode: String,
			TrackingInfo: String,
			MaterialDescription: String,
			Notes: String,
			ImageURL: String,
			DetailsURL: String,
			CreatedByUID: 00000000000000000000000000000000,
			Active: False,
			RecordCreatedDate: 0001-01-01,
			StatusId: 0,
			MaterialTypeName: String,
			Cost: 0,
			MaterialStatusName: String,
			Projects: 
			[
				{
					ProjectID: 0,
					ProjectUID: 00000000000000000000000000000000,
					ProjectName: String,
					ImageURL: String,
					ImageKey: String,
					ClientName: String,
					ClientPhone: String,
					ClientEmail: String,
					NotifyCustomerOnVisitCompletion: False,
					ClientContactID: 0,
					ProjectManagerID: 0,
					ProjectManagerName: String,
					StartDate: 0001-01-01,
					EndDate: 0001-01-01,
					ActualStartDate: 0001-01-01,
					ActualEndDate: 0001-01-01,
					JobCount: 0,
					CrewMemberCount: 0,
					CrewAvatarsJson: String,
					CrewNamesSearch: String,
					EquipmentCount: 0,
					MaterialCount: 0,
					ProjectStatusID: 0,
					ProjectStatusDescription: String,
					Budget: 0,
					CostToDate: 0,
					ProjectLocation: String,
					ProjectType: String,
					ProjectSponsor: String,
					CreatedBy: String,
					CreatedAt: 0001-01-01,
					UpdatedAt: 0001-01-01,
					ProjectDescription: String,
					Scope: String,
					StatusId: 0,
					BranchId: 00000000000000000000000000000000,
					BranchName: String,
					Location: 
					{
						Id: 00000000000000000000000000000000,
						ClientId: 00000000000000000000000000000000,
						Name: String,
						Address1: String,
						Address2: String,
						City: String,
						State: String,
						Zip: String,
						Phone: String,
						Fax: String,
						URL: String,
						Email: String,
						TimeZone: String,
						Active: False,
						EntDate: 0001-01-01,
						ModDate: 0001-01-01,
						LocationImage: 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
		}
	},
	Material: 
	[
		{
			MaterialID: 0,
			MaterialName: String,
			MaterialTypeID: 0,
			MaterialStatusID: 0,
			Quantity: 0,
			Supplier: String,
			OrderDate: 0001-01-01,
			DeliveryDate: 0001-01-01,
			OnSiteDate: 0001-01-01,
			MaterialLocation: String,
			Manufacturer: String,
			SerialNumber: String,
			BarCode: String,
			TrackingInfo: String,
			MaterialDescription: String,
			Notes: String,
			ImageURL: String,
			DetailsURL: String,
			CreatedByUID: 00000000000000000000000000000000,
			Active: False,
			RecordCreatedDate: 0001-01-01,
			StatusId: 0,
			MaterialTypeName: String,
			Cost: 0,
			MaterialStatusName: String,
			Projects: 
			[
				{
					ProjectID: 0,
					ProjectUID: 00000000000000000000000000000000,
					ProjectName: String,
					ImageURL: String,
					ImageKey: String,
					ClientName: String,
					ClientPhone: String,
					ClientEmail: String,
					NotifyCustomerOnVisitCompletion: False,
					ClientContactID: 0,
					ProjectManagerID: 0,
					ProjectManagerName: String,
					StartDate: 0001-01-01,
					EndDate: 0001-01-01,
					ActualStartDate: 0001-01-01,
					ActualEndDate: 0001-01-01,
					JobCount: 0,
					CrewMemberCount: 0,
					CrewAvatarsJson: String,
					CrewNamesSearch: String,
					EquipmentCount: 0,
					MaterialCount: 0,
					ProjectStatusID: 0,
					ProjectStatusDescription: String,
					Budget: 0,
					CostToDate: 0,
					ProjectLocation: String,
					ProjectType: String,
					ProjectSponsor: String,
					CreatedBy: String,
					CreatedAt: 0001-01-01,
					UpdatedAt: 0001-01-01,
					ProjectDescription: String,
					Scope: String,
					StatusId: 0,
					BranchId: 00000000000000000000000000000000,
					BranchName: String,
					Location: 
					{
						Id: 00000000000000000000000000000000,
						ClientId: 00000000000000000000000000000000,
						Name: String,
						Address1: String,
						Address2: String,
						City: String,
						State: String,
						Zip: String,
						Phone: String,
						Fax: String,
						URL: String,
						Email: String,
						TimeZone: String,
						Active: False,
						EntDate: 0001-01-01,
						ModDate: 0001-01-01,
						LocationImage: String
					}
				}
			]
		}
	]
}