Trendsic Platform Service

<back to all web services

ImportPreviewRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/import/{Type}/preview
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 ImportRowResult() = 
        member val Line:Int32 = new Int32() with get,set
        member val Action:String = null with get,set
        member val Field:String = null with get,set
        member val Message:String = null with get,set
        member val Summary:String = null with get,set

    [<AllowNullLiteral>]
    type ImportResult() = 
        member val ImportType:String = null with get,set
        member val FileName:String = null with get,set
        member val DryRun:Boolean = new Boolean() with get,set
        member val ImportBatchId:Int32 = new Int32() with get,set
        member val TotalRows:Int32 = new Int32() with get,set
        member val NewRows:Int32 = new Int32() with get,set
        member val UpdatedRows:Int32 = new Int32() with get,set
        member val SkippedRows:Int32 = new Int32() with get,set
        member val ErrorRows:Int32 = new Int32() with get,set
        member val Rows:ResizeArray<ImportRowResult> = new ResizeArray<ImportRowResult>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type ImportPreviewRequest() = 
        member val Type:String = null with get,set

F# ImportPreviewRequest 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/import/{Type}/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ImportPreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Type>String</Type>
</ImportPreviewRequest>

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

<ImportResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DryRun>false</DryRun>
  <ErrorRows>0</ErrorRows>
  <FileName>String</FileName>
  <ImportBatchId>0</ImportBatchId>
  <ImportType>String</ImportType>
  <NewRows>0</NewRows>
  <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>
  <Rows>
    <ImportRowResult>
      <Action>String</Action>
      <Field>String</Field>
      <Line>0</Line>
      <Message>String</Message>
      <Summary>String</Summary>
    </ImportRowResult>
  </Rows>
  <SkippedRows>0</SkippedRows>
  <TotalRows>0</TotalRows>
  <UpdatedRows>0</UpdatedRows>
</ImportResult>