Jump to

• Request
• Response

getAgentTheme

get

/ccadmin/v1/themes/agentThemeDetails

Returns the agent theme.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getTheme_response

Type: object

Show Source

• clone_parent_id(optional): string
  Clone parent id of the theme.
• clone_parent_name(optional): string
  Clone parent name of the theme.
• id(optional): string
  ID of the theme.
• is_active(optional): boolean
  Whether theme is active.
• is_custom(optional): boolean
  Whether theme is custom or not.
• name(optional): string
  Theme name.
• notes(optional): string
  Notes of the theme.
• repositoryId(optional): string
  Repository Id of the theme.
• theme_styles_color(optional): object theme_styles_color
  Color information of theme styles.
• theme_styles_general(optional): object theme_styles_general
  General information of theme styles.
• theme_styles_typography(optional): object theme_styles_typography
  Typography information of theme styles.
• thumbnail(optional): string
  Thumbnail image of the theme.
• usingCodeView(optional): boolean
  Whether using code view or not.

{
    "properties":{
        "thumbnail":{
            "description":"Thumbnail image of the theme.",
            "type":"string"
        },
        "is_active":{
            "description":"Whether theme is active.",
            "type":"boolean"
        },
        "notes":{
            "description":"Notes of the theme.",
            "type":"string"
        },
        "theme_styles_color":{
            "description":"Color information of theme styles.",
            "type":"object",
            "properties":{
                "@ButtonSecondaryTextDecoration":{
                    "description":"Button Secondary Text Decoration",
                    "type":"string"
                },
                "@ButtonPrimarySize":{
                    "description":"Button Primary Size",
                    "type":"string"
                },
                "@ButtonPrimaryTextColor":{
                    "description":"",
                    "type":"string"
                },
                "@SubNavigationTextColor":{
                    "description":"Sub Navigation Text Color",
                    "type":"string"
                },
                "@ButtonPrimaryUseGradient":{
                    "description":"Button Primary Use Gradient",
                    "type":"string"
                },
                "@ButtonPrimaryFontStyle":{
                    "description":"Button Primary Font Style",
                    "type":"string"
                },
                "@ButtonSecondaryFontFamily":{
                    "description":"Button Secondary Font Family",
                    "type":"string"
                },
                "@NavbarLinkColor":{
                    "description":"Navbar Link Color",
                    "type":"string"
                },
                "@ButtonPrimaryFontWeight":{
                    "description":"Button Primary Font Weight",
                    "type":"string"
                },
                "@NavbarTextColor":{
                    "description":"Navbar Text Color",
                    "type":"string"
                },
                "@NavbarLinkHoverColor":{
                    "description":"Navbar Link Hover Color",
                    "type":"string"
                },
                "@mobileNavBarButtonColor":{
                    "description":"mobile NavBar Button Color",
                    "type":"string"
                },
                "@SubNavigationLinkHoverColor":{
                    "description":"Sub Navigation Link Hover Color",
                    "type":"string"
                },
                "@NavbarBackgroundHoverColor":{
                    "description":"Navbar Background Hover Color",
                    "type":"string"
                },
                "@ButtonSecondaryUseGradient":{
                    "description":"Button Secondary Use Gradient",
                    "type":"string"
                },
                "@LinkVisitedColor":{
                    "description":"Link Visited Color",
                    "type":"string"
                },
                "@LinkColor":{
                    "description":"Link Color",
                    "type":"string"
                },
                "@ButtonPrimaryBackgroundColor":{
                    "description":"Button Primary Background Color",
                    "type":"string"
                },
                "@NavbarBackgroundColor":{
                    "description":"Navbar Background Color",
                    "type":"string"
                },
                "@SubNavigationLinkColor":{
                    "description":"Sub Navigation Link Color",
                    "type":"string"
                },
                "@ButtonPrimaryFontFamily":{
                    "description":"Button Primary Font Family",
                    "type":"string"
                },
                "@ButtonPrimaryTextDecoration":{
                    "description":"Button Primary Text Decoration",
                    "type":"string"
                },
                "@ButtonSecondaryBorderRadius":{
                    "description":"Button Secondary Border Radius",
                    "type":"string"
                },
                "@ButtonSecondaryFontStyle":{
                    "description":"Button Secondary Font Style",
                    "type":"string"
                },
                "@ButtonSecondaryTextColor":{
                    "description":"Button Secondary Text Color",
                    "type":"string"
                },
                "@SubNavigationBackgroundColor":{
                    "description":"Sub Navigation Background Color",
                    "type":"string"
                },
                "@ButtonSecondaryFontWeight":{
                    "description":"Button Secondary Font Weight",
                    "type":"string"
                },
                "@ButtonSecondaryBackgroundColor":{
                    "description":"Button Secondary Background Color",
                    "type":"string"
                },
                "@ButtonPrimaryBorderRadius":{
                    "description":"Button Primary Border Radius",
                    "type":"string"
                },
                "@LinkHoverColor":{
                    "description":"Link Hover Color",
                    "type":"string"
                },
                "@SubNavigationBackgroundHoverColor":{
                    "description":"Sub Navigation Background Hover Color",
                    "type":"string"
                },
                "@ButtonSecondarySize":{
                    "description":"Button Secondary Size",
                    "type":"string"
                },
                "@TextColor":{
                    "description":"Text Color",
                    "type":"string"
                }
            }
        },
        "usingCodeView":{
            "description":"Whether using code view or not.",
            "type":"boolean"
        },
        "theme_styles_typography":{
            "description":"Typography information of theme styles.",
            "type":"object",
            "properties":{
                "@H6LineHeight":{
                    "description":"Heading 6 Line Height",
                    "type":"string"
                },
                "@H5TextDecoration":{
                    "description":"Heading 5 Text Decoration",
                    "type":"string"
                },
                "@H3FontFamily":{
                    "description":"Heading 3 Font Family",
                    "type":"string"
                },
                "@H5FontStyle":{
                    "description":"Heading 5 Font Style",
                    "type":"string"
                },
                "@H2FontStyle":{
                    "description":"Heading 2 Font Style",
                    "type":"string"
                },
                "@H2TextColor":{
                    "description":"Heading 2 Text Color",
                    "type":"string"
                },
                "@SiteLineHeight":{
                    "description":"Site Line Height",
                    "type":"string"
                },
                "@H1TextAlign":{
                    "description":"Heading 1 Text Align",
                    "type":"string"
                },
                "@SiteFontFamily":{
                    "description":"Site Font Family",
                    "type":"string"
                },
                "@ParagraphFontWeight":{
                    "description":"Paragraph Font Weight",
                    "type":"string"
                },
                "@H5FontSize":{
                    "description":"Heading 5 Font Size",
                    "type":"string"
                },
                "@H4TextAlign":{
                    "description":"Heading 4 Text Align",
                    "type":"string"
                },
                "@H1TextDecoration":{
                    "description":"Heading 1 Text Decoration",
                    "type":"string"
                },
                "@H3LineHeight":{
                    "description":"Heading 3 Line Height",
                    "type":"string"
                },
                "@H2FontWeight":{
                    "description":"Heading 2 Font Weight",
                    "type":"string"
                },
                "@H3FontSize":{
                    "description":"Heading 3 Font Size",
                    "type":"string"
                },
                "@ParagraphLineHeight":{
                    "description":"Paragraph Line Height",
                    "type":"string"
                },
                "@H3TextAlign":{
                    "description":"Heading 3 Text Align",
                    "type":"string"
                },
                "@H3TextColor":{
                    "description":"Heading 3 Text Color",
                    "type":"string"
                },
                "@H4FontFamily":{
                    "description":"Heading 4 Font Family",
                    "type":"string"
                },
                "@SiteFontSize":{
                    "description":"Site Font Size",
                    "type":"string"
                },
                "@SiteTextAlign":{
                    "description":"Site Text Align",
                    "type":"string"
                },
                "@H5FontWeight":{
                    "description":"Heading 5 Font Weight",
                    "type":"string"
                },
                "@H6FontFamily":{
                    "description":"Heading 6 Font Family",
                    "type":"string"
                },
                "@H1FontSize":{
                    "description":"Heading 1 Font Size",
                    "type":"string"
                },
                "@H6FontStyle":{
                    "description":"Heading 6 Font Style",
                    "type":"string"
                },
                "@H6TextDecoration":{
                    "description":"Heading 6 Text Decoration",
                    "type":"string"
                },
                "@H2TextDecoration":{
                    "description":"Heading 2 Text Decoration",
                    "type":"string"
                },
                "@ParagraphTextColor":{
                    "description":"Paragraph Text Color",
                    "type":"string"
                },
                "@H1FontStyle":{
                    "description":"Heading 1 Font Style",
                    "type":"string"
                },
                "@ParagraphTextAlign":{
                    "description":"Paragraph Text Align",
                    "type":"string"
                },
                "@H4LineHeight":{
                    "description":"Heading 4 Line Height",
                    "type":"string"
                },
                "@H1FontWeight":{
                    "description":"Heading 1 Font Weight",
                    "type":"string"
                },
                "@SiteTextColor":{
                    "description":"Site Text Color",
                    "type":"string"
                },
                "@ParagraphFontSize":{
                    "description":"Paragraph Font Size",
                    "type":"string"
                },
                "@H5FontFamily":{
                    "description":"Heading 5 Font Family",
                    "type":"string"
                },
                "@H4FontWeight":{
                    "description":"Heading 4 Font Weight",
                    "type":"string"
                },
                "@ParagraphFontFamily":{
                    "description":"Paragraph Font Family",
                    "type":"string"
                },
                "@H1FontFamily":{
                    "description":"Heading 1 Font Family",
                    "type":"string"
                },
                "@H2TextAlign":{
                    "description":"Heading 2 Text Align",
                    "type":"string"
                },
                "@H1LineHeight":{
                    "description":"Heading 1 Line Height",
                    "type":"string"
                },
                "@H6FontSize":{
                    "description":"Heading 6 Font Size",
                    "type":"string"
                },
                "@H3TextDecoration":{
                    "description":"Heading 3 Text Decoration",
                    "type":"string"
                },
                "@H4TextColor":{
                    "description":"Heading 4 Text Color",
                    "type":"string"
                },
                "@ParagraphFontStyle":{
                    "description":"Paragraph Font Style",
                    "type":"string"
                },
                "@ParagraphTextDecoration":{
                    "description":"Paragraph Text Decoration",
                    "type":"string"
                },
                "@H1TextColor":{
                    "description":"Heading 1 Text Color",
                    "type":"string"
                },
                "@H4FontSize":{
                    "description":"Heading 4 Font Size",
                    "type":"string"
                },
                "@SiteTextDecoration":{
                    "description":"Site Text Decoration",
                    "type":"string"
                },
                "@SiteFontStyle":{
                    "description":"Site Font Style",
                    "type":"string"
                },
                "@H3FontWeight":{
                    "description":"Heading 3 Font Weight",
                    "type":"string"
                },
                "@H6TextAlign":{
                    "description":"Heading 6 Text Align",
                    "type":"string"
                },
                "@H4TextDecoration":{
                    "description":"Heading 4 Text Decoration",
                    "type":"string"
                },
                "@H2FontFamily":{
                    "description":"Heading 2 Font Family",
                    "type":"string"
                },
                "@H3FontStyle":{
                    "description":"Heading 3 Font Style",
                    "type":"string"
                },
                "@SiteFontWeight":{
                    "description":"Site Font Weight",
                    "type":"string"
                },
                "@H5LineHeight":{
                    "description":"Heading 5 Line Height",
                    "type":"string"
                },
                "@H2FontSize":{
                    "description":"Heading 2 Font Size",
                    "type":"string"
                },
                "@H6TextColor":{
                    "description":"Heading 6 Text Color",
                    "type":"string"
                },
                "@H4FontStyle":{
                    "description":"Heading 4 Font Style",
                    "type":"string"
                },
                "@H2LineHeight":{
                    "description":"Heading 2 Line Height",
                    "type":"string"
                },
                "@H5TextAlign":{
                    "description":"Heading 5 Text Align",
                    "type":"string"
                },
                "@H5TextColor":{
                    "description":"Heading 5 Text Color",
                    "type":"string"
                },
                "@H6FontWeight":{
                    "description":"Heading 6 Font Weight",
                    "type":"string"
                }
            }
        },
        "clone_parent_name":{
            "description":"Clone parent name of the theme.",
            "type":"string"
        },
        "name":{
            "description":"Theme name.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository Id of the theme.",
            "type":"string"
        },
        "is_custom":{
            "description":"Whether theme is custom or not.",
            "type":"boolean"
        },
        "id":{
            "description":"ID of the theme.",
            "type":"string"
        },
        "theme_styles_general":{
            "description":"General information of theme styles.",
            "type":"object",
            "properties":{
                "@FooterBorderTopColor":{
                    "description":"Footer Border Top Color",
                    "type":"string"
                },
                "@SiteBackgroundImageAttachment":{
                    "description":"Site Background Image Attachment",
                    "type":"string"
                },
                "@FooterBackgroundImageAttachment":{
                    "description":"Footer Background Image Attachment",
                    "type":"string"
                },
                "@SiteBackgroundImageURL":{
                    "description":"Site Background Image URL",
                    "type":"string"
                },
                "@HeaderBackgroundUseGradient":{
                    "description":"Header Background Use Gradient",
                    "type":"string"
                },
                "@HeaderTopBackgroundImageAttachment":{
                    "description":"Header Top Background Image Attachment",
                    "type":"string"
                },
                "@SiteBackgroundColorBottom":{
                    "description":"Site Background Color Bottom",
                    "type":"string"
                },
                "@HeaderTopBackgroundImagePosition":{
                    "description":"Header Top Background Image Position",
                    "type":"string"
                },
                "@HeaderTopBackgroundImageRepeat":{
                    "description":"Header Top Background Image Repeat",
                    "type":"string"
                },
                "@FooterBackgroundColorBottom":{
                    "description":"Footer Background Color Bottom",
                    "type":"string"
                },
                "@HeaderTopPaddingTop":{
                    "description":"Header Top Padding Top",
                    "type":"string"
                },
                "@HeaderTopBackgroundColorTop":{
                    "description":"Header Top Background Color Top",
                    "type":"string"
                },
                "@HeaderBackgroundColorTop":{
                    "description":"Header Background Color Top",
                    "type":"string"
                },
                "@HeaderTopBackgroundColor":{
                    "description":"Header Top Background Color",
                    "type":"string"
                },
                "@HeaderBackgroundImageAttachment":{
                    "description":"Header Background Image Attachment",
                    "type":"string"
                },
                "@FooterBackgroundImageURL":{
                    "description":"Footer Background Image URL",
                    "type":"string"
                },
                "@FooterBackgroundImageRepeat":{
                    "description":"Footer Background Image Repeat",
                    "type":"string"
                },
                "@HeaderBackgroundImageRepeat":{
                    "description":"Header Background Image Repeat",
                    "type":"string"
                },
                "@SiteBackgroundImagePosition":{
                    "description":"Site Background Image Position",
                    "type":"string"
                },
                "@SiteBackgroundImageRepeat":{
                    "description":"Site Background Image Repeat",
                    "type":"string"
                },
                "@FooterBackgroundUseGradient":{
                    "description":"Footer Background Use Gradient",
                    "type":"string"
                },
                "@SiteBackgroundColorTop":{
                    "description":"Site Background Color Top",
                    "type":"string"
                },
                "@HeaderTopBackgroundUseGradient":{
                    "description":"Header Top Background Use Gradient",
                    "type":"string"
                },
                "@HeaderBackgroundColorBottom":{
                    "description":"Header Background Color Bottom",
                    "type":"string"
                },
                "@HeaderTopBackgroundColorBottom":{
                    "description":"Header Top Background Color Bottom",
                    "type":"string"
                },
                "@HeaderBackgroundImagePosition":{
                    "description":"Header Background Image Position",
                    "type":"string"
                },
                "@SitePageBackgroundColor":{
                    "description":"Site Page Background Color",
                    "type":"string"
                },
                "@HeaderTopBackgroundImageURL":{
                    "description":"Header Top Background Image URL",
                    "type":"string"
                },
                "@FooterBackgroundColorTop":{
                    "description":"Footer Background Color Top",
                    "type":"string"
                },
                "@HeaderTopBorderBottomColor":{
                    "description":"Header Top Border Bottom Color",
                    "type":"string"
                },
                "@HeaderBackgroundColor":{
                    "description":"Header Background Color",
                    "type":"string"
                },
                "@HeaderBackgroundImageURL":{
                    "description":"Header Background Image URL",
                    "type":"string"
                },
                "@FooterBackgroundColor":{
                    "description":"Footer Background Color",
                    "type":"string"
                },
                "@SiteBackgroundColor":{
                    "description":"Site Background Color",
                    "type":"string"
                },
                "@SiteBackgroundUseGradient":{
                    "description":"Site Background Use Gradient",
                    "type":"string"
                },
                "@FooterBackgroundImagePosition":{
                    "description":"Footer Background Image Position",
                    "type":"string"
                }
            }
        },
        "clone_parent_id":{
            "description":"Clone parent id of the theme.",
            "type":"string"
        }
    }
}

Nested Schema : theme_styles_color

Type: object

Color information of theme styles.

Show Source

• @ButtonPrimaryBackgroundColor(optional): string
  Button Primary Background Color
• @ButtonPrimaryBorderRadius(optional): string
  Button Primary Border Radius
• @ButtonPrimaryFontFamily(optional): string
  Button Primary Font Family
• @ButtonPrimaryFontStyle(optional): string
  Button Primary Font Style
• @ButtonPrimaryFontWeight(optional): string
  Button Primary Font Weight
• @ButtonPrimarySize(optional): string
  Button Primary Size
• @ButtonPrimaryTextColor(optional): string
• @ButtonPrimaryTextDecoration(optional): string
  Button Primary Text Decoration
• @ButtonPrimaryUseGradient(optional): string
  Button Primary Use Gradient
• @ButtonSecondaryBackgroundColor(optional): string
  Button Secondary Background Color
• @ButtonSecondaryBorderRadius(optional): string
  Button Secondary Border Radius
• @ButtonSecondaryFontFamily(optional): string
  Button Secondary Font Family
• @ButtonSecondaryFontStyle(optional): string
  Button Secondary Font Style
• @ButtonSecondaryFontWeight(optional): string
  Button Secondary Font Weight
• @ButtonSecondarySize(optional): string
  Button Secondary Size
• @ButtonSecondaryTextColor(optional): string
  Button Secondary Text Color
• @ButtonSecondaryTextDecoration(optional): string
  Button Secondary Text Decoration
• @ButtonSecondaryUseGradient(optional): string
  Button Secondary Use Gradient
• @LinkColor(optional): string
  Link Color
• @LinkHoverColor(optional): string
  Link Hover Color
• @LinkVisitedColor(optional): string
  Link Visited Color
• @mobileNavBarButtonColor(optional): string
  mobile NavBar Button Color
• @NavbarBackgroundColor(optional): string
  Navbar Background Color
• @NavbarBackgroundHoverColor(optional): string
  Navbar Background Hover Color
• @NavbarLinkColor(optional): string
  Navbar Link Color
• @NavbarLinkHoverColor(optional): string
  Navbar Link Hover Color
• @NavbarTextColor(optional): string
  Navbar Text Color
• @SubNavigationBackgroundColor(optional): string
  Sub Navigation Background Color
• @SubNavigationBackgroundHoverColor(optional): string
  Sub Navigation Background Hover Color
• @SubNavigationLinkColor(optional): string
  Sub Navigation Link Color
• @SubNavigationLinkHoverColor(optional): string
  Sub Navigation Link Hover Color
• @SubNavigationTextColor(optional): string
  Sub Navigation Text Color
• @TextColor(optional): string
  Text Color

{
    "description":"Color information of theme styles.",
    "type":"object",
    "properties":{
        "@ButtonSecondaryTextDecoration":{
            "description":"Button Secondary Text Decoration",
            "type":"string"
        },
        "@ButtonPrimarySize":{
            "description":"Button Primary Size",
            "type":"string"
        },
        "@ButtonPrimaryTextColor":{
            "description":"",
            "type":"string"
        },
        "@SubNavigationTextColor":{
            "description":"Sub Navigation Text Color",
            "type":"string"
        },
        "@ButtonPrimaryUseGradient":{
            "description":"Button Primary Use Gradient",
            "type":"string"
        },
        "@ButtonPrimaryFontStyle":{
            "description":"Button Primary Font Style",
            "type":"string"
        },
        "@ButtonSecondaryFontFamily":{
            "description":"Button Secondary Font Family",
            "type":"string"
        },
        "@NavbarLinkColor":{
            "description":"Navbar Link Color",
            "type":"string"
        },
        "@ButtonPrimaryFontWeight":{
            "description":"Button Primary Font Weight",
            "type":"string"
        },
        "@NavbarTextColor":{
            "description":"Navbar Text Color",
            "type":"string"
        },
        "@NavbarLinkHoverColor":{
            "description":"Navbar Link Hover Color",
            "type":"string"
        },
        "@mobileNavBarButtonColor":{
            "description":"mobile NavBar Button Color",
            "type":"string"
        },
        "@SubNavigationLinkHoverColor":{
            "description":"Sub Navigation Link Hover Color",
            "type":"string"
        },
        "@NavbarBackgroundHoverColor":{
            "description":"Navbar Background Hover Color",
            "type":"string"
        },
        "@ButtonSecondaryUseGradient":{
            "description":"Button Secondary Use Gradient",
            "type":"string"
        },
        "@LinkVisitedColor":{
            "description":"Link Visited Color",
            "type":"string"
        },
        "@LinkColor":{
            "description":"Link Color",
            "type":"string"
        },
        "@ButtonPrimaryBackgroundColor":{
            "description":"Button Primary Background Color",
            "type":"string"
        },
        "@NavbarBackgroundColor":{
            "description":"Navbar Background Color",
            "type":"string"
        },
        "@SubNavigationLinkColor":{
            "description":"Sub Navigation Link Color",
            "type":"string"
        },
        "@ButtonPrimaryFontFamily":{
            "description":"Button Primary Font Family",
            "type":"string"
        },
        "@ButtonPrimaryTextDecoration":{
            "description":"Button Primary Text Decoration",
            "type":"string"
        },
        "@ButtonSecondaryBorderRadius":{
            "description":"Button Secondary Border Radius",
            "type":"string"
        },
        "@ButtonSecondaryFontStyle":{
            "description":"Button Secondary Font Style",
            "type":"string"
        },
        "@ButtonSecondaryTextColor":{
            "description":"Button Secondary Text Color",
            "type":"string"
        },
        "@SubNavigationBackgroundColor":{
            "description":"Sub Navigation Background Color",
            "type":"string"
        },
        "@ButtonSecondaryFontWeight":{
            "description":"Button Secondary Font Weight",
            "type":"string"
        },
        "@ButtonSecondaryBackgroundColor":{
            "description":"Button Secondary Background Color",
            "type":"string"
        },
        "@ButtonPrimaryBorderRadius":{
            "description":"Button Primary Border Radius",
            "type":"string"
        },
        "@LinkHoverColor":{
            "description":"Link Hover Color",
            "type":"string"
        },
        "@SubNavigationBackgroundHoverColor":{
            "description":"Sub Navigation Background Hover Color",
            "type":"string"
        },
        "@ButtonSecondarySize":{
            "description":"Button Secondary Size",
            "type":"string"
        },
        "@TextColor":{
            "description":"Text Color",
            "type":"string"
        }
    }
}

Nested Schema : theme_styles_general

Type: object

General information of theme styles.

Show Source

• @FooterBackgroundColor(optional): string
  Footer Background Color
• @FooterBackgroundColorBottom(optional): string
  Footer Background Color Bottom
• @FooterBackgroundColorTop(optional): string
  Footer Background Color Top
• @FooterBackgroundImageAttachment(optional): string
  Footer Background Image Attachment
• @FooterBackgroundImagePosition(optional): string
  Footer Background Image Position
• @FooterBackgroundImageRepeat(optional): string
  Footer Background Image Repeat
• @FooterBackgroundImageURL(optional): string
  Footer Background Image URL
• @FooterBackgroundUseGradient(optional): string
  Footer Background Use Gradient
• @FooterBorderTopColor(optional): string
  Footer Border Top Color
• @HeaderBackgroundColor(optional): string
  Header Background Color
• @HeaderBackgroundColorBottom(optional): string
  Header Background Color Bottom
• @HeaderBackgroundColorTop(optional): string
  Header Background Color Top
• @HeaderBackgroundImageAttachment(optional): string
  Header Background Image Attachment
• @HeaderBackgroundImagePosition(optional): string
  Header Background Image Position
• @HeaderBackgroundImageRepeat(optional): string
  Header Background Image Repeat
• @HeaderBackgroundImageURL(optional): string
  Header Background Image URL
• @HeaderBackgroundUseGradient(optional): string
  Header Background Use Gradient
• @HeaderTopBackgroundColor(optional): string
  Header Top Background Color
• @HeaderTopBackgroundColorBottom(optional): string
  Header Top Background Color Bottom
• @HeaderTopBackgroundColorTop(optional): string
  Header Top Background Color Top
• @HeaderTopBackgroundImageAttachment(optional): string
  Header Top Background Image Attachment
• @HeaderTopBackgroundImagePosition(optional): string
  Header Top Background Image Position
• @HeaderTopBackgroundImageRepeat(optional): string
  Header Top Background Image Repeat
• @HeaderTopBackgroundImageURL(optional): string
  Header Top Background Image URL
• @HeaderTopBackgroundUseGradient(optional): string
  Header Top Background Use Gradient
• @HeaderTopBorderBottomColor(optional): string
  Header Top Border Bottom Color
• @HeaderTopPaddingTop(optional): string
  Header Top Padding Top
• @SiteBackgroundColor(optional): string
  Site Background Color
• @SiteBackgroundColorBottom(optional): string
  Site Background Color Bottom
• @SiteBackgroundColorTop(optional): string
  Site Background Color Top
• @SiteBackgroundImageAttachment(optional): string
  Site Background Image Attachment
• @SiteBackgroundImagePosition(optional): string
  Site Background Image Position
• @SiteBackgroundImageRepeat(optional): string
  Site Background Image Repeat
• @SiteBackgroundImageURL(optional): string
  Site Background Image URL
• @SiteBackgroundUseGradient(optional): string
  Site Background Use Gradient
• @SitePageBackgroundColor(optional): string
  Site Page Background Color

{
    "description":"General information of theme styles.",
    "type":"object",
    "properties":{
        "@FooterBorderTopColor":{
            "description":"Footer Border Top Color",
            "type":"string"
        },
        "@SiteBackgroundImageAttachment":{
            "description":"Site Background Image Attachment",
            "type":"string"
        },
        "@FooterBackgroundImageAttachment":{
            "description":"Footer Background Image Attachment",
            "type":"string"
        },
        "@SiteBackgroundImageURL":{
            "description":"Site Background Image URL",
            "type":"string"
        },
        "@HeaderBackgroundUseGradient":{
            "description":"Header Background Use Gradient",
            "type":"string"
        },
        "@HeaderTopBackgroundImageAttachment":{
            "description":"Header Top Background Image Attachment",
            "type":"string"
        },
        "@SiteBackgroundColorBottom":{
            "description":"Site Background Color Bottom",
            "type":"string"
        },
        "@HeaderTopBackgroundImagePosition":{
            "description":"Header Top Background Image Position",
            "type":"string"
        },
        "@HeaderTopBackgroundImageRepeat":{
            "description":"Header Top Background Image Repeat",
            "type":"string"
        },
        "@FooterBackgroundColorBottom":{
            "description":"Footer Background Color Bottom",
            "type":"string"
        },
        "@HeaderTopPaddingTop":{
            "description":"Header Top Padding Top",
            "type":"string"
        },
        "@HeaderTopBackgroundColorTop":{
            "description":"Header Top Background Color Top",
            "type":"string"
        },
        "@HeaderBackgroundColorTop":{
            "description":"Header Background Color Top",
            "type":"string"
        },
        "@HeaderTopBackgroundColor":{
            "description":"Header Top Background Color",
            "type":"string"
        },
        "@HeaderBackgroundImageAttachment":{
            "description":"Header Background Image Attachment",
            "type":"string"
        },
        "@FooterBackgroundImageURL":{
            "description":"Footer Background Image URL",
            "type":"string"
        },
        "@FooterBackgroundImageRepeat":{
            "description":"Footer Background Image Repeat",
            "type":"string"
        },
        "@HeaderBackgroundImageRepeat":{
            "description":"Header Background Image Repeat",
            "type":"string"
        },
        "@SiteBackgroundImagePosition":{
            "description":"Site Background Image Position",
            "type":"string"
        },
        "@SiteBackgroundImageRepeat":{
            "description":"Site Background Image Repeat",
            "type":"string"
        },
        "@FooterBackgroundUseGradient":{
            "description":"Footer Background Use Gradient",
            "type":"string"
        },
        "@SiteBackgroundColorTop":{
            "description":"Site Background Color Top",
            "type":"string"
        },
        "@HeaderTopBackgroundUseGradient":{
            "description":"Header Top Background Use Gradient",
            "type":"string"
        },
        "@HeaderBackgroundColorBottom":{
            "description":"Header Background Color Bottom",
            "type":"string"
        },
        "@HeaderTopBackgroundColorBottom":{
            "description":"Header Top Background Color Bottom",
            "type":"string"
        },
        "@HeaderBackgroundImagePosition":{
            "description":"Header Background Image Position",
            "type":"string"
        },
        "@SitePageBackgroundColor":{
            "description":"Site Page Background Color",
            "type":"string"
        },
        "@HeaderTopBackgroundImageURL":{
            "description":"Header Top Background Image URL",
            "type":"string"
        },
        "@FooterBackgroundColorTop":{
            "description":"Footer Background Color Top",
            "type":"string"
        },
        "@HeaderTopBorderBottomColor":{
            "description":"Header Top Border Bottom Color",
            "type":"string"
        },
        "@HeaderBackgroundColor":{
            "description":"Header Background Color",
            "type":"string"
        },
        "@HeaderBackgroundImageURL":{
            "description":"Header Background Image URL",
            "type":"string"
        },
        "@FooterBackgroundColor":{
            "description":"Footer Background Color",
            "type":"string"
        },
        "@SiteBackgroundColor":{
            "description":"Site Background Color",
            "type":"string"
        },
        "@SiteBackgroundUseGradient":{
            "description":"Site Background Use Gradient",
            "type":"string"
        },
        "@FooterBackgroundImagePosition":{
            "description":"Footer Background Image Position",
            "type":"string"
        }
    }
}

Nested Schema : theme_styles_typography

Type: object

Typography information of theme styles.

Show Source

• @H1FontFamily(optional): string
  Heading 1 Font Family
• @H1FontSize(optional): string
  Heading 1 Font Size
• @H1FontStyle(optional): string
  Heading 1 Font Style
• @H1FontWeight(optional): string
  Heading 1 Font Weight
• @H1LineHeight(optional): string
  Heading 1 Line Height
• @H1TextAlign(optional): string
  Heading 1 Text Align
• @H1TextColor(optional): string
  Heading 1 Text Color
• @H1TextDecoration(optional): string
  Heading 1 Text Decoration
• @H2FontFamily(optional): string
  Heading 2 Font Family
• @H2FontSize(optional): string
  Heading 2 Font Size
• @H2FontStyle(optional): string
  Heading 2 Font Style
• @H2FontWeight(optional): string
  Heading 2 Font Weight
• @H2LineHeight(optional): string
  Heading 2 Line Height
• @H2TextAlign(optional): string
  Heading 2 Text Align
• @H2TextColor(optional): string
  Heading 2 Text Color
• @H2TextDecoration(optional): string
  Heading 2 Text Decoration
• @H3FontFamily(optional): string
  Heading 3 Font Family
• @H3FontSize(optional): string
  Heading 3 Font Size
• @H3FontStyle(optional): string
  Heading 3 Font Style
• @H3FontWeight(optional): string
  Heading 3 Font Weight
• @H3LineHeight(optional): string
  Heading 3 Line Height
• @H3TextAlign(optional): string
  Heading 3 Text Align
• @H3TextColor(optional): string
  Heading 3 Text Color
• @H3TextDecoration(optional): string
  Heading 3 Text Decoration
• @H4FontFamily(optional): string
  Heading 4 Font Family
• @H4FontSize(optional): string
  Heading 4 Font Size
• @H4FontStyle(optional): string
  Heading 4 Font Style
• @H4FontWeight(optional): string
  Heading 4 Font Weight
• @H4LineHeight(optional): string
  Heading 4 Line Height
• @H4TextAlign(optional): string
  Heading 4 Text Align
• @H4TextColor(optional): string
  Heading 4 Text Color
• @H4TextDecoration(optional): string
  Heading 4 Text Decoration
• @H5FontFamily(optional): string
  Heading 5 Font Family
• @H5FontSize(optional): string
  Heading 5 Font Size
• @H5FontStyle(optional): string
  Heading 5 Font Style
• @H5FontWeight(optional): string
  Heading 5 Font Weight
• @H5LineHeight(optional): string
  Heading 5 Line Height
• @H5TextAlign(optional): string
  Heading 5 Text Align
• @H5TextColor(optional): string
  Heading 5 Text Color
• @H5TextDecoration(optional): string
  Heading 5 Text Decoration
• @H6FontFamily(optional): string
  Heading 6 Font Family
• @H6FontSize(optional): string
  Heading 6 Font Size
• @H6FontStyle(optional): string
  Heading 6 Font Style
• @H6FontWeight(optional): string
  Heading 6 Font Weight
• @H6LineHeight(optional): string
  Heading 6 Line Height
• @H6TextAlign(optional): string
  Heading 6 Text Align
• @H6TextColor(optional): string
  Heading 6 Text Color
• @H6TextDecoration(optional): string
  Heading 6 Text Decoration
• @ParagraphFontFamily(optional): string
  Paragraph Font Family
• @ParagraphFontSize(optional): string
  Paragraph Font Size
• @ParagraphFontStyle(optional): string
  Paragraph Font Style
• @ParagraphFontWeight(optional): string
  Paragraph Font Weight
• @ParagraphLineHeight(optional): string
  Paragraph Line Height
• @ParagraphTextAlign(optional): string
  Paragraph Text Align
• @ParagraphTextColor(optional): string
  Paragraph Text Color
• @ParagraphTextDecoration(optional): string
  Paragraph Text Decoration
• @SiteFontFamily(optional): string
  Site Font Family
• @SiteFontSize(optional): string
  Site Font Size
• @SiteFontStyle(optional): string
  Site Font Style
• @SiteFontWeight(optional): string
  Site Font Weight
• @SiteLineHeight(optional): string
  Site Line Height
• @SiteTextAlign(optional): string
  Site Text Align
• @SiteTextColor(optional): string
  Site Text Color
• @SiteTextDecoration(optional): string
  Site Text Decoration

{
    "description":"Typography information of theme styles.",
    "type":"object",
    "properties":{
        "@H6LineHeight":{
            "description":"Heading 6 Line Height",
            "type":"string"
        },
        "@H5TextDecoration":{
            "description":"Heading 5 Text Decoration",
            "type":"string"
        },
        "@H3FontFamily":{
            "description":"Heading 3 Font Family",
            "type":"string"
        },
        "@H5FontStyle":{
            "description":"Heading 5 Font Style",
            "type":"string"
        },
        "@H2FontStyle":{
            "description":"Heading 2 Font Style",
            "type":"string"
        },
        "@H2TextColor":{
            "description":"Heading 2 Text Color",
            "type":"string"
        },
        "@SiteLineHeight":{
            "description":"Site Line Height",
            "type":"string"
        },
        "@H1TextAlign":{
            "description":"Heading 1 Text Align",
            "type":"string"
        },
        "@SiteFontFamily":{
            "description":"Site Font Family",
            "type":"string"
        },
        "@ParagraphFontWeight":{
            "description":"Paragraph Font Weight",
            "type":"string"
        },
        "@H5FontSize":{
            "description":"Heading 5 Font Size",
            "type":"string"
        },
        "@H4TextAlign":{
            "description":"Heading 4 Text Align",
            "type":"string"
        },
        "@H1TextDecoration":{
            "description":"Heading 1 Text Decoration",
            "type":"string"
        },
        "@H3LineHeight":{
            "description":"Heading 3 Line Height",
            "type":"string"
        },
        "@H2FontWeight":{
            "description":"Heading 2 Font Weight",
            "type":"string"
        },
        "@H3FontSize":{
            "description":"Heading 3 Font Size",
            "type":"string"
        },
        "@ParagraphLineHeight":{
            "description":"Paragraph Line Height",
            "type":"string"
        },
        "@H3TextAlign":{
            "description":"Heading 3 Text Align",
            "type":"string"
        },
        "@H3TextColor":{
            "description":"Heading 3 Text Color",
            "type":"string"
        },
        "@H4FontFamily":{
            "description":"Heading 4 Font Family",
            "type":"string"
        },
        "@SiteFontSize":{
            "description":"Site Font Size",
            "type":"string"
        },
        "@SiteTextAlign":{
            "description":"Site Text Align",
            "type":"string"
        },
        "@H5FontWeight":{
            "description":"Heading 5 Font Weight",
            "type":"string"
        },
        "@H6FontFamily":{
            "description":"Heading 6 Font Family",
            "type":"string"
        },
        "@H1FontSize":{
            "description":"Heading 1 Font Size",
            "type":"string"
        },
        "@H6FontStyle":{
            "description":"Heading 6 Font Style",
            "type":"string"
        },
        "@H6TextDecoration":{
            "description":"Heading 6 Text Decoration",
            "type":"string"
        },
        "@H2TextDecoration":{
            "description":"Heading 2 Text Decoration",
            "type":"string"
        },
        "@ParagraphTextColor":{
            "description":"Paragraph Text Color",
            "type":"string"
        },
        "@H1FontStyle":{
            "description":"Heading 1 Font Style",
            "type":"string"
        },
        "@ParagraphTextAlign":{
            "description":"Paragraph Text Align",
            "type":"string"
        },
        "@H4LineHeight":{
            "description":"Heading 4 Line Height",
            "type":"string"
        },
        "@H1FontWeight":{
            "description":"Heading 1 Font Weight",
            "type":"string"
        },
        "@SiteTextColor":{
            "description":"Site Text Color",
            "type":"string"
        },
        "@ParagraphFontSize":{
            "description":"Paragraph Font Size",
            "type":"string"
        },
        "@H5FontFamily":{
            "description":"Heading 5 Font Family",
            "type":"string"
        },
        "@H4FontWeight":{
            "description":"Heading 4 Font Weight",
            "type":"string"
        },
        "@ParagraphFontFamily":{
            "description":"Paragraph Font Family",
            "type":"string"
        },
        "@H1FontFamily":{
            "description":"Heading 1 Font Family",
            "type":"string"
        },
        "@H2TextAlign":{
            "description":"Heading 2 Text Align",
            "type":"string"
        },
        "@H1LineHeight":{
            "description":"Heading 1 Line Height",
            "type":"string"
        },
        "@H6FontSize":{
            "description":"Heading 6 Font Size",
            "type":"string"
        },
        "@H3TextDecoration":{
            "description":"Heading 3 Text Decoration",
            "type":"string"
        },
        "@H4TextColor":{
            "description":"Heading 4 Text Color",
            "type":"string"
        },
        "@ParagraphFontStyle":{
            "description":"Paragraph Font Style",
            "type":"string"
        },
        "@ParagraphTextDecoration":{
            "description":"Paragraph Text Decoration",
            "type":"string"
        },
        "@H1TextColor":{
            "description":"Heading 1 Text Color",
            "type":"string"
        },
        "@H4FontSize":{
            "description":"Heading 4 Font Size",
            "type":"string"
        },
        "@SiteTextDecoration":{
            "description":"Site Text Decoration",
            "type":"string"
        },
        "@SiteFontStyle":{
            "description":"Site Font Style",
            "type":"string"
        },
        "@H3FontWeight":{
            "description":"Heading 3 Font Weight",
            "type":"string"
        },
        "@H6TextAlign":{
            "description":"Heading 6 Text Align",
            "type":"string"
        },
        "@H4TextDecoration":{
            "description":"Heading 4 Text Decoration",
            "type":"string"
        },
        "@H2FontFamily":{
            "description":"Heading 2 Font Family",
            "type":"string"
        },
        "@H3FontStyle":{
            "description":"Heading 3 Font Style",
            "type":"string"
        },
        "@SiteFontWeight":{
            "description":"Site Font Weight",
            "type":"string"
        },
        "@H5LineHeight":{
            "description":"Heading 5 Line Height",
            "type":"string"
        },
        "@H2FontSize":{
            "description":"Heading 2 Font Size",
            "type":"string"
        },
        "@H6TextColor":{
            "description":"Heading 6 Text Color",
            "type":"string"
        },
        "@H4FontStyle":{
            "description":"Heading 4 Font Style",
            "type":"string"
        },
        "@H2LineHeight":{
            "description":"Heading 2 Line Height",
            "type":"string"
        },
        "@H5TextAlign":{
            "description":"Heading 5 Text Align",
            "type":"string"
        },
        "@H5TextColor":{
            "description":"Heading 5 Text Color",
            "type":"string"
        },
        "@H6FontWeight":{
            "description":"Heading 6 Font Weight",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "thumbnail":"/img/cloudlake.jpg",
    "is_active":true,
    "theme_styles_color":{
        "@ButtonPrimaryTextColor":"#fff",
        "@ButtonPrimaryBackgroundColorTop":"#08C",
        "@SubNavigationTextColor":"#fff",
        "@ButtonPrimaryFontStyle":"normal",
        "@ButtonPrimaryFontWeight":"normal",
        "@SubNavigationLinkHoverColor":"#fff\n    ",
        "@NavigationLinkShadowColor":"#000",
        "@NavigationLinkColor":"#DFDFDF",
        "@LinkColor":"#0088cc",
        "@NavigationLinkColorHover":"#FFF",
        "@ButtonPrimaryBackgroundColor":"#08C",
        "@NavigationBorderColor":"#3D3F44",
        "@SubNavigationLinkColor":"#fff",
        "@NavigationBackgroundColor":"#4f5158",
        "@ButtonPrimaryBackgroundColorBottom":"#04C",
        "@ButtonPrimaryFontFamily":"@sansFontFamily",
        "@ButtonPrimaryTextDecoration":"none",
        "@ButtonPrimaryBorderColor":"#04C",
        "@SubNavigationBackgroundColor":"#fff",
        "@NavigationBackgroundColorBottom":"#34363a",
        "@NavigationBackgroundColorTop":"#676a74",
        "@ButtonPrimaryBorderRadius":"4px",
        "@LinkHoverColor":"#FFD303",
        "@SubNavigationBackgroundHoverColor":"#fff",
        "@TextColor":"#333"
    },
    "notes":"This is the Cloud Lake Theme.",
    "theme_styles_typography":{
        "@H6LineHeight":"20px",
        "@H5FontFamily":"@sansFontFamily",
        "@H3FontFamily":"@sansFontFamily",
        "@H4FontWeight":"bold",
        "@ParagraphFontFamily":"@sansFontFamily",
        "@H1FontFamily":"@sansFontFamily",
        "@H2TextColor":"#333",
        "@SiteLineHeight":"20px",
        "@H1LineHeight":"40px",
        "@H6FontSize":"11.9px",
        "@SiteFontFamily":"@sansFontFamily",
        "@ParagraphFontWeight":"normal",
        "@H5FontSize":"14px",
        "@H4TextColor":"#333",
        "@H1TextColor":"#333",
        "@H4FontSize":"17.5px",
        "@H3LineHeight":"40px",
        "@H2FontWeight":"bold",
        "@H3FontSize":"24.5px",
        "@ParagraphLineHeight":"20px\n    ",
        "@H3TextColor":"#333",
        "@H3FontWeight":"bold",
        "@H4FontFamily":"@sansFontFamily",
        "@SiteFontSize":"14px",
        "@H2FontFamily":"@sansFontFamily",
        "@H5FontWeight":"normal",
        "@H6FontFamily":"@sansFontFamily",
        "@SiteFontWeight":"normal",
        "@H1FontSize":"38.5px",
        "@H5LineHeight":"20px",
        "@H2FontSize":"31.5px",
        "@H6TextColor":"#333",
        "@ParagraphTextColor":"#333",
        "@H2LineHeight":"40px",
        "@H6FontWeight":"normal",
        "@H5TextColor":"#333",
        "@H4LineHeight":"20px",
        "@H1FontWeight":"bold",
        "@ParagraphFontSize":"14px"
    },
    "clone_parent_name":null,
    "name":"Cloud Lake Theme",
    "repositoryId":"100001",
    "is_custom":false,
    "id":"100001",
    "theme_styles_general":{
        "@FooterBorderTopColor":"#bcd7e6\n    ",
        "@SiteBackgroundImageAttachment":"scroll",
        "@FooterBackgroundImageAttachment":"scroll",
        "@SiteBackgroundImageURL":"none",
        "@SiteBackgroundColorBottom":"transparent",
        "@FooterBackgroundColorBottom":"transparent",
        "@HeaderTopPaddingTop":"25px",
        "@HeaderBackgroundColorTop":"transparent",
        "@HeaderTopBackgroundColor":"#e2f5ff",
        "@ContentBackgroundColor":"#FFF",
        "@HeaderBackgroundImageAttachment":"scroll",
        "@FooterBackgroundImageURL":"none",
        "@FooterBackgroundImageRepeat":"repeat-x",
        "@HeaderBackgroundImageRepeat":"repeat-x",
        "@SiteBackgroundImagePosition":"topleft",
        "@SiteBackgroundImageRepeat":"no-repeat",
        "@SiteBackgroundColorTop":"transparent",
        "@HeaderBackgroundColorBottom":"transparent",
        "@HeaderBackgroundImagePosition":"topleft",
        "@HeaderTopBackgroundImageURL":"'/img/header-wrap.png'",
        "@FooterBackgroundColorTop":"transparent",
        "@HeaderTopBorderBottomColor":"#bcd7e6",
        "@HeaderBackgroundColor":"#FFF",
        "@HeaderBackgroundImageURL":"none",
        "@FooterBackgroundColor":"#e2f5ff",
        "@SiteBackgroundColor":"#FFF",
        "@FooterBackgroundImagePosition":"topleft"
    },
    "clone_parent_id":null
}

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top