Trendsic Platform Service

<back to all web services

MarkupRaiseRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/markup/{AttachmentId}/{VersionNo}/{PageIndex}/shapes/{ShapeId}/{Raise}
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 DocumentMarkupLink() = 
        member val DocumentMarkupLinkID:Int32 = new Int32() with get,set
        member val AttachmentId:Guid = new Guid() with get,set
        member val VersionNo:Int32 = new Int32() with get,set
        member val PageIndex:Int32 = new Int32() with get,set
        member val ShapeId:String = null with get,set
        member val EntityType:String = null with get,set
        member val EntityID:Int32 = new Int32() with get,set
        member val EntityNo:String = null with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type MarkupRaiseResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Link:DocumentMarkupLink = null with get,set
        member val Links:ResizeArray<DocumentMarkupLink> = new ResizeArray<DocumentMarkupLink>() with get,set

    [<AllowNullLiteral>]
    type MarkupRaiseRequest() = 
        member val AttachmentId:Guid = new Guid() with get,set
        member val VersionNo:Int32 = new Int32() with get,set
        member val PageIndex:Int32 = new Int32() with get,set
        member val ShapeId:String = null with get,set
        member val Raise:String = null with get,set
        member val ProjectID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Title:String = null with get,set
        member val Description:String = null with get,set
        member val Area:String = null with get,set
        member val Trade:String = null with get,set
        member val AssignedSub:String = null with get,set
        member val Priority:String = null with get,set
        member val AskedOf:String = null with get,set
        member val Discipline:String = null with get,set
        member val DueDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

F# MarkupRaiseRequest 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/markup/{AttachmentId}/{VersionNo}/{PageIndex}/shapes/{ShapeId}/{Raise} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MarkupRaiseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Area>String</Area>
  <AskedOf>String</AskedOf>
  <AssignedSub>String</AssignedSub>
  <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
  <Description>String</Description>
  <Discipline>String</Discipline>
  <DueDate>0001-01-01T00:00:00</DueDate>
  <PageIndex>0</PageIndex>
  <Priority>String</Priority>
  <ProjectID>0</ProjectID>
  <Raise>String</Raise>
  <ShapeId>String</ShapeId>
  <Title>String</Title>
  <Trade>String</Trade>
  <VersionNo>0</VersionNo>
</MarkupRaiseRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MarkupRaiseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Link>
    <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CreatedBy>String</CreatedBy>
    <DocumentMarkupLinkID>0</DocumentMarkupLinkID>
    <EntityID>0</EntityID>
    <EntityNo>String</EntityNo>
    <EntityType>String</EntityType>
    <PageIndex>0</PageIndex>
    <ShapeId>String</ShapeId>
    <VersionNo>0</VersionNo>
  </Link>
  <Links>
    <DocumentMarkupLink>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <DocumentMarkupLinkID>0</DocumentMarkupLinkID>
      <EntityID>0</EntityID>
      <EntityNo>String</EntityNo>
      <EntityType>String</EntityType>
      <PageIndex>0</PageIndex>
      <ShapeId>String</ShapeId>
      <VersionNo>0</VersionNo>
    </DocumentMarkupLink>
  </Links>
  <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>
</MarkupRaiseResponse>