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
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 MaterialUsageEntry() = 
        member val Scope:String = null with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val ProjectName:String = null with get,set
        member val JobID:Int32 = new Int32() with get,set
        member val JobName:String = null with get,set
        member val Quantity:Int32 = new Int32() with get,set
        member val UsageDate:String = null with get,set

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

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

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

GET /v1/Material/{MaterialID}/usage HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MaterialUsageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Usage>
    <MaterialUsageEntry>
      <JobID>0</JobID>
      <JobName>String</JobName>
      <ProjectID>0</ProjectID>
      <ProjectName>String</ProjectName>
      <Quantity>0</Quantity>
      <Scope>String</Scope>
      <UsageDate>String</UsageDate>
    </MaterialUsageEntry>
  </Usage>
</MaterialUsageResponse>