PUT v1/themes/{id}

Creates a new theme or updates an existing theme

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique Identifier of the theme to update or create.

string

Required

Body Parameters

An object representing the theme.

Theme
NameDescriptionTypeAdditional information
Id

string

None.

Name

string

None.

FrameBackgroundColor

string

None.

CompanyLogo

string

None.

Logo

string

None.

FrameBackgroundImage

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Name": "sample string 2",
  "FrameBackgroundColor": "sample string 3",
  "CompanyLogo": "sample string 4",
  "Logo": "sample string 5",
  "FrameBackgroundImage": "sample string 6"
}

text/html

Sample:
{"Id":"sample string 1","Name":"sample string 2","FrameBackgroundColor":"sample string 3","CompanyLogo":"sample string 4","Logo":"sample string 5","FrameBackgroundImage":"sample string 6"}

application/xml, text/xml

Sample:
<Theme xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.TaxValidation.Api.Contracts.v1.Models">
  <CompanyLogo>sample string 4</CompanyLogo>
  <FrameBackgroundColor>sample string 3</FrameBackgroundColor>
  <FrameBackgroundImage>sample string 6</FrameBackgroundImage>
  <Id>sample string 1</Id>
  <Logo>sample string 5</Logo>
  <Name>sample string 2</Name>
</Theme>

Response Information

Resource Description

A response containing the new Theme's unique id, or validation errors if the theme could not be created or updated.

ThemePostResponse
NameDescriptionTypeAdditional information
Id

string

None.

Response Codes

  • 200 OK: Theme successfully saved.
  • 400 BadRequest: Data validation failed, see the response body for more information.
  • 401 Unauthorized:
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1"
}

text/html

Sample:
{"Id":"sample string 1"}

application/xml, text/xml

Sample:
<ThemePostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.TaxValidation.Api.Contracts.v1.Responses">
  <Id>sample string 1</Id>
</ThemePostResponse>