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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<MaterialRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Material>
    <Material>
      <Active>false</Active>
      <BarCode>String</BarCode>
      <Cost>0</Cost>
      <CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
      <DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
      <DetailsURL>String</DetailsURL>
      <ImageURL>String</ImageURL>
      <Manufacturer>String</Manufacturer>
      <MaterialDescription>String</MaterialDescription>
      <MaterialID>0</MaterialID>
      <MaterialLocation>String</MaterialLocation>
      <MaterialName>String</MaterialName>
      <MaterialStatusID>0</MaterialStatusID>
      <MaterialStatusName>String</MaterialStatusName>
      <MaterialTypeID>0</MaterialTypeID>
      <MaterialTypeName>String</MaterialTypeName>
      <Notes>String</Notes>
      <OnSiteDate>0001-01-01T00:00:00</OnSiteDate>
      <OrderDate>0001-01-01T00:00:00</OrderDate>
      <Projects>
        <Project>
          <ActualEndDate>0001-01-01T00:00:00</ActualEndDate>
          <ActualStartDate>0001-01-01T00:00:00</ActualStartDate>
          <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
          <BranchName>String</BranchName>
          <Budget>0</Budget>
          <ClientContactID>0</ClientContactID>
          <ClientEmail>String</ClientEmail>
          <ClientName>String</ClientName>
          <ClientPhone>String</ClientPhone>
          <CostToDate>0</CostToDate>
          <CreatedAt>0001-01-01T00:00:00</CreatedAt>
          <CreatedBy>String</CreatedBy>
          <CrewAvatarsJson>String</CrewAvatarsJson>
          <CrewMemberCount>0</CrewMemberCount>
          <CrewNamesSearch>String</CrewNamesSearch>
          <EndDate>0001-01-01T00:00:00</EndDate>
          <EquipmentCount>0</EquipmentCount>
          <ImageKey>String</ImageKey>
          <ImageURL>String</ImageURL>
          <JobCount>0</JobCount>
          <Location>
            <Active>false</Active>
            <Address1>String</Address1>
            <Address2>String</Address2>
            <City>String</City>
            <ClientId>00000000-0000-0000-0000-000000000000</ClientId>
            <Email>String</Email>
            <EntDate>0001-01-01T00:00:00</EntDate>
            <Fax>String</Fax>
            <Id>00000000-0000-0000-0000-000000000000</Id>
            <LocationImage>String</LocationImage>
            <ModDate>0001-01-01T00:00:00</ModDate>
            <Name>String</Name>
            <Phone>String</Phone>
            <State>String</State>
            <TimeZone>String</TimeZone>
            <URL>String</URL>
            <Zip>String</Zip>
          </Location>
          <MaterialCount>0</MaterialCount>
          <NotifyCustomerOnVisitCompletion>false</NotifyCustomerOnVisitCompletion>
          <ProjectDescription>String</ProjectDescription>
          <ProjectID>0</ProjectID>
          <ProjectLocation>String</ProjectLocation>
          <ProjectManagerID>0</ProjectManagerID>
          <ProjectManagerName>String</ProjectManagerName>
          <ProjectName>String</ProjectName>
          <ProjectSponsor>String</ProjectSponsor>
          <ProjectStatusDescription>String</ProjectStatusDescription>
          <ProjectStatusID>0</ProjectStatusID>
          <ProjectType>String</ProjectType>
          <ProjectUID>00000000-0000-0000-0000-000000000000</ProjectUID>
          <Scope>String</Scope>
          <StartDate>0001-01-01T00:00:00</StartDate>
          <StatusId>0</StatusId>
          <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
        </Project>
      </Projects>
      <Quantity>0</Quantity>
      <RecordCreatedDate>0001-01-01T00:00:00</RecordCreatedDate>
      <SerialNumber>String</SerialNumber>
      <StatusId>0</StatusId>
      <Supplier>String</Supplier>
      <TrackingInfo>String</TrackingInfo>
    </Material>
  </Material>
  <MaterialID>0</MaterialID>
</MaterialRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MaterialResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Material>
    <Material>
      <Active>false</Active>
      <BarCode>String</BarCode>
      <Cost>0</Cost>
      <CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
      <DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
      <DetailsURL>String</DetailsURL>
      <ImageURL>String</ImageURL>
      <Manufacturer>String</Manufacturer>
      <MaterialDescription>String</MaterialDescription>
      <MaterialID>0</MaterialID>
      <MaterialLocation>String</MaterialLocation>
      <MaterialName>String</MaterialName>
      <MaterialStatusID>0</MaterialStatusID>
      <MaterialStatusName>String</MaterialStatusName>
      <MaterialTypeID>0</MaterialTypeID>
      <MaterialTypeName>String</MaterialTypeName>
      <Notes>String</Notes>
      <OnSiteDate>0001-01-01T00:00:00</OnSiteDate>
      <OrderDate>0001-01-01T00:00:00</OrderDate>
      <Projects>
        <Project>
          <ActualEndDate>0001-01-01T00:00:00</ActualEndDate>
          <ActualStartDate>0001-01-01T00:00:00</ActualStartDate>
          <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
          <BranchName>String</BranchName>
          <Budget>0</Budget>
          <ClientContactID>0</ClientContactID>
          <ClientEmail>String</ClientEmail>
          <ClientName>String</ClientName>
          <ClientPhone>String</ClientPhone>
          <CostToDate>0</CostToDate>
          <CreatedAt>0001-01-01T00:00:00</CreatedAt>
          <CreatedBy>String</CreatedBy>
          <CrewAvatarsJson>String</CrewAvatarsJson>
          <CrewMemberCount>0</CrewMemberCount>
          <CrewNamesSearch>String</CrewNamesSearch>
          <EndDate>0001-01-01T00:00:00</EndDate>
          <EquipmentCount>0</EquipmentCount>
          <ImageKey>String</ImageKey>
          <ImageURL>String</ImageURL>
          <JobCount>0</JobCount>
          <Location>
            <Active>false</Active>
            <Address1>String</Address1>
            <Address2>String</Address2>
            <City>String</City>
            <ClientId>00000000-0000-0000-0000-000000000000</ClientId>
            <Email>String</Email>
            <EntDate>0001-01-01T00:00:00</EntDate>
            <Fax>String</Fax>
            <Id>00000000-0000-0000-0000-000000000000</Id>
            <LocationImage>String</LocationImage>
            <ModDate>0001-01-01T00:00:00</ModDate>
            <Name>String</Name>
            <Phone>String</Phone>
            <State>String</State>
            <TimeZone>String</TimeZone>
            <URL>String</URL>
            <Zip>String</Zip>
          </Location>
          <MaterialCount>0</MaterialCount>
          <NotifyCustomerOnVisitCompletion>false</NotifyCustomerOnVisitCompletion>
          <ProjectDescription>String</ProjectDescription>
          <ProjectID>0</ProjectID>
          <ProjectLocation>String</ProjectLocation>
          <ProjectManagerID>0</ProjectManagerID>
          <ProjectManagerName>String</ProjectManagerName>
          <ProjectName>String</ProjectName>
          <ProjectSponsor>String</ProjectSponsor>
          <ProjectStatusDescription>String</ProjectStatusDescription>
          <ProjectStatusID>0</ProjectStatusID>
          <ProjectType>String</ProjectType>
          <ProjectUID>00000000-0000-0000-0000-000000000000</ProjectUID>
          <Scope>String</Scope>
          <StartDate>0001-01-01T00:00:00</StartDate>
          <StatusId>0</StatusId>
          <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
        </Project>
      </Projects>
      <Quantity>0</Quantity>
      <RecordCreatedDate>0001-01-01T00:00:00</RecordCreatedDate>
      <SerialNumber>String</SerialNumber>
      <StatusId>0</StatusId>
      <Supplier>String</Supplier>
      <TrackingInfo>String</TrackingInfo>
    </Material>
  </Material>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</MaterialResponse>