transversal

Retrieve the validation schema of a resource (use json-schema). Some resources need to be validated by a json schema, they have an embedded link to this route to retrieve the correct json validation schema

get/v3/schemas/{resource}/{localeOrCountry}

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v3/schemas/{resource}/{localeOrCountry}
  • Auth: HTTP bearer

Path parameters

resource'profile' | 'billing' required

API resource to get the schema from.<br>Must be one of the following: profile, billing

Example:profile
localeOrCountry'AD' | 'AE' | 'AF' | 'AG' | 'AL' | 'AM' | 'AO' | 'AR' | 'AT' | 'AU' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BR' | 'BS' | 'BT' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FM' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GH' | 'GI' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GT' | 'GW' | 'GY' | 'HK' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JM' | 'JO' | 'JP' | 'KE' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MQ' | 'MR' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'de-AT' | 'de-CH' | 'de-DE' | 'en-AE' | 'en-AF' | 'en-AG' | 'en-AL' | 'en-AM' | 'en-AO' | 'en-AU' | 'en-AZ' | 'en-BA' | 'en-BB' | 'en-BD' | 'en-BF' | 'en-BG' | 'en-BH' | 'en-BI' | 'en-BJ' | 'en-BM' | 'en-BN' | 'en-BS' | 'en-BT' | 'en-BY' | 'en-BZ' | 'en-CA' | 'en-CH' | 'en-CM' | 'en-CN' | 'en-CO' | 'en-CR' | 'en-CU' | 'en-CY' | 'en-CZ' | 'en-DJ' | 'en-DK' | 'en-DM' | 'en-DO' | 'en-EC' | 'en-EE' | 'en-EG' | 'en-FI' | 'en-FJ' | 'en-GA' | 'en-GB' | 'en-GD' | 'en-GE' | 'en-GH' | 'en-GI' | 'en-GM' | 'en-GN' | 'en-GQ' | 'en-GT' | 'en-GY' | 'en-HK' | 'en-HN' | 'en-HR' | 'en-HT' | 'en-HU' | 'en-ID' | 'en-IE' | 'en-IL' | 'en-IN' | 'en-IR' | 'en-IS' | 'en-JM' | 'en-JO' | 'en-JP' | 'en-KE' | 'en-KH' | 'en-KM' | 'en-KN' | 'en-KP' | 'en-KR' | 'en-KW' | 'en-KY' | 'en-KZ' | 'en-LA' | 'en-LB' | 'en-LC' | 'en-LI' | 'en-LK' | 'en-LR' | 'en-LT' | 'en-LV' | 'en-LY' | 'en-MD' | 'en-MF' | 'en-MG' | 'en-MK' | 'en-ML' | 'en-MM' | 'en-MN' | 'en-MO' | 'en-MR' | 'en-MT' | 'en-MU' | 'en-MV' | 'en-MW' | 'en-MY' | 'en-MZ' | 'en-NA' | 'en-NC' | 'en-NE' | 'en-NG' | 'en-NI' | 'en-NO' | 'en-NP' | 'en-NZ' | 'en-OM' | 'en-PA' | 'en-PG' | 'en-PH' | 'en-PK' | 'en-PR' | 'en-QA' | 'en-RS' | 'en-RW' | 'en-SA' | 'en-SC' | 'en-SE' | 'en-SG' | 'en-SH' | 'en-SI' | 'en-SK' | 'en-SM' | 'en-SN' | 'en-SR' | 'en-SV' | 'en-SY' | 'en-SZ' | 'en-TC' | 'en-TD' | 'en-TG' | 'en-TH' | 'en-TT' | 'en-TW' | 'en-TZ' | 'en-UG' | 'en-US' | 'en-UZ' | 'en-VG' | 'en-VN' | 'en-VU' | 'en-WF' | 'en-WS' | 'en-YE' | 'en-YT' | 'en-ZA' | 'en-ZW' | 'es-AR' | 'es-BO' | 'es-BW' | 'es-CL' | 'es-CO' | 'es-DO' | 'es-ES' | 'es-MX' | 'es-PA' | 'es-PE' | 'es-PY' | 'es-UY' | 'es-VE' | 'et-EE' | 'fr-AD' | 'fr-BE' | 'fr-BL' | 'fr-CA' | 'fr-CD' | 'fr-CF' | 'fr-CG' | 'fr-CH' | 'fr-CI' | 'fr-CK' | 'fr-CV' | 'fr-DZ' | 'fr-ET' | 'fr-FM' | 'fr-FR' | 'fr-GF' | 'fr-GP' | 'fr-GW' | 'fr-IO' | 'fr-IQ' | 'fr-KI' | 'fr-LB' | 'fr-LS' | 'fr-LU' | 'fr-MA' | 'fr-MC' | 'fr-ME' | 'fr-MH' | 'fr-MQ' | 'fr-NR' | 'fr-PF' | 'fr-PM' | 'fr-PN' | 'fr-PS' | 'fr-PW' | 'fr-RE' | 'fr-SB' | 'fr-SD' | 'fr-SL' | 'fr-SO' | 'fr-ST' | 'fr-TF' | 'fr-TJ' | 'fr-TL' | 'fr-TM' | 'fr-TN' | 'fr-TO' | 'fr-TV' | 'fr-VA' | 'fr-VC' | 'fr-YE' | 'fr-ZM' | 'gr-GR' | 'he-IL' | 'id-ID' | 'it-IT' | 'ja-JP' | 'ko-KR' | 'lv-LV' | 'ma-MA' | 'nl-BE' | 'nl-NL' | 'pl-PL' | 'pt-BR' | 'pt-PT' | 'ro-RO' | 'ru-RU' | 'se-SE' | 'sk-SK' | 'th-TH' | 'tr-TR' | 'tu-TN' | 'uk-UA' | 'vn-VN' | 'zh-CN' | 'zh-HK' | 'zh-TW' required

Query parameters

proposal_idstring

Proposal identifier

Example:123456

Headers

x-api-keystring required

Api_key provided by ClubMed API team

Response

ok

titlestring required

JSON Schema title

$schemastring required

JSON Schema dialect

$idstring required

JSON Schema id

typestring required

Schema type

additionalPropertiesboolean required

Indicate if it is possible to add other properties

requiredstring[]

Model's required field

definitionsstring
propertiesstring

Example response

{
  "title": "ProfileSchema_fr-FR",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api-test/v3/schemas/resource/fr-FR",
  "type": "object"
}

Changes

No recorded changes to this operation across all 1 revision of this API.