Trendsic Platform Service

<back to all web services

TermOverrideRequest

Requires Authentication
The following routes are available for this service:
POST,DELETE,OPTIONS/v1/terminology/override
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 IndustryPack
            Public Overridable Property PackId As Guid
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property IsActive As Boolean
        End Class

        Public Partial Class TerminologyAdminResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Packs As List(Of IndustryPack) = New List(Of IndustryPack)
            Public Overridable Property SelectedPackId As Guid?
            Public Overridable Property Terms As Dictionary(Of String, String) = New Dictionary(Of String, String)
            Public Overridable Property [Overrides] As List(Of TermOverride) = New List(Of TermOverride)
        End Class

        Public Partial Class TermOverride
            Public Overridable Property TermKey As String
            Public Overridable Property Label As String
            Public Overridable Property CreatedBy As String
            Public Overridable Property CreatedAt As Date?
            Public Overridable Property UpdatedAt As Date?
        End Class

        Public Partial Class TermOverrideRequest
            Public Overridable Property TermKey As String
            Public Overridable Property Label As String
        End Class
    End Namespace
End Namespace

VB.NET TermOverrideRequest 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/terminology/override HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TermOverrideRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Label>String</Label>
  <TermKey>String</TermKey>
</TermOverrideRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TerminologyAdminResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Overrides>
    <TermOverride>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <Label>String</Label>
      <TermKey>String</TermKey>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </TermOverride>
  </Overrides>
  <Packs>
    <IndustryPack>
      <Code>String</Code>
      <IsActive>false</IsActive>
      <Name>String</Name>
      <PackId>00000000-0000-0000-0000-000000000000</PackId>
    </IndustryPack>
  </Packs>
  <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>
  <SelectedPackId>00000000-0000-0000-0000-000000000000</SelectedPackId>
  <Terms xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Terms>
</TerminologyAdminResponse>