Trendsic Platform Service

<back to all web services

HoldsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/holds
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 HoldMatchDto() = 
        member val RecordKey:String = null with get,set
        member val Name:String = null with get,set
        member val Tag:String = null with get,set
        member val Warn:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type LegalHoldDto() = 
        member val HoldId:Int32 = new Int32() with get,set
        member val HoldKey:String = null with get,set
        member val Name:String = null with get,set
        member val Matter:String = null with get,set
        member val ScopeDim:String = null with get,set
        member val ScopeVal:String = null with get,set
        member val ScopeLabel:String = null with get,set
        member val ScopeNote:String = null with get,set
        member val PlacedBy:String = null with get,set
        member val PlacedLabel:String = null with get,set
        member val Released:Boolean = new Boolean() with get,set
        member val ReleasedLabel:String = null with get,set
        member val FrozenJson:String = null with get,set
        member val LogJson:String = null with get,set
        member val Matches:ResizeArray<HoldMatchDto> = new ResizeArray<HoldMatchDto>() with get,set

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

    [<AllowNullLiteral>]
    type HoldsRequest() = 
        class end

F# HoldsRequest 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/records/holds HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<HoldsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Holds>
    <LegalHoldDto>
      <FrozenJson>String</FrozenJson>
      <HoldId>0</HoldId>
      <HoldKey>String</HoldKey>
      <LogJson>String</LogJson>
      <Matches>
        <HoldMatchDto>
          <Name>String</Name>
          <RecordKey>String</RecordKey>
          <Tag>String</Tag>
          <Warn>false</Warn>
        </HoldMatchDto>
      </Matches>
      <Matter>String</Matter>
      <Name>String</Name>
      <PlacedBy>String</PlacedBy>
      <PlacedLabel>String</PlacedLabel>
      <Released>false</Released>
      <ReleasedLabel>String</ReleasedLabel>
      <ScopeDim>String</ScopeDim>
      <ScopeLabel>String</ScopeLabel>
      <ScopeNote>String</ScopeNote>
      <ScopeVal>String</ScopeVal>
    </LegalHoldDto>
  </Holds>
  <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>
</HoldsResponse>