Trendsic Platform Service

<back to all web services

ProjectMaterialListRequest

Requires Authentication
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Project/Materials/{ProjectID}
GET,POST,PUT,DELETE,OPTIONS/v1/Project/Materials/{ProjectID}/{JobID}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class Material
            Public Overridable Property MaterialID As Integer
            Public Overridable Property MaterialName As String
            Public Overridable Property MaterialTypeID As Short
            Public Overridable Property MaterialStatusID As Byte
            Public Overridable Property Quantity As Integer
            Public Overridable Property Supplier As String
            Public Overridable Property OrderDate As Date
            Public Overridable Property DeliveryDate As Date
            Public Overridable Property OnSiteDate As Date
            Public Overridable Property MaterialLocation As String
            Public Overridable Property Manufacturer As String
            Public Overridable Property SerialNumber As String
            Public Overridable Property BarCode As String
            Public Overridable Property TrackingInfo As String
            Public Overridable Property MaterialDescription As String
            Public Overridable Property Notes As String
            Public Overridable Property ImageURL As String
            Public Overridable Property DetailsURL As String
            Public Overridable Property CreatedByUID As Guid
            Public Overridable Property Active As Boolean
            Public Overridable Property RecordCreatedDate As Date
            Public Overridable Property StatusId As Integer
            Public Overridable Property MaterialTypeName As String
            Public Overridable Property Cost As Double
            Public Overridable Property Projects As List(Of Project) = New List(Of Project)
        End Class

        Public Partial Class Project
            Public Overridable Property ProjectID As Integer
            Public Overridable Property ProjectUID As Guid
            Public Overridable Property ProjectName As String
            Public Overridable Property ImageURL As String
            Public Overridable Property ImageKey As String
            Public Overridable Property ClientName As String
            Public Overridable Property ClientPhone As String
            Public Overridable Property ClientEmail As String
            Public Overridable Property ProjectManagerID As Integer
            Public Overridable Property ProjectManagerName As String
            Public Overridable Property StartDate As Date?
            Public Overridable Property EndDate As Date?
            Public Overridable Property ActualStartDate As Date?
            Public Overridable Property ActualEndDate As Date?
            Public Overridable Property JobCount As Integer
            Public Overridable Property CrewMemberCount As Integer
            Public Overridable Property EquipmentCount As Integer
            Public Overridable Property MaterialCount As Integer
            Public Overridable Property ProjectStatusID As Short
            Public Overridable Property ProjectStatusDescription As String
            Public Overridable Property Budget As Decimal
            Public Overridable Property CostToDate As Decimal
            Public Overridable Property ProjectLocation As String
            Public Overridable Property ProjectType As String
            Public Overridable Property ProjectSponsor As String
            Public Overridable Property CreatedBy As String
            Public Overridable Property CreatedAt As Date?
            Public Overridable Property UpdatedAt As Date?
            Public Overridable Property ProjectDescription As String
            Public Overridable Property Scope As String
            Public Overridable Property StatusId As Integer
        End Class

        Public Partial Class ProjectMaterial
            Inherits Material
            Public Overridable Property ProjectMaterialID As Integer
            Public Overridable Property ProjectID As Integer
            Public Overridable Property ProjectEndDate As Date
            Public Overridable Property MaterialCost As Double
            Public Overridable Property JobID As Integer
            Public Overridable Property BilledMaterialCost As Double
            Public Overridable Property MaterialQty As Integer
        End Class

        Public Partial Class ProjectMaterialListRequest
            Public Overridable Property ProjectID As Integer
            Public Overridable Property JobID As Integer
            Public Overridable Property ProjectMaterials As List(Of Material) = New List(Of Material)
        End Class

        Public Partial Class ProjectMaterialListResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property ProjectMaterials As List(Of ProjectMaterial) = New List(Of ProjectMaterial)
        End Class
    End Namespace
End Namespace

VB.NET ProjectMaterialListRequest 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/Project/Materials/{ProjectID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProjectMaterialListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <JobID>0</JobID>
  <ProjectID>0</ProjectID>
  <ProjectMaterials>
    <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>
      <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>
          <Budget>0</Budget>
          <ClientEmail>String</ClientEmail>
          <ClientName>String</ClientName>
          <ClientPhone>String</ClientPhone>
          <CostToDate>0</CostToDate>
          <CreatedAt>0001-01-01T00:00:00</CreatedAt>
          <CreatedBy>String</CreatedBy>
          <CrewMemberCount>0</CrewMemberCount>
          <EndDate>0001-01-01T00:00:00</EndDate>
          <EquipmentCount>0</EquipmentCount>
          <ImageKey>String</ImageKey>
          <ImageURL>String</ImageURL>
          <JobCount>0</JobCount>
          <MaterialCount>0</MaterialCount>
          <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>
  </ProjectMaterials>
</ProjectMaterialListRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProjectMaterialListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ProjectMaterials>
    <ProjectMaterial>
      <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>
      <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>
          <Budget>0</Budget>
          <ClientEmail>String</ClientEmail>
          <ClientName>String</ClientName>
          <ClientPhone>String</ClientPhone>
          <CostToDate>0</CostToDate>
          <CreatedAt>0001-01-01T00:00:00</CreatedAt>
          <CreatedBy>String</CreatedBy>
          <CrewMemberCount>0</CrewMemberCount>
          <EndDate>0001-01-01T00:00:00</EndDate>
          <EquipmentCount>0</EquipmentCount>
          <ImageKey>String</ImageKey>
          <ImageURL>String</ImageURL>
          <JobCount>0</JobCount>
          <MaterialCount>0</MaterialCount>
          <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>
      <BilledMaterialCost>0</BilledMaterialCost>
      <JobID>0</JobID>
      <MaterialCost>0</MaterialCost>
      <MaterialQty>0</MaterialQty>
      <ProjectEndDate>0001-01-01T00:00:00</ProjectEndDate>
      <ProjectID>0</ProjectID>
      <ProjectMaterialID>0</ProjectMaterialID>
    </ProjectMaterial>
  </ProjectMaterials>
  <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>
</ProjectMaterialListResponse>