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

export class IndustryPack
{
    public PackId: string;
    public Code: string;
    public Name: string;
    public IsActive: boolean;

    public constructor(init?: Partial<IndustryPack>) { (Object as any).assign(this, init); }
}

export class TermOverride
{
    public TermKey: string;
    public Label: string;
    public CreatedBy: string;
    public CreatedAt?: string;
    public UpdatedAt?: string;

    public constructor(init?: Partial<TermOverride>) { (Object as any).assign(this, init); }
}

export class TerminologyAdminResponse
{
    public ResponseStatus: ResponseStatus;
    public Packs: IndustryPack[] = [];
    public SelectedPackId?: string;
    public Terms: { [index:string]: string; } = {};
    public Overrides: TermOverride[] = [];

    public constructor(init?: Partial<TerminologyAdminResponse>) { (Object as any).assign(this, init); }
}

export class TermOverrideRequest
{
    public TermKey: string;
    public Label: string;

    public constructor(init?: Partial<TermOverrideRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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>