{"items":[{"type":"link","label":"Certifications","link":"/apis/certifications/certifications-v1","routeSlug":"/apis/certifications/certifications-v1","content":{"contentType":"overview","meta":{"name":"Certifications"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"certifications-v1.json","url":"/_bundle/apis/certifications/certifications-v1.json?download"},{"kind":"download","label":"certifications-v1.yaml","url":"/_bundle/apis/certifications/certifications-v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Certifications (v1-2025-04-18)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"The Certifications API provides all the capabilities for managing the certification process beginning with your Certification\nProgram. You can also manage Applications, Courses, or Course Offerings from this API.\n\nLike most of the other Rhythm apps, the Certifications API includes endpoints for Query Definitions. These endpoints are \ncommonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API."}],"sectionId":"/apis/certifications/certifications-v1"}],"sectionId":"/apis/certifications/certifications-v1"}]}]}},{"type":"group","label":"Activities","link":"/apis/certifications/certifications-v1/activities","routeSlug":"/apis/certifications/certifications-v1/activities","items":[{"label":"Gets all of the activities in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activities/listactivities","routeSlug":"/apis/certifications/certifications-v1/activities/listactivities","metadata":{"seo":{"title":"Gets all of the activities in the system.","description":"This method will scan all activities and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listActivities","name":"Gets all of the activities in the system.","isWebhook":false,"pointer":"/paths/~1activities~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the activities in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all activities and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1activities~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1activities~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activities/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/activities/{tenantId}","href":"activities/listactivities","openApiOperationId":"listActivities","summary":"Gets all of the activities in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activitieswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367"}},"schemaId":"schema_367","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activities~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_367","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activities/listactivities"}],"panels":[]}]},"httpPath":"/activities/{tenantId}"},{"label":"Creates a new activity record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activities/createactivity","routeSlug":"/apis/certifications/certifications-v1/activities/createactivity","metadata":{"seo":{"title":"Creates a new activity record that does not already exist.","description":"This method will auto-generate an ID and create a new activity. If an ID is specified for the activity, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createActivity","name":"Creates a new activity record that does not already exist.","isWebhook":false,"pointer":"/paths/~1activities~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new activity record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new activity. If an ID is specified for the activity, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1activities~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Activity"}},"schemaId":"components/schemas/Activity","pointer":"/paths/~1activities~1{tenantId}/post/requestBody","description":"The activity that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/activities/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Activity"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/activities/{tenantId}","href":"activities/createactivity","openApiOperationId":"createActivity","summary":"Creates a new activity record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Activity","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Activity"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Activity"}},"schemaId":"components/schemas/Activity","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The activity you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The activity could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add activity based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activities~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Activity","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Activity"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activities/createactivity"}],"panels":[]}]},"httpPath":"/activities/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activities/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/activities/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1activities~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1activities~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1activities~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/activities/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/activities/{tenantId}/batch","href":"activities/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The activity could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve activity based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activities~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activities/executebatchoperations"}],"panels":[]}]},"httpPath":"/activities/{tenantId}/batch"},{"label":"Can Be Edited in Portal","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activities/caneditinportal","routeSlug":"/apis/certifications/certifications-v1/activities/caneditinportal","metadata":{"seo":{"title":"Can Be Edited in Portal","description":"Determine whether or not activity can be editing in the portal"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"canEditInPortal","name":"Can Be Edited in Portal","isWebhook":false,"pointer":"/paths/~1activities~1{tenantId}~1canEdit~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Can Be Edited in Portal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Determine whether or not activity can be editing in the portal"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1activities~1{tenantId}~1canEdit~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activities/{tenantId}/canEdit/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/activities/{tenantId}/canEdit/{id}","href":"activities/caneditinportal","openApiOperationId":"canEditInPortal","summary":"Can Be Edited in Portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CanEditResponse"}},"schemaId":"components/schemas/CanEditResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activities~1{tenantId}~1canEdit~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CanEditResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CanEditResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activities/caneditinportal"}],"panels":[]}]},"httpPath":"/activities/{tenantId}/canEdit/{id}"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activities/listactivitiesbycontactid","routeSlug":"/apis/certifications/certifications-v1/activities/listactivitiesbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listActivitiesByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1activities~1{tenantId}~1contact~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified contact_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1activities~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1activities~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activities/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/activities/{tenantId}/contact/{contact_id}","href":"activities/listactivitiesbycontactid","openApiOperationId":"listActivitiesByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListActivitiesResponse"}},"schemaId":"components/schemas/ListActivitiesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activities~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListActivitiesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListActivitiesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activities/listactivitiesbycontactid"}],"panels":[]}]},"httpPath":"/activities/{tenantId}/contact/{contact_id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activities/previewemail","routeSlug":"/apis/certifications/certifications-v1/activities/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewEmail","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1activities~1{tenantId}~1previewEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the CRC notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the CRC notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true}],"pointer":"/paths/~1activities~1{tenantId}~1previewEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"schemaId":"components/schemas/PreviewEmailRequest","pointer":"/paths/~1activities~1{tenantId}~1previewEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/activities/{tenantId}/previewEmail","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/activities/{tenantId}/previewEmail","href":"activities/previewemail","openApiOperationId":"previewEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activities~1{tenantId}~1previewEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activities/previewemail"}],"panels":[]}]},"httpPath":"/activities/{tenantId}/previewEmail"},{"label":"Processes an existing activity","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activities/processactivity","routeSlug":"/apis/certifications/certifications-v1/activities/processactivity","metadata":{"seo":{"title":"Processes an existing activity","description":"This method will auto-generate an ID and create a new activity. If an ID is specified for the activity, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processActivity","name":"Processes an existing activity","isWebhook":false,"pointer":"/paths/~1activities~1{tenantId}~1process~1{id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes an existing activity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new activity. If an ID is specified for the activity, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The id of the activity to process","required":true}],"pointer":"/paths/~1activities~1{tenantId}~1process~1{id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/activities/{tenantId}/process/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/activities/{tenantId}/process/{id}","href":"activities/processactivity","openApiOperationId":"processActivity","summary":"Processes an existing activity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The members was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The members supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The members could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activities~1{tenantId}~1process~1{id}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activities/processactivity"}],"panels":[]}]},"httpPath":"/activities/{tenantId}/process/{id}"},{"label":"Searches for activities using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activities/searchforactivities","routeSlug":"/apis/certifications/certifications-v1/activities/searchforactivities","metadata":{"seo":{"title":"Searches for activities using predefined parameters","description":"Searches for activities using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForActivities","name":"Searches for activities using predefined parameters","isWebhook":false,"pointer":"/paths/~1activities~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for activities using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for activities using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1activities~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_366","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1activities~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActivitySearchParameters"}},"schemaId":"components/schemas/ActivitySearchParameters","pointer":"/paths/~1activities~1{tenantId}~1search/post/requestBody","description":"The activity that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/activities/{tenantId}/search","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ActivitySearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/activities/{tenantId}/search","href":"activities/searchforactivities","openApiOperationId":"searchForActivities","summary":"Searches for activities using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ActivitySearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActivitySearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedActivitySearchResults"}},"schemaId":"components/schemas/PagedActivitySearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The activity you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The activity could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add activity based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activities~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedActivitySearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedActivitySearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activities/searchforactivities"}],"panels":[]}]},"httpPath":"/activities/{tenantId}/search"},{"label":"Returns a activity from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activities/deleteactivity","routeSlug":"/apis/certifications/certifications-v1/activities/deleteactivity","metadata":{"seo":{"title":"Returns a activity from the system by its ID.","description":"This method will delete a activity with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteActivity","name":"Returns a activity from the system by its ID.","isWebhook":false,"pointer":"/paths/~1activities~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a activity from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a activity with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the activity to delete.","required":true}],"pointer":"/paths/~1activities~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/activities/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/activities/{tenantId}/{id}","href":"activities/deleteactivity","openApiOperationId":"deleteActivity","summary":"Returns a activity from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The activity could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The activity could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete activity based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activities~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activities/deleteactivity"}],"panels":[]}]},"httpPath":"/activities/{tenantId}/{id}"},{"label":"Returns a activity from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activities/getactivity","routeSlug":"/apis/certifications/certifications-v1/activities/getactivity","metadata":{"seo":{"title":"Returns a activity from the system by its ID.","description":"This method will look up a activity by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getActivity","name":"Returns a activity from the system by its ID.","isWebhook":false,"pointer":"/paths/~1activities~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a activity from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a activity by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the activity to return.","required":true}],"pointer":"/paths/~1activities~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1activities~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activities/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/activities/{tenantId}/{id}","href":"activities/getactivity","openApiOperationId":"getActivity","summary":"Returns a activity from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Activity"}},"schemaId":"components/schemas/Activity","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The activity could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve activity based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activities~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Activity","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Activity"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activities/getactivity"}],"panels":[]}]},"httpPath":"/activities/{tenantId}/{id}"},{"label":"Partially updates a activity with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activities/patchactivity","routeSlug":"/apis/certifications/certifications-v1/activities/patchactivity","metadata":{"seo":{"title":"Partially updates a activity with the specified ID.","description":"This method will patch an existing activity with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchActivity","name":"Partially updates a activity with the specified ID.","isWebhook":false,"pointer":"/paths/~1activities~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a activity with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing activity with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the activity to patch.","required":true}],"pointer":"/paths/~1activities~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1activities~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/activities/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/activities/{tenantId}/{id}","href":"activities/patchactivity","openApiOperationId":"patchActivity","summary":"Partially updates a activity with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Activity"}},"schemaId":"components/schemas/Activity","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The activity could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The activity could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve activity based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activities~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Activity","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Activity"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activities/patchactivity"}],"panels":[]}]},"httpPath":"/activities/{tenantId}/{id}"},{"label":"Updates a activity with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activities/updateactivity","routeSlug":"/apis/certifications/certifications-v1/activities/updateactivity","metadata":{"seo":{"title":"Updates a activity with the specified ID.","description":"This method will update an existing activity with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateActivity","name":"Updates a activity with the specified ID.","isWebhook":false,"pointer":"/paths/~1activities~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a activity with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing activity with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the activity to update.","required":true}],"pointer":"/paths/~1activities~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Activity"}},"schemaId":"components/schemas/Activity","pointer":"/paths/~1activities~1{tenantId}~1{id}/put/requestBody","description":"The updated activity that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/activities/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Activity"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/activities/{tenantId}/{id}","href":"activities/updateactivity","openApiOperationId":"updateActivity","summary":"Updates a activity with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Activity","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Activity"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Activity"}},"schemaId":"components/schemas/Activity","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The activity supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The activity could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The activity could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve activity based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activities~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Activity","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Activity"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activities/updateactivity"}],"panels":[]}]},"httpPath":"/activities/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Activities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activities","showPageActions":true},{"nodeType":"markdoc","content":"Activities"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/activities/{tenantId}","summary":"Gets all of the activities in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/activities/listactivities","deprecated":false},{"title":"/activities/{tenantId}","summary":"Creates a new activity record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/activities/createactivity","deprecated":false},{"title":"/activities/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/activities/executebatchoperations","deprecated":false},{"title":"/activities/{tenantId}/canEdit/{id}","summary":"Can Be Edited in Portal","prefix":{"name":"get","color":"get"},"badges":[],"link":"/activities/caneditinportal","deprecated":false},{"title":"/activities/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/activities/listactivitiesbycontactid","deprecated":false},{"title":"/activities/{tenantId}/previewEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/activities/previewemail","deprecated":false},{"title":"/activities/{tenantId}/process/{id}","summary":"Processes an existing activity","prefix":{"name":"put","color":"put"},"badges":[],"link":"/activities/processactivity","deprecated":false},{"title":"/activities/{tenantId}/search","summary":"Searches for activities using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/activities/searchforactivities","deprecated":false},{"title":"/activities/{tenantId}/{id}","summary":"Returns a activity from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/activities/deleteactivity","deprecated":false},{"title":"/activities/{tenantId}/{id}","summary":"Returns a activity from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/activities/getactivity","deprecated":false},{"title":"/activities/{tenantId}/{id}","summary":"Partially updates a activity with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/activities/patchactivity","deprecated":false},{"title":"/activities/{tenantId}/{id}","summary":"Updates a activity with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/activities/updateactivity","deprecated":false}]}]}]}]}},{"type":"group","label":"Activity Reg Processes","link":"/apis/certifications/certifications-v1/activity-reg-processes","routeSlug":"/apis/certifications/certifications-v1/activity-reg-processes","items":[{"label":"Gets all of the activity reg processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activity-reg-processes/listactivityregprocesses","routeSlug":"/apis/certifications/certifications-v1/activity-reg-processes/listactivityregprocesses","metadata":{"seo":{"title":"Gets all of the activity reg processes in the system.","description":"This method will scan all activity reg processes and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listActivityRegProcesses","name":"Gets all of the activity reg processes in the system.","isWebhook":false,"pointer":"/paths/~1activityRegProcesses~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the activity reg processes in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all activity reg processes and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activityRegProcesses/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/activityRegProcesses/{tenantId}","href":"activity-reg-processes/listactivityregprocesses","openApiOperationId":"listActivityRegProcesses","summary":"Gets all of the activity reg processes in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity reg processeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370"}},"schemaId":"schema_370","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_370","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity-reg-processes/listactivityregprocesses"}],"panels":[]}]},"httpPath":"/activityRegProcesses/{tenantId}"},{"label":"Creates a new activity reg process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activity-reg-processes/createactivityregprocess","routeSlug":"/apis/certifications/certifications-v1/activity-reg-processes/createactivityregprocess","metadata":{"seo":{"title":"Creates a new activity reg process record that does not already exist.","description":"This method will auto-generate an ID and create a new activity reg process. If an ID is specified for the activity reg process, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createActivityRegProcess","name":"Creates a new activity reg process record that does not already exist.","isWebhook":false,"pointer":"/paths/~1activityRegProcesses~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new activity reg process record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new activity reg process. If an ID is specified for the activity reg process, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActivityRegProcess"}},"schemaId":"components/schemas/ActivityRegProcess","pointer":"/paths/~1activityRegProcesses~1{tenantId}/post/requestBody","description":"The activity reg process that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/activityRegProcesses/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ActivityRegProcess"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/activityRegProcesses/{tenantId}","href":"activity-reg-processes/createactivityregprocess","openApiOperationId":"createActivityRegProcess","summary":"Creates a new activity reg process record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ActivityRegProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActivityRegProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity reg process was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityRegProcess"}},"schemaId":"components/schemas/ActivityRegProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The activity reg process you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The activity reg process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add activity reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActivityRegProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityRegProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity-reg-processes/createactivityregprocess"}],"panels":[]}]},"httpPath":"/activityRegProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activity-reg-processes/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/activity-reg-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1activityRegProcesses~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/activityRegProcesses/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/activityRegProcesses/{tenantId}/batch","href":"activity-reg-processes/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The activity reg process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve activity reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity-reg-processes/executebatchoperations"}],"panels":[]}]},"httpPath":"/activityRegProcesses/{tenantId}/batch"},{"label":"Gets all of the processes a contact is eligible to use","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activity-reg-processes/geteligibleprocesses","routeSlug":"/apis/certifications/certifications-v1/activity-reg-processes/geteligibleprocesses","metadata":{"seo":{"title":"Gets all of the processes a contact is eligible to use","description":"Gets all of the processes a contact is eligible to use"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEligibleProcesses","name":"Gets all of the processes a contact is eligible to use","isWebhook":false,"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1eligible~1{contactId}~1{activityTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the processes a contact is eligible to use","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The contact id","required":true},{"name":"activityTypeId","in":"path","schemaId":"schema_366","description":"The type of activity","required":true}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1eligible~1{contactId}~1{activityTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activityRegProcesses/{tenantId}/eligible/{contactId}/{activityTypeId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"},{"name":"activityTypeId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/activityRegProcesses/{tenantId}/eligible/{contactId}/{activityTypeId}","href":"activity-reg-processes/geteligibleprocesses","openApiOperationId":"getEligibleProcesses","summary":"Gets all of the processes a contact is eligible to use"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Processes were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370"}},"schemaId":"schema_370","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1eligible~1{contactId}~1{activityTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_370","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_370"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity-reg-processes/geteligibleprocesses"}],"panels":[]}]},"httpPath":"/activityRegProcesses/{tenantId}/eligible/{contactId}/{activityTypeId}"},{"label":"Returns a activity reg process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activity-reg-processes/deleteactivityregprocess","routeSlug":"/apis/certifications/certifications-v1/activity-reg-processes/deleteactivityregprocess","metadata":{"seo":{"title":"Returns a activity reg process from the system by its ID.","description":"This method will delete a activity reg process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteActivityRegProcess","name":"Returns a activity reg process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a activity reg process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a activity reg process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the activity reg process to delete.","required":true}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/activityRegProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/activityRegProcesses/{tenantId}/{id}","href":"activity-reg-processes/deleteactivityregprocess","openApiOperationId":"deleteActivityRegProcess","summary":"Returns a activity reg process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity reg process was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The activity reg process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The activity reg process could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete activity reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity-reg-processes/deleteactivityregprocess"}],"panels":[]}]},"httpPath":"/activityRegProcesses/{tenantId}/{id}"},{"label":"Returns a activity reg process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activity-reg-processes/getactivityregprocess","routeSlug":"/apis/certifications/certifications-v1/activity-reg-processes/getactivityregprocess","metadata":{"seo":{"title":"Returns a activity reg process from the system by its ID.","description":"This method will look up a activity reg process by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getActivityRegProcess","name":"Returns a activity reg process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a activity reg process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a activity reg process by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the activity reg process to return.","required":true}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activityRegProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/activityRegProcesses/{tenantId}/{id}","href":"activity-reg-processes/getactivityregprocess","openApiOperationId":"getActivityRegProcess","summary":"Returns a activity reg process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity reg process was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityRegProcess"}},"schemaId":"components/schemas/ActivityRegProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The activity reg process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve activity reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActivityRegProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityRegProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity-reg-processes/getactivityregprocess"}],"panels":[]}]},"httpPath":"/activityRegProcesses/{tenantId}/{id}"},{"label":"Partially updates a activity reg process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activity-reg-processes/patchactivityregprocess","routeSlug":"/apis/certifications/certifications-v1/activity-reg-processes/patchactivityregprocess","metadata":{"seo":{"title":"Partially updates a activity reg process with the specified ID.","description":"This method will patch an existing activity reg process with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchActivityRegProcess","name":"Partially updates a activity reg process with the specified ID.","isWebhook":false,"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a activity reg process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing activity reg process with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the activity reg process to patch.","required":true}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1activityRegProcesses~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/activityRegProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/activityRegProcesses/{tenantId}/{id}","href":"activity-reg-processes/patchactivityregprocess","openApiOperationId":"patchActivityRegProcess","summary":"Partially updates a activity reg process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity reg process was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityRegProcess"}},"schemaId":"components/schemas/ActivityRegProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The activity reg process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The activity reg process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve activity reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActivityRegProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityRegProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity-reg-processes/patchactivityregprocess"}],"panels":[]}]},"httpPath":"/activityRegProcesses/{tenantId}/{id}"},{"label":"Updates a activity reg process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activity-reg-processes/updateactivityregprocess","routeSlug":"/apis/certifications/certifications-v1/activity-reg-processes/updateactivityregprocess","metadata":{"seo":{"title":"Updates a activity reg process with the specified ID.","description":"This method will update an existing activity reg process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateActivityRegProcess","name":"Updates a activity reg process with the specified ID.","isWebhook":false,"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a activity reg process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing activity reg process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the activity reg process to update.","required":true}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActivityRegProcess"}},"schemaId":"components/schemas/ActivityRegProcess","pointer":"/paths/~1activityRegProcesses~1{tenantId}~1{id}/put/requestBody","description":"The updated activity reg process that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/activityRegProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ActivityRegProcess"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/activityRegProcesses/{tenantId}/{id}","href":"activity-reg-processes/updateactivityregprocess","openApiOperationId":"updateActivityRegProcess","summary":"Updates a activity reg process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ActivityRegProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActivityRegProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity reg process was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityRegProcess"}},"schemaId":"components/schemas/ActivityRegProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The activity reg process supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The activity reg process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The activity reg process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve activity reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activityRegProcesses~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActivityRegProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityRegProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity-reg-processes/updateactivityregprocess"}],"panels":[]}]},"httpPath":"/activityRegProcesses/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Activity Reg Processes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activity Reg Processes","showPageActions":true},{"nodeType":"markdoc","content":"Activity Reg Processes"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/activityRegProcesses/{tenantId}","summary":"Gets all of the activity reg processes in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/activity-reg-processes/listactivityregprocesses","deprecated":false},{"title":"/activityRegProcesses/{tenantId}","summary":"Creates a new activity reg process record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/activity-reg-processes/createactivityregprocess","deprecated":false},{"title":"/activityRegProcesses/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/activity-reg-processes/executebatchoperations","deprecated":false},{"title":"/activityRegProcesses/{tenantId}/eligible/{contactId}/{activityTypeId}","summary":"Gets all of the processes a contact is eligible to use","prefix":{"name":"get","color":"get"},"badges":[],"link":"/activity-reg-processes/geteligibleprocesses","deprecated":false},{"title":"/activityRegProcesses/{tenantId}/{id}","summary":"Returns a activity reg process from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/activity-reg-processes/deleteactivityregprocess","deprecated":false},{"title":"/activityRegProcesses/{tenantId}/{id}","summary":"Returns a activity reg process from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/activity-reg-processes/getactivityregprocess","deprecated":false},{"title":"/activityRegProcesses/{tenantId}/{id}","summary":"Partially updates a activity reg process with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/activity-reg-processes/patchactivityregprocess","deprecated":false},{"title":"/activityRegProcesses/{tenantId}/{id}","summary":"Updates a activity reg process with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/activity-reg-processes/updateactivityregprocess","deprecated":false}]}]}]}]}},{"type":"group","label":"Activity Types","link":"/apis/certifications/certifications-v1/activity-types","routeSlug":"/apis/certifications/certifications-v1/activity-types","items":[{"label":"Gets all of the activity types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activity-types/listactivitytypes","routeSlug":"/apis/certifications/certifications-v1/activity-types/listactivitytypes","metadata":{"seo":{"title":"Gets all of the activity types in the system.","description":"This method will scan all activity types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listActivityTypes","name":"Gets all of the activity types in the system.","isWebhook":false,"pointer":"/paths/~1activityTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the activity types in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all activity types and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1activityTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1activityTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activityTypes/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/activityTypes/{tenantId}","href":"activity-types/listactivitytypes","openApiOperationId":"listActivityTypes","summary":"Gets all of the activity types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_371"}},"schemaId":"schema_371","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activityTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_371","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_371"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity-types/listactivitytypes"}],"panels":[]}]},"httpPath":"/activityTypes/{tenantId}"},{"label":"Creates a new activity type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activity-types/createactivitytype","routeSlug":"/apis/certifications/certifications-v1/activity-types/createactivitytype","metadata":{"seo":{"title":"Creates a new activity type record that does not already exist.","description":"This method will auto-generate an ID and create a new activity type. If an ID is specified for the activity type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createActivityType","name":"Creates a new activity type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1activityTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new activity type record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new activity type. If an ID is specified for the activity type, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1activityTypes~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActivityType"}},"schemaId":"components/schemas/ActivityType","pointer":"/paths/~1activityTypes~1{tenantId}/post/requestBody","description":"The activity type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/activityTypes/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ActivityType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/activityTypes/{tenantId}","href":"activity-types/createactivitytype","openApiOperationId":"createActivityType","summary":"Creates a new activity type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ActivityType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActivityType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityType"}},"schemaId":"components/schemas/ActivityType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The activity type you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The activity type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add activity type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activityTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActivityType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity-types/createactivitytype"}],"panels":[]}]},"httpPath":"/activityTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activity-types/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/activity-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1activityTypes~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1activityTypes~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1activityTypes~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/activityTypes/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/activityTypes/{tenantId}/batch","href":"activity-types/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The activity type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve activity type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activityTypes~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity-types/executebatchoperations"}],"panels":[]}]},"httpPath":"/activityTypes/{tenantId}/batch"},{"label":"Returns a activity type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activity-types/deleteactivitytype","routeSlug":"/apis/certifications/certifications-v1/activity-types/deleteactivitytype","metadata":{"seo":{"title":"Returns a activity type from the system by its ID.","description":"This method will delete a activity type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteActivityType","name":"Returns a activity type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1activityTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a activity type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a activity type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the activity type to delete.","required":true}],"pointer":"/paths/~1activityTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/activityTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/activityTypes/{tenantId}/{id}","href":"activity-types/deleteactivitytype","openApiOperationId":"deleteActivityType","summary":"Returns a activity type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The activity type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The activity type could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete activity type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activityTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity-types/deleteactivitytype"}],"panels":[]}]},"httpPath":"/activityTypes/{tenantId}/{id}"},{"label":"Returns a activity type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activity-types/getactivitytype","routeSlug":"/apis/certifications/certifications-v1/activity-types/getactivitytype","metadata":{"seo":{"title":"Returns a activity type from the system by its ID.","description":"This method will look up a activity type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getActivityType","name":"Returns a activity type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1activityTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a activity type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a activity type by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the activity type to return.","required":true}],"pointer":"/paths/~1activityTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1activityTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/activityTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/activityTypes/{tenantId}/{id}","href":"activity-types/getactivitytype","openApiOperationId":"getActivityType","summary":"Returns a activity type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityType"}},"schemaId":"components/schemas/ActivityType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The activity type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve activity type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activityTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActivityType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity-types/getactivitytype"}],"panels":[]}]},"httpPath":"/activityTypes/{tenantId}/{id}"},{"label":"Partially updates a activity type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activity-types/patchactivitytype","routeSlug":"/apis/certifications/certifications-v1/activity-types/patchactivitytype","metadata":{"seo":{"title":"Partially updates a activity type with the specified ID.","description":"This method will patch an existing activity type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchActivityType","name":"Partially updates a activity type with the specified ID.","isWebhook":false,"pointer":"/paths/~1activityTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a activity type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing activity type with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the activity type to patch.","required":true}],"pointer":"/paths/~1activityTypes~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1activityTypes~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/activityTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/activityTypes/{tenantId}/{id}","href":"activity-types/patchactivitytype","openApiOperationId":"patchActivityType","summary":"Partially updates a activity type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityType"}},"schemaId":"components/schemas/ActivityType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The activity type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The activity type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve activity type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activityTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActivityType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity-types/patchactivitytype"}],"panels":[]}]},"httpPath":"/activityTypes/{tenantId}/{id}"},{"label":"Updates a activity type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/activity-types/updateactivitytype","routeSlug":"/apis/certifications/certifications-v1/activity-types/updateactivitytype","metadata":{"seo":{"title":"Updates a activity type with the specified ID.","description":"This method will update an existing activity type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateActivityType","name":"Updates a activity type with the specified ID.","isWebhook":false,"pointer":"/paths/~1activityTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a activity type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing activity type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the activity type to update.","required":true}],"pointer":"/paths/~1activityTypes~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActivityType"}},"schemaId":"components/schemas/ActivityType","pointer":"/paths/~1activityTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated activity type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/activityTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ActivityType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/activityTypes/{tenantId}/{id}","href":"activity-types/updateactivitytype","openApiOperationId":"updateActivityType","summary":"Updates a activity type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ActivityType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ActivityType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The activity type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityType"}},"schemaId":"components/schemas/ActivityType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The activity type supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The activity type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The activity type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve activity type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1activityTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ActivityType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ActivityType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/activity-types/updateactivitytype"}],"panels":[]}]},"httpPath":"/activityTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Activity Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activity Types","showPageActions":true},{"nodeType":"markdoc","content":"Activity Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/activityTypes/{tenantId}","summary":"Gets all of the activity types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/activity-types/listactivitytypes","deprecated":false},{"title":"/activityTypes/{tenantId}","summary":"Creates a new activity type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/activity-types/createactivitytype","deprecated":false},{"title":"/activityTypes/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/activity-types/executebatchoperations","deprecated":false},{"title":"/activityTypes/{tenantId}/{id}","summary":"Returns a activity type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/activity-types/deleteactivitytype","deprecated":false},{"title":"/activityTypes/{tenantId}/{id}","summary":"Returns a activity type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/activity-types/getactivitytype","deprecated":false},{"title":"/activityTypes/{tenantId}/{id}","summary":"Partially updates a activity type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/activity-types/patchactivitytype","deprecated":false},{"title":"/activityTypes/{tenantId}/{id}","summary":"Updates a activity type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/activity-types/updateactivitytype","deprecated":false}]}]}]}]}},{"type":"group","label":"App Reference Processes","link":"/apis/certifications/certifications-v1/app-reference-processes","routeSlug":"/apis/certifications/certifications-v1/app-reference-processes","items":[{"label":"Gets all of the app reference processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-reference-processes/listappreferenceprocesses","routeSlug":"/apis/certifications/certifications-v1/app-reference-processes/listappreferenceprocesses","metadata":{"seo":{"title":"Gets all of the app reference processes in the system.","description":"This method will scan all app reference processes and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAppReferenceProcesses","name":"Gets all of the app reference processes in the system.","isWebhook":false,"pointer":"/paths/~1appReferenceProcesses~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the app reference processes in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all app reference processes and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1appReferenceProcesses~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1appReferenceProcesses~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/appReferenceProcesses/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/appReferenceProcesses/{tenantId}","href":"app-reference-processes/listappreferenceprocesses","openApiOperationId":"listAppReferenceProcesses","summary":"Gets all of the app reference processes in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app reference processeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}},"schemaId":"schema_372","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appReferenceProcesses~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_372","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_372"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-reference-processes/listappreferenceprocesses"}],"panels":[]}]},"httpPath":"/appReferenceProcesses/{tenantId}"},{"label":"Creates a new app reference process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-reference-processes/createappreferenceprocess","routeSlug":"/apis/certifications/certifications-v1/app-reference-processes/createappreferenceprocess","metadata":{"seo":{"title":"Creates a new app reference process record that does not already exist.","description":"This method will auto-generate an ID and create a new app reference process. If an ID is specified for the app reference process, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAppReferenceProcess","name":"Creates a new app reference process record that does not already exist.","isWebhook":false,"pointer":"/paths/~1appReferenceProcesses~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new app reference process record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new app reference process. If an ID is specified for the app reference process, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1appReferenceProcesses~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppReferenceProcess"}},"schemaId":"components/schemas/AppReferenceProcess","pointer":"/paths/~1appReferenceProcesses~1{tenantId}/post/requestBody","description":"The app reference process that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/appReferenceProcesses/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppReferenceProcess"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/appReferenceProcesses/{tenantId}","href":"app-reference-processes/createappreferenceprocess","openApiOperationId":"createAppReferenceProcess","summary":"Creates a new app reference process record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AppReferenceProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppReferenceProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app reference process was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppReferenceProcess"}},"schemaId":"components/schemas/AppReferenceProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The app reference process you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The app reference process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add app reference process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appReferenceProcesses~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppReferenceProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppReferenceProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-reference-processes/createappreferenceprocess"}],"panels":[]}]},"httpPath":"/appReferenceProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-reference-processes/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/app-reference-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/appReferenceProcesses/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/appReferenceProcesses/{tenantId}/batch","href":"app-reference-processes/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The app reference process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve app reference process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-reference-processes/executebatchoperations"}],"panels":[]}]},"httpPath":"/appReferenceProcesses/{tenantId}/batch"},{"label":"Returns a app reference process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-reference-processes/deleteappreferenceprocess","routeSlug":"/apis/certifications/certifications-v1/app-reference-processes/deleteappreferenceprocess","metadata":{"seo":{"title":"Returns a app reference process from the system by its ID.","description":"This method will delete a app reference process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAppReferenceProcess","name":"Returns a app reference process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a app reference process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a app reference process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the app reference process to delete.","required":true}],"pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/appReferenceProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/appReferenceProcesses/{tenantId}/{id}","href":"app-reference-processes/deleteappreferenceprocess","openApiOperationId":"deleteAppReferenceProcess","summary":"Returns a app reference process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app reference process was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The app reference process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The app reference process could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete app reference process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-reference-processes/deleteappreferenceprocess"}],"panels":[]}]},"httpPath":"/appReferenceProcesses/{tenantId}/{id}"},{"label":"Returns a app reference process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-reference-processes/getappreferenceprocess","routeSlug":"/apis/certifications/certifications-v1/app-reference-processes/getappreferenceprocess","metadata":{"seo":{"title":"Returns a app reference process from the system by its ID.","description":"This method will look up a app reference process by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppReferenceProcess","name":"Returns a app reference process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a app reference process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a app reference process by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the app reference process to return.","required":true}],"pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/appReferenceProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/appReferenceProcesses/{tenantId}/{id}","href":"app-reference-processes/getappreferenceprocess","openApiOperationId":"getAppReferenceProcess","summary":"Returns a app reference process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app reference process was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppReferenceProcess"}},"schemaId":"components/schemas/AppReferenceProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The app reference process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve app reference process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppReferenceProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppReferenceProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-reference-processes/getappreferenceprocess"}],"panels":[]}]},"httpPath":"/appReferenceProcesses/{tenantId}/{id}"},{"label":"Partially updates a app reference process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-reference-processes/patchappreferenceprocess","routeSlug":"/apis/certifications/certifications-v1/app-reference-processes/patchappreferenceprocess","metadata":{"seo":{"title":"Partially updates a app reference process with the specified ID.","description":"This method will patch an existing app reference process with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAppReferenceProcess","name":"Partially updates a app reference process with the specified ID.","isWebhook":false,"pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a app reference process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing app reference process with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the app reference process to patch.","required":true}],"pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/appReferenceProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/appReferenceProcesses/{tenantId}/{id}","href":"app-reference-processes/patchappreferenceprocess","openApiOperationId":"patchAppReferenceProcess","summary":"Partially updates a app reference process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app reference process was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppReferenceProcess"}},"schemaId":"components/schemas/AppReferenceProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The app reference process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The app reference process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve app reference process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppReferenceProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppReferenceProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-reference-processes/patchappreferenceprocess"}],"panels":[]}]},"httpPath":"/appReferenceProcesses/{tenantId}/{id}"},{"label":"Updates a app reference process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-reference-processes/updateappreferenceprocess","routeSlug":"/apis/certifications/certifications-v1/app-reference-processes/updateappreferenceprocess","metadata":{"seo":{"title":"Updates a app reference process with the specified ID.","description":"This method will update an existing app reference process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAppReferenceProcess","name":"Updates a app reference process with the specified ID.","isWebhook":false,"pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a app reference process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing app reference process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the app reference process to update.","required":true}],"pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppReferenceProcess"}},"schemaId":"components/schemas/AppReferenceProcess","pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1{id}/put/requestBody","description":"The updated app reference process that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/appReferenceProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppReferenceProcess"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/appReferenceProcesses/{tenantId}/{id}","href":"app-reference-processes/updateappreferenceprocess","openApiOperationId":"updateAppReferenceProcess","summary":"Updates a app reference process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AppReferenceProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppReferenceProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app reference process was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppReferenceProcess"}},"schemaId":"components/schemas/AppReferenceProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The app reference process supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The app reference process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The app reference process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve app reference process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appReferenceProcesses~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppReferenceProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppReferenceProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-reference-processes/updateappreferenceprocess"}],"panels":[]}]},"httpPath":"/appReferenceProcesses/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"App Reference Processes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"App Reference Processes","showPageActions":true},{"nodeType":"markdoc","content":"App Reference Processes"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/appReferenceProcesses/{tenantId}","summary":"Gets all of the app reference processes in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/app-reference-processes/listappreferenceprocesses","deprecated":false},{"title":"/appReferenceProcesses/{tenantId}","summary":"Creates a new app reference process record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/app-reference-processes/createappreferenceprocess","deprecated":false},{"title":"/appReferenceProcesses/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/app-reference-processes/executebatchoperations","deprecated":false},{"title":"/appReferenceProcesses/{tenantId}/{id}","summary":"Returns a app reference process from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/app-reference-processes/deleteappreferenceprocess","deprecated":false},{"title":"/appReferenceProcesses/{tenantId}/{id}","summary":"Returns a app reference process from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/app-reference-processes/getappreferenceprocess","deprecated":false},{"title":"/appReferenceProcesses/{tenantId}/{id}","summary":"Partially updates a app reference process with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/app-reference-processes/patchappreferenceprocess","deprecated":false},{"title":"/appReferenceProcesses/{tenantId}/{id}","summary":"Updates a app reference process with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/app-reference-processes/updateappreferenceprocess","deprecated":false}]}]}]}]}},{"type":"group","label":"App Reference Types","link":"/apis/certifications/certifications-v1/app-reference-types","routeSlug":"/apis/certifications/certifications-v1/app-reference-types","items":[{"label":"Gets all of the app reference types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-reference-types/listappreferencetypes","routeSlug":"/apis/certifications/certifications-v1/app-reference-types/listappreferencetypes","metadata":{"seo":{"title":"Gets all of the app reference types in the system.","description":"This method will scan all app reference types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAppReferenceTypes","name":"Gets all of the app reference types in the system.","isWebhook":false,"pointer":"/paths/~1appReferenceTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the app reference types in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all app reference types and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1appReferenceTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1appReferenceTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/appReferenceTypes/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/appReferenceTypes/{tenantId}","href":"app-reference-types/listappreferencetypes","openApiOperationId":"listAppReferenceTypes","summary":"Gets all of the app reference types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app reference typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_373"}},"schemaId":"schema_373","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appReferenceTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_373","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_373"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-reference-types/listappreferencetypes"}],"panels":[]}]},"httpPath":"/appReferenceTypes/{tenantId}"},{"label":"Creates a new app reference type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-reference-types/createappreferencetype","routeSlug":"/apis/certifications/certifications-v1/app-reference-types/createappreferencetype","metadata":{"seo":{"title":"Creates a new app reference type record that does not already exist.","description":"This method will auto-generate an ID and create a new app reference type. If an ID is specified for the app reference type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAppReferenceType","name":"Creates a new app reference type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1appReferenceTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new app reference type record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new app reference type. If an ID is specified for the app reference type, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1appReferenceTypes~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppReferenceType"}},"schemaId":"components/schemas/AppReferenceType","pointer":"/paths/~1appReferenceTypes~1{tenantId}/post/requestBody","description":"The app reference type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/appReferenceTypes/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppReferenceType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/appReferenceTypes/{tenantId}","href":"app-reference-types/createappreferencetype","openApiOperationId":"createAppReferenceType","summary":"Creates a new app reference type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AppReferenceType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppReferenceType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app reference type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppReferenceType"}},"schemaId":"components/schemas/AppReferenceType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The app reference type you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The app reference type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add app reference type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appReferenceTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppReferenceType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppReferenceType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-reference-types/createappreferencetype"}],"panels":[]}]},"httpPath":"/appReferenceTypes/{tenantId}"},{"label":"Returns a app reference type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-reference-types/deleteappreferencetype","routeSlug":"/apis/certifications/certifications-v1/app-reference-types/deleteappreferencetype","metadata":{"seo":{"title":"Returns a app reference type from the system by its ID.","description":"This method will delete a app reference type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAppReferenceType","name":"Returns a app reference type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1appReferenceTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a app reference type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a app reference type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the app reference type to delete.","required":true}],"pointer":"/paths/~1appReferenceTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/appReferenceTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/appReferenceTypes/{tenantId}/{id}","href":"app-reference-types/deleteappreferencetype","openApiOperationId":"deleteAppReferenceType","summary":"Returns a app reference type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app reference type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The app reference type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The app reference type could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete app reference type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appReferenceTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-reference-types/deleteappreferencetype"}],"panels":[]}]},"httpPath":"/appReferenceTypes/{tenantId}/{id}"},{"label":"Returns a app reference type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-reference-types/getappreferencetype","routeSlug":"/apis/certifications/certifications-v1/app-reference-types/getappreferencetype","metadata":{"seo":{"title":"Returns a app reference type from the system by its ID.","description":"This method will look up a app reference type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppReferenceType","name":"Returns a app reference type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1appReferenceTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a app reference type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a app reference type by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the app reference type to return.","required":true}],"pointer":"/paths/~1appReferenceTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1appReferenceTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/appReferenceTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/appReferenceTypes/{tenantId}/{id}","href":"app-reference-types/getappreferencetype","openApiOperationId":"getAppReferenceType","summary":"Returns a app reference type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app reference type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppReferenceType"}},"schemaId":"components/schemas/AppReferenceType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The app reference type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve app reference type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appReferenceTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppReferenceType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppReferenceType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-reference-types/getappreferencetype"}],"panels":[]}]},"httpPath":"/appReferenceTypes/{tenantId}/{id}"},{"label":"Partially updates a app reference type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-reference-types/patchappreferencetype","routeSlug":"/apis/certifications/certifications-v1/app-reference-types/patchappreferencetype","metadata":{"seo":{"title":"Partially updates a app reference type with the specified ID.","description":"This method will patch an existing app reference type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAppReferenceType","name":"Partially updates a app reference type with the specified ID.","isWebhook":false,"pointer":"/paths/~1appReferenceTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a app reference type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing app reference type with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the app reference type to patch.","required":true}],"pointer":"/paths/~1appReferenceTypes~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1appReferenceTypes~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/appReferenceTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/appReferenceTypes/{tenantId}/{id}","href":"app-reference-types/patchappreferencetype","openApiOperationId":"patchAppReferenceType","summary":"Partially updates a app reference type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app reference type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppReferenceType"}},"schemaId":"components/schemas/AppReferenceType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The app reference type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The app reference type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve app reference type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appReferenceTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppReferenceType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppReferenceType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-reference-types/patchappreferencetype"}],"panels":[]}]},"httpPath":"/appReferenceTypes/{tenantId}/{id}"},{"label":"Updates a app reference type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-reference-types/updateappreferencetype","routeSlug":"/apis/certifications/certifications-v1/app-reference-types/updateappreferencetype","metadata":{"seo":{"title":"Updates a app reference type with the specified ID.","description":"This method will update an existing app reference type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAppReferenceType","name":"Updates a app reference type with the specified ID.","isWebhook":false,"pointer":"/paths/~1appReferenceTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a app reference type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing app reference type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the app reference type to update.","required":true}],"pointer":"/paths/~1appReferenceTypes~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppReferenceType"}},"schemaId":"components/schemas/AppReferenceType","pointer":"/paths/~1appReferenceTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated app reference type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/appReferenceTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppReferenceType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/appReferenceTypes/{tenantId}/{id}","href":"app-reference-types/updateappreferencetype","openApiOperationId":"updateAppReferenceType","summary":"Updates a app reference type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AppReferenceType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppReferenceType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app reference type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppReferenceType"}},"schemaId":"components/schemas/AppReferenceType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The app reference type supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The app reference type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The app reference type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve app reference type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appReferenceTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppReferenceType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppReferenceType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-reference-types/updateappreferencetype"}],"panels":[]}]},"httpPath":"/appReferenceTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"App Reference Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"App Reference Types","showPageActions":true},{"nodeType":"markdoc","content":"App Reference Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/appReferenceTypes/{tenantId}","summary":"Gets all of the app reference types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/app-reference-types/listappreferencetypes","deprecated":false},{"title":"/appReferenceTypes/{tenantId}","summary":"Creates a new app reference type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/app-reference-types/createappreferencetype","deprecated":false},{"title":"/appReferenceTypes/{tenantId}/{id}","summary":"Returns a app reference type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/app-reference-types/deleteappreferencetype","deprecated":false},{"title":"/appReferenceTypes/{tenantId}/{id}","summary":"Returns a app reference type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/app-reference-types/getappreferencetype","deprecated":false},{"title":"/appReferenceTypes/{tenantId}/{id}","summary":"Partially updates a app reference type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/app-reference-types/patchappreferencetype","deprecated":false},{"title":"/appReferenceTypes/{tenantId}/{id}","summary":"Updates a app reference type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/app-reference-types/updateappreferencetype","deprecated":false}]}]}]}]}},{"type":"group","label":"App Status Reasons","link":"/apis/certifications/certifications-v1/app-status-reasons","routeSlug":"/apis/certifications/certifications-v1/app-status-reasons","items":[{"label":"Gets all of the app status reasons in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-status-reasons/listappstatusreasons","routeSlug":"/apis/certifications/certifications-v1/app-status-reasons/listappstatusreasons","metadata":{"seo":{"title":"Gets all of the app status reasons in the system.","description":"This method will scan all app status reasons and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAppStatusReasons","name":"Gets all of the app status reasons in the system.","isWebhook":false,"pointer":"/paths/~1appStatusReasons~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the app status reasons in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all app status reasons and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1appStatusReasons~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1appStatusReasons~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/appStatusReasons/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/appStatusReasons/{tenantId}","href":"app-status-reasons/listappstatusreasons","openApiOperationId":"listAppStatusReasons","summary":"Gets all of the app status reasons in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app status reasonswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}},"schemaId":"schema_374","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appStatusReasons~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_374","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_374"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-status-reasons/listappstatusreasons"}],"panels":[]}]},"httpPath":"/appStatusReasons/{tenantId}"},{"label":"Creates a new app status reason record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-status-reasons/createappstatusreason","routeSlug":"/apis/certifications/certifications-v1/app-status-reasons/createappstatusreason","metadata":{"seo":{"title":"Creates a new app status reason record that does not already exist.","description":"This method will auto-generate an ID and create a new app status reason. If an ID is specified for the app status reason, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAppStatusReason","name":"Creates a new app status reason record that does not already exist.","isWebhook":false,"pointer":"/paths/~1appStatusReasons~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new app status reason record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new app status reason. If an ID is specified for the app status reason, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1appStatusReasons~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppStatusReason"}},"schemaId":"components/schemas/AppStatusReason","pointer":"/paths/~1appStatusReasons~1{tenantId}/post/requestBody","description":"The app status reason that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/appStatusReasons/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppStatusReason"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/appStatusReasons/{tenantId}","href":"app-status-reasons/createappstatusreason","openApiOperationId":"createAppStatusReason","summary":"Creates a new app status reason record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AppStatusReason","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppStatusReason"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app status reason was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppStatusReason"}},"schemaId":"components/schemas/AppStatusReason","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The app status reason you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The app status reason could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add app status reason based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appStatusReasons~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppStatusReason","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppStatusReason"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-status-reasons/createappstatusreason"}],"panels":[]}]},"httpPath":"/appStatusReasons/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-status-reasons/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/app-status-reasons/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1appStatusReasons~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1appStatusReasons~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1appStatusReasons~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/appStatusReasons/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/appStatusReasons/{tenantId}/batch","href":"app-status-reasons/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The app status reason could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve app status reason based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appStatusReasons~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-status-reasons/executebatchoperations"}],"panels":[]}]},"httpPath":"/appStatusReasons/{tenantId}/batch"},{"label":"Returns a app status reason from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-status-reasons/deleteappstatusreason","routeSlug":"/apis/certifications/certifications-v1/app-status-reasons/deleteappstatusreason","metadata":{"seo":{"title":"Returns a app status reason from the system by its ID.","description":"This method will delete a app status reason with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAppStatusReason","name":"Returns a app status reason from the system by its ID.","isWebhook":false,"pointer":"/paths/~1appStatusReasons~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a app status reason from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a app status reason with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the app status reason to delete.","required":true}],"pointer":"/paths/~1appStatusReasons~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/appStatusReasons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/appStatusReasons/{tenantId}/{id}","href":"app-status-reasons/deleteappstatusreason","openApiOperationId":"deleteAppStatusReason","summary":"Returns a app status reason from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app status reason was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The app status reason could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The app status reason could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete app status reason based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appStatusReasons~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-status-reasons/deleteappstatusreason"}],"panels":[]}]},"httpPath":"/appStatusReasons/{tenantId}/{id}"},{"label":"Returns a app status reason from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-status-reasons/getappstatusreason","routeSlug":"/apis/certifications/certifications-v1/app-status-reasons/getappstatusreason","metadata":{"seo":{"title":"Returns a app status reason from the system by its ID.","description":"This method will look up a app status reason by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppStatusReason","name":"Returns a app status reason from the system by its ID.","isWebhook":false,"pointer":"/paths/~1appStatusReasons~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a app status reason from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a app status reason by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the app status reason to return.","required":true}],"pointer":"/paths/~1appStatusReasons~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1appStatusReasons~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/appStatusReasons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/appStatusReasons/{tenantId}/{id}","href":"app-status-reasons/getappstatusreason","openApiOperationId":"getAppStatusReason","summary":"Returns a app status reason from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app status reason was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppStatusReason"}},"schemaId":"components/schemas/AppStatusReason","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The app status reason could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve app status reason based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appStatusReasons~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppStatusReason","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppStatusReason"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-status-reasons/getappstatusreason"}],"panels":[]}]},"httpPath":"/appStatusReasons/{tenantId}/{id}"},{"label":"Partially updates a app status reason with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-status-reasons/patchappstatusreason","routeSlug":"/apis/certifications/certifications-v1/app-status-reasons/patchappstatusreason","metadata":{"seo":{"title":"Partially updates a app status reason with the specified ID.","description":"This method will patch an existing app status reason with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAppStatusReason","name":"Partially updates a app status reason with the specified ID.","isWebhook":false,"pointer":"/paths/~1appStatusReasons~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a app status reason with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing app status reason with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the app status reason to patch.","required":true}],"pointer":"/paths/~1appStatusReasons~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1appStatusReasons~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/appStatusReasons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/appStatusReasons/{tenantId}/{id}","href":"app-status-reasons/patchappstatusreason","openApiOperationId":"patchAppStatusReason","summary":"Partially updates a app status reason with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app status reason was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppStatusReason"}},"schemaId":"components/schemas/AppStatusReason","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The app status reason could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The app status reason could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve app status reason based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appStatusReasons~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppStatusReason","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppStatusReason"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-status-reasons/patchappstatusreason"}],"panels":[]}]},"httpPath":"/appStatusReasons/{tenantId}/{id}"},{"label":"Updates a app status reason with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/app-status-reasons/updateappstatusreason","routeSlug":"/apis/certifications/certifications-v1/app-status-reasons/updateappstatusreason","metadata":{"seo":{"title":"Updates a app status reason with the specified ID.","description":"This method will update an existing app status reason with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAppStatusReason","name":"Updates a app status reason with the specified ID.","isWebhook":false,"pointer":"/paths/~1appStatusReasons~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a app status reason with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing app status reason with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the app status reason to update.","required":true}],"pointer":"/paths/~1appStatusReasons~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppStatusReason"}},"schemaId":"components/schemas/AppStatusReason","pointer":"/paths/~1appStatusReasons~1{tenantId}~1{id}/put/requestBody","description":"The updated app status reason that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/appStatusReasons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppStatusReason"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/appStatusReasons/{tenantId}/{id}","href":"app-status-reasons/updateappstatusreason","openApiOperationId":"updateAppStatusReason","summary":"Updates a app status reason with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AppStatusReason","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppStatusReason"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The app status reason was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppStatusReason"}},"schemaId":"components/schemas/AppStatusReason","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The app status reason supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The app status reason could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The app status reason could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve app status reason based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1appStatusReasons~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppStatusReason","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppStatusReason"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-status-reasons/updateappstatusreason"}],"panels":[]}]},"httpPath":"/appStatusReasons/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"App Status Reasons"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"App Status Reasons","showPageActions":true},{"nodeType":"markdoc","content":"App Status Reasons"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/appStatusReasons/{tenantId}","summary":"Gets all of the app status reasons in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/app-status-reasons/listappstatusreasons","deprecated":false},{"title":"/appStatusReasons/{tenantId}","summary":"Creates a new app status reason record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/app-status-reasons/createappstatusreason","deprecated":false},{"title":"/appStatusReasons/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/app-status-reasons/executebatchoperations","deprecated":false},{"title":"/appStatusReasons/{tenantId}/{id}","summary":"Returns a app status reason from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/app-status-reasons/deleteappstatusreason","deprecated":false},{"title":"/appStatusReasons/{tenantId}/{id}","summary":"Returns a app status reason from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/app-status-reasons/getappstatusreason","deprecated":false},{"title":"/appStatusReasons/{tenantId}/{id}","summary":"Partially updates a app status reason with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/app-status-reasons/patchappstatusreason","deprecated":false},{"title":"/appStatusReasons/{tenantId}/{id}","summary":"Updates a app status reason with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/app-status-reasons/updateappstatusreason","deprecated":false}]}]}]}]}},{"type":"group","label":"Application Fees","link":"/apis/certifications/certifications-v1/application-fees","routeSlug":"/apis/certifications/certifications-v1/application-fees","items":[{"label":"Gets all of the application fees in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-fees/listapplicationfees","routeSlug":"/apis/certifications/certifications-v1/application-fees/listapplicationfees","metadata":{"seo":{"title":"Gets all of the application fees in the system.","description":"This method will scan all application fees and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listApplicationFees","name":"Gets all of the application fees in the system.","isWebhook":false,"pointer":"/paths/~1applicationFees~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the application fees in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all application fees and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationFees~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1applicationFees~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicationFees/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationFees/{tenantId}","href":"application-fees/listapplicationfees","openApiOperationId":"listApplicationFees","summary":"Gets all of the application fees in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application feeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_375"}},"schemaId":"schema_375","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationFees~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_375","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_375"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-fees/listapplicationfees"}],"panels":[]}]},"httpPath":"/applicationFees/{tenantId}"},{"label":"Creates a new application fee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-fees/createapplicationfee","routeSlug":"/apis/certifications/certifications-v1/application-fees/createapplicationfee","metadata":{"seo":{"title":"Creates a new application fee record that does not already exist.","description":"This method will auto-generate an ID and create a new application fee. If an ID is specified for the application fee, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createApplicationFee","name":"Creates a new application fee record that does not already exist.","isWebhook":false,"pointer":"/paths/~1applicationFees~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new application fee record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new application fee. If an ID is specified for the application fee, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationFees~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationFee"}},"schemaId":"components/schemas/ApplicationFee","pointer":"/paths/~1applicationFees~1{tenantId}/post/requestBody","description":"The application fee that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicationFees/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplicationFee"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/applicationFees/{tenantId}","href":"application-fees/createapplicationfee","openApiOperationId":"createApplicationFee","summary":"Creates a new application fee record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ApplicationFee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationFee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application fee was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationFee"}},"schemaId":"components/schemas/ApplicationFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The application fee you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add application fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationFees~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-fees/createapplicationfee"}],"panels":[]}]},"httpPath":"/applicationFees/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-fees/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/application-fees/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1applicationFees~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationFees~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1applicationFees~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicationFees/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationFees/{tenantId}/batch","href":"application-fees/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationFees~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-fees/executebatchoperations"}],"panels":[]}]},"httpPath":"/applicationFees/{tenantId}/batch"},{"label":"Returns a application fee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-fees/deleteapplicationfee","routeSlug":"/apis/certifications/certifications-v1/application-fees/deleteapplicationfee","metadata":{"seo":{"title":"Returns a application fee from the system by its ID.","description":"This method will delete a application fee with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteApplicationFee","name":"Returns a application fee from the system by its ID.","isWebhook":false,"pointer":"/paths/~1applicationFees~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a application fee from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a application fee with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application fee to delete.","required":true}],"pointer":"/paths/~1applicationFees~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/applicationFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/applicationFees/{tenantId}/{id}","href":"application-fees/deleteapplicationfee","openApiOperationId":"deleteApplicationFee","summary":"Returns a application fee from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application fee was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application fee could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete application fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationFees~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-fees/deleteapplicationfee"}],"panels":[]}]},"httpPath":"/applicationFees/{tenantId}/{id}"},{"label":"Returns a application fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-fees/getapplicationfee","routeSlug":"/apis/certifications/certifications-v1/application-fees/getapplicationfee","metadata":{"seo":{"title":"Returns a application fee from the system by its ID.","description":"This method will look up a application fee by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getApplicationFee","name":"Returns a application fee from the system by its ID.","isWebhook":false,"pointer":"/paths/~1applicationFees~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a application fee from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a application fee by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application fee to return.","required":true}],"pointer":"/paths/~1applicationFees~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1applicationFees~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicationFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationFees/{tenantId}/{id}","href":"application-fees/getapplicationfee","openApiOperationId":"getApplicationFee","summary":"Returns a application fee from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application fee was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationFee"}},"schemaId":"components/schemas/ApplicationFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationFees~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-fees/getapplicationfee"}],"panels":[]}]},"httpPath":"/applicationFees/{tenantId}/{id}"},{"label":"Partially updates a application fee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-fees/patchapplicationfee","routeSlug":"/apis/certifications/certifications-v1/application-fees/patchapplicationfee","metadata":{"seo":{"title":"Partially updates a application fee with the specified ID.","description":"This method will patch an existing application fee with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchApplicationFee","name":"Partially updates a application fee with the specified ID.","isWebhook":false,"pointer":"/paths/~1applicationFees~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a application fee with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing application fee with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application fee to patch.","required":true}],"pointer":"/paths/~1applicationFees~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1applicationFees~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/applicationFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/applicationFees/{tenantId}/{id}","href":"application-fees/patchapplicationfee","openApiOperationId":"patchApplicationFee","summary":"Partially updates a application fee with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application fee was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationFee"}},"schemaId":"components/schemas/ApplicationFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationFees~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-fees/patchapplicationfee"}],"panels":[]}]},"httpPath":"/applicationFees/{tenantId}/{id}"},{"label":"Updates a application fee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-fees/updateapplicationfee","routeSlug":"/apis/certifications/certifications-v1/application-fees/updateapplicationfee","metadata":{"seo":{"title":"Updates a application fee with the specified ID.","description":"This method will update an existing application fee with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateApplicationFee","name":"Updates a application fee with the specified ID.","isWebhook":false,"pointer":"/paths/~1applicationFees~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a application fee with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing application fee with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application fee to update.","required":true}],"pointer":"/paths/~1applicationFees~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationFee"}},"schemaId":"components/schemas/ApplicationFee","pointer":"/paths/~1applicationFees~1{tenantId}~1{id}/put/requestBody","description":"The updated application fee that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/applicationFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplicationFee"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/applicationFees/{tenantId}/{id}","href":"application-fees/updateapplicationfee","openApiOperationId":"updateApplicationFee","summary":"Updates a application fee with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ApplicationFee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationFee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application fee was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationFee"}},"schemaId":"components/schemas/ApplicationFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The application fee supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationFees~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-fees/updateapplicationfee"}],"panels":[]}]},"httpPath":"/applicationFees/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Application Fees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Application Fees","showPageActions":true},{"nodeType":"markdoc","content":"Application Fees"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/applicationFees/{tenantId}","summary":"Gets all of the application fees in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-fees/listapplicationfees","deprecated":false},{"title":"/applicationFees/{tenantId}","summary":"Creates a new application fee record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application-fees/createapplicationfee","deprecated":false},{"title":"/applicationFees/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application-fees/executebatchoperations","deprecated":false},{"title":"/applicationFees/{tenantId}/{id}","summary":"Returns a application fee from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/application-fees/deleteapplicationfee","deprecated":false},{"title":"/applicationFees/{tenantId}/{id}","summary":"Returns a application fee from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-fees/getapplicationfee","deprecated":false},{"title":"/applicationFees/{tenantId}/{id}","summary":"Partially updates a application fee with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/application-fees/patchapplicationfee","deprecated":false},{"title":"/applicationFees/{tenantId}/{id}","summary":"Updates a application fee with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/application-fees/updateapplicationfee","deprecated":false}]}]}]}]}},{"type":"group","label":"Application Notices","link":"/apis/certifications/certifications-v1/application-notices","routeSlug":"/apis/certifications/certifications-v1/application-notices","items":[{"label":"Gets all of the application notices in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-notices/listapplicationnotices","routeSlug":"/apis/certifications/certifications-v1/application-notices/listapplicationnotices","metadata":{"seo":{"title":"Gets all of the application notices in the system.","description":"This method will scan all application notices and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listApplicationNotices","name":"Gets all of the application notices in the system.","isWebhook":false,"pointer":"/paths/~1applicationNotices~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the application notices in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all application notices and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationNotices~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1applicationNotices~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicationNotices/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationNotices/{tenantId}","href":"application-notices/listapplicationnotices","openApiOperationId":"listApplicationNotices","summary":"Gets all of the application notices in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application noticeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_376"}},"schemaId":"schema_376","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationNotices~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_376","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_376"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-notices/listapplicationnotices"}],"panels":[]}]},"httpPath":"/applicationNotices/{tenantId}"},{"label":"Creates a new application notice record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-notices/createapplicationnotice","routeSlug":"/apis/certifications/certifications-v1/application-notices/createapplicationnotice","metadata":{"seo":{"title":"Creates a new application notice record that does not already exist.","description":"This method will auto-generate an ID and create a new application notice. If an ID is specified for the application notice, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createApplicationNotice","name":"Creates a new application notice record that does not already exist.","isWebhook":false,"pointer":"/paths/~1applicationNotices~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new application notice record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new application notice. If an ID is specified for the application notice, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationNotices~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationNotice"}},"schemaId":"components/schemas/ApplicationNotice","pointer":"/paths/~1applicationNotices~1{tenantId}/post/requestBody","description":"The application notice that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicationNotices/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplicationNotice"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/applicationNotices/{tenantId}","href":"application-notices/createapplicationnotice","openApiOperationId":"createApplicationNotice","summary":"Creates a new application notice record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ApplicationNotice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationNotice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application notice was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationNotice"}},"schemaId":"components/schemas/ApplicationNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The application notice you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add application notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationNotices~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-notices/createapplicationnotice"}],"panels":[]}]},"httpPath":"/applicationNotices/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-notices/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/application-notices/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1applicationNotices~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationNotices~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1applicationNotices~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicationNotices/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationNotices/{tenantId}/batch","href":"application-notices/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationNotices~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-notices/executebatchoperations"}],"panels":[]}]},"httpPath":"/applicationNotices/{tenantId}/batch"},{"label":"Returns a application notice from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-notices/deleteapplicationnotice","routeSlug":"/apis/certifications/certifications-v1/application-notices/deleteapplicationnotice","metadata":{"seo":{"title":"Returns a application notice from the system by its ID.","description":"This method will delete a application notice with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteApplicationNotice","name":"Returns a application notice from the system by its ID.","isWebhook":false,"pointer":"/paths/~1applicationNotices~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a application notice from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a application notice with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application notice to delete.","required":true}],"pointer":"/paths/~1applicationNotices~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/applicationNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/applicationNotices/{tenantId}/{id}","href":"application-notices/deleteapplicationnotice","openApiOperationId":"deleteApplicationNotice","summary":"Returns a application notice from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application notice was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application notice could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete application notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationNotices~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-notices/deleteapplicationnotice"}],"panels":[]}]},"httpPath":"/applicationNotices/{tenantId}/{id}"},{"label":"Returns a application notice from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-notices/getapplicationnotice","routeSlug":"/apis/certifications/certifications-v1/application-notices/getapplicationnotice","metadata":{"seo":{"title":"Returns a application notice from the system by its ID.","description":"This method will look up a application notice by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getApplicationNotice","name":"Returns a application notice from the system by its ID.","isWebhook":false,"pointer":"/paths/~1applicationNotices~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a application notice from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a application notice by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application notice to return.","required":true}],"pointer":"/paths/~1applicationNotices~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1applicationNotices~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicationNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationNotices/{tenantId}/{id}","href":"application-notices/getapplicationnotice","openApiOperationId":"getApplicationNotice","summary":"Returns a application notice from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application notice was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationNotice"}},"schemaId":"components/schemas/ApplicationNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationNotices~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-notices/getapplicationnotice"}],"panels":[]}]},"httpPath":"/applicationNotices/{tenantId}/{id}"},{"label":"Partially updates a application notice with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-notices/patchapplicationnotice","routeSlug":"/apis/certifications/certifications-v1/application-notices/patchapplicationnotice","metadata":{"seo":{"title":"Partially updates a application notice with the specified ID.","description":"This method will patch an existing application notice with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchApplicationNotice","name":"Partially updates a application notice with the specified ID.","isWebhook":false,"pointer":"/paths/~1applicationNotices~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a application notice with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing application notice with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application notice to patch.","required":true}],"pointer":"/paths/~1applicationNotices~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1applicationNotices~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/applicationNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/applicationNotices/{tenantId}/{id}","href":"application-notices/patchapplicationnotice","openApiOperationId":"patchApplicationNotice","summary":"Partially updates a application notice with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application notice was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationNotice"}},"schemaId":"components/schemas/ApplicationNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationNotices~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-notices/patchapplicationnotice"}],"panels":[]}]},"httpPath":"/applicationNotices/{tenantId}/{id}"},{"label":"Updates a application notice with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-notices/updateapplicationnotice","routeSlug":"/apis/certifications/certifications-v1/application-notices/updateapplicationnotice","metadata":{"seo":{"title":"Updates a application notice with the specified ID.","description":"This method will update an existing application notice with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateApplicationNotice","name":"Updates a application notice with the specified ID.","isWebhook":false,"pointer":"/paths/~1applicationNotices~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a application notice with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing application notice with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application notice to update.","required":true}],"pointer":"/paths/~1applicationNotices~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationNotice"}},"schemaId":"components/schemas/ApplicationNotice","pointer":"/paths/~1applicationNotices~1{tenantId}~1{id}/put/requestBody","description":"The updated application notice that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/applicationNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplicationNotice"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/applicationNotices/{tenantId}/{id}","href":"application-notices/updateapplicationnotice","openApiOperationId":"updateApplicationNotice","summary":"Updates a application notice with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ApplicationNotice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationNotice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application notice was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationNotice"}},"schemaId":"components/schemas/ApplicationNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The application notice supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationNotices~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-notices/updateapplicationnotice"}],"panels":[]}]},"httpPath":"/applicationNotices/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Application Notices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Application Notices","showPageActions":true},{"nodeType":"markdoc","content":"Application Notices"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/applicationNotices/{tenantId}","summary":"Gets all of the application notices in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-notices/listapplicationnotices","deprecated":false},{"title":"/applicationNotices/{tenantId}","summary":"Creates a new application notice record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application-notices/createapplicationnotice","deprecated":false},{"title":"/applicationNotices/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application-notices/executebatchoperations","deprecated":false},{"title":"/applicationNotices/{tenantId}/{id}","summary":"Returns a application notice from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/application-notices/deleteapplicationnotice","deprecated":false},{"title":"/applicationNotices/{tenantId}/{id}","summary":"Returns a application notice from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-notices/getapplicationnotice","deprecated":false},{"title":"/applicationNotices/{tenantId}/{id}","summary":"Partially updates a application notice with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/application-notices/patchapplicationnotice","deprecated":false},{"title":"/applicationNotices/{tenantId}/{id}","summary":"Updates a application notice with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/application-notices/updateapplicationnotice","deprecated":false}]}]}]}]}},{"type":"group","label":"Application Processes","link":"/apis/certifications/certifications-v1/application-processes","routeSlug":"/apis/certifications/certifications-v1/application-processes","items":[{"label":"Gets all of the application processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-processes/listapplicationprocesses","routeSlug":"/apis/certifications/certifications-v1/application-processes/listapplicationprocesses","metadata":{"seo":{"title":"Gets all of the application processes in the system.","description":"This method will scan all application processes and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listApplicationProcesses","name":"Gets all of the application processes in the system.","isWebhook":false,"pointer":"/paths/~1applicationProcesses~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the application processes in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all application processes and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationProcesses~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1applicationProcesses~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicationProcesses/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationProcesses/{tenantId}","href":"application-processes/listapplicationprocesses","openApiOperationId":"listApplicationProcesses","summary":"Gets all of the application processes in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application processeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_377"}},"schemaId":"schema_377","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationProcesses~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_377","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_377"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-processes/listapplicationprocesses"}],"panels":[]}]},"httpPath":"/applicationProcesses/{tenantId}"},{"label":"Creates a new application process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-processes/createapplicationprocess","routeSlug":"/apis/certifications/certifications-v1/application-processes/createapplicationprocess","metadata":{"seo":{"title":"Creates a new application process record that does not already exist.","description":"This method will auto-generate an ID and create a new application process. If an ID is specified for the application process, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createApplicationProcess","name":"Creates a new application process record that does not already exist.","isWebhook":false,"pointer":"/paths/~1applicationProcesses~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new application process record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new application process. If an ID is specified for the application process, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationProcesses~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationProcess"}},"schemaId":"components/schemas/ApplicationProcess","pointer":"/paths/~1applicationProcesses~1{tenantId}/post/requestBody","description":"The application process that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicationProcesses/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplicationProcess"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/applicationProcesses/{tenantId}","href":"application-processes/createapplicationprocess","openApiOperationId":"createApplicationProcess","summary":"Creates a new application process record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ApplicationProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application process was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationProcess"}},"schemaId":"components/schemas/ApplicationProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The application process you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add application process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationProcesses~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-processes/createapplicationprocess"}],"panels":[]}]},"httpPath":"/applicationProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-processes/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/application-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1applicationProcesses~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1applicationProcesses~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicationProcesses/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationProcesses/{tenantId}/batch","href":"application-processes/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-processes/executebatchoperations"}],"panels":[]}]},"httpPath":"/applicationProcesses/{tenantId}/batch"},{"label":"Gets all of the processes a contact is eligible to use","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-processes/geteligibleprocesses","routeSlug":"/apis/certifications/certifications-v1/application-processes/geteligibleprocesses","metadata":{"seo":{"title":"Gets all of the processes a contact is eligible to use","description":"Gets all of the processes a contact is eligible to use"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEligibleProcesses","name":"Gets all of the processes a contact is eligible to use","isWebhook":false,"pointer":"/paths/~1applicationProcesses~1{tenantId}~1eligible~1{programId}~1{customerType}~1{contactOrOrganizationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the processes a contact is eligible to use","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true},{"name":"programId","in":"path","schemaId":"schema_366","description":"The certification program","required":true},{"name":"customerType","in":"path","schemaId":"schema_378","description":"The contact or organization type","required":true},{"name":"contactOrOrganizationId","in":"path","schemaId":"schema_366","description":"The contact or organization id","required":true}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1eligible~1{programId}~1{customerType}~1{contactOrOrganizationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicationProcesses/{tenantId}/eligible/{programId}/{customerType}/{contactOrOrganizationId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"programId","in":"path","required":true,"schemaId":"schema_366"},{"name":"customerType","in":"path","required":true,"schemaId":"schema_378"},{"name":"contactOrOrganizationId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationProcesses/{tenantId}/eligible/{programId}/{customerType}/{contactOrOrganizationId}","href":"application-processes/geteligibleprocesses","openApiOperationId":"getEligibleProcesses","summary":"Gets all of the processes a contact is eligible to use"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Processes were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_377"}},"schemaId":"schema_377","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1eligible~1{programId}~1{customerType}~1{contactOrOrganizationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_377","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_377"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-processes/geteligibleprocesses"}],"panels":[]}]},"httpPath":"/applicationProcesses/{tenantId}/eligible/{programId}/{customerType}/{contactOrOrganizationId}"},{"label":"Returns a list of records with the specified program_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-processes/listprocessesbyprogramid","routeSlug":"/apis/certifications/certifications-v1/application-processes/listprocessesbyprogramid","metadata":{"seo":{"title":"Returns a list of records with the specified program_id","description":"Returns a list of records with the specified program_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProcessesByProgramId","name":"Returns a list of records with the specified program_id","isWebhook":false,"pointer":"/paths/~1applicationProcesses~1{tenantId}~1program~1{program_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified program_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified program_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"program_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The program_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1program~1{program_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1program~1{program_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicationProcesses/{tenantId}/program/{program_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"program_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationProcesses/{tenantId}/program/{program_id}","href":"application-processes/listprocessesbyprogramid","openApiOperationId":"listProcessesByProgramId","summary":"Returns a list of records with the specified program_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListApplicationProcessesResponse"}},"schemaId":"components/schemas/ListApplicationProcessesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1program~1{program_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListApplicationProcessesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListApplicationProcessesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-processes/listprocessesbyprogramid"}],"panels":[]}]},"httpPath":"/applicationProcesses/{tenantId}/program/{program_id}"},{"label":"Returns a application process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-processes/deleteapplicationprocess","routeSlug":"/apis/certifications/certifications-v1/application-processes/deleteapplicationprocess","metadata":{"seo":{"title":"Returns a application process from the system by its ID.","description":"This method will delete a application process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteApplicationProcess","name":"Returns a application process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1applicationProcesses~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a application process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a application process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application process to delete.","required":true}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/applicationProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/applicationProcesses/{tenantId}/{id}","href":"application-processes/deleteapplicationprocess","openApiOperationId":"deleteApplicationProcess","summary":"Returns a application process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application process was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application process could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete application process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-processes/deleteapplicationprocess"}],"panels":[]}]},"httpPath":"/applicationProcesses/{tenantId}/{id}"},{"label":"Returns a application process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-processes/getapplicationprocess","routeSlug":"/apis/certifications/certifications-v1/application-processes/getapplicationprocess","metadata":{"seo":{"title":"Returns a application process from the system by its ID.","description":"This method will look up a application process by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getApplicationProcess","name":"Returns a application process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1applicationProcesses~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a application process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a application process by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application process to return.","required":true}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicationProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationProcesses/{tenantId}/{id}","href":"application-processes/getapplicationprocess","openApiOperationId":"getApplicationProcess","summary":"Returns a application process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application process was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationProcess"}},"schemaId":"components/schemas/ApplicationProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-processes/getapplicationprocess"}],"panels":[]}]},"httpPath":"/applicationProcesses/{tenantId}/{id}"},{"label":"Partially updates a application process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-processes/patchapplicationprocess","routeSlug":"/apis/certifications/certifications-v1/application-processes/patchapplicationprocess","metadata":{"seo":{"title":"Partially updates a application process with the specified ID.","description":"This method will patch an existing application process with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchApplicationProcess","name":"Partially updates a application process with the specified ID.","isWebhook":false,"pointer":"/paths/~1applicationProcesses~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a application process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing application process with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application process to patch.","required":true}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1applicationProcesses~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/applicationProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/applicationProcesses/{tenantId}/{id}","href":"application-processes/patchapplicationprocess","openApiOperationId":"patchApplicationProcess","summary":"Partially updates a application process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application process was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationProcess"}},"schemaId":"components/schemas/ApplicationProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-processes/patchapplicationprocess"}],"panels":[]}]},"httpPath":"/applicationProcesses/{tenantId}/{id}"},{"label":"Updates a application process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-processes/updateapplicationprocess","routeSlug":"/apis/certifications/certifications-v1/application-processes/updateapplicationprocess","metadata":{"seo":{"title":"Updates a application process with the specified ID.","description":"This method will update an existing application process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateApplicationProcess","name":"Updates a application process with the specified ID.","isWebhook":false,"pointer":"/paths/~1applicationProcesses~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a application process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing application process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application process to update.","required":true}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationProcess"}},"schemaId":"components/schemas/ApplicationProcess","pointer":"/paths/~1applicationProcesses~1{tenantId}~1{id}/put/requestBody","description":"The updated application process that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/applicationProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplicationProcess"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/applicationProcesses/{tenantId}/{id}","href":"application-processes/updateapplicationprocess","openApiOperationId":"updateApplicationProcess","summary":"Updates a application process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ApplicationProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application process was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationProcess"}},"schemaId":"components/schemas/ApplicationProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The application process supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-processes/updateapplicationprocess"}],"panels":[]}]},"httpPath":"/applicationProcesses/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Application Processes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Application Processes","showPageActions":true},{"nodeType":"markdoc","content":"Application Processes"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/applicationProcesses/{tenantId}","summary":"Gets all of the application processes in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-processes/listapplicationprocesses","deprecated":false},{"title":"/applicationProcesses/{tenantId}","summary":"Creates a new application process record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application-processes/createapplicationprocess","deprecated":false},{"title":"/applicationProcesses/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application-processes/executebatchoperations","deprecated":false},{"title":"/applicationProcesses/{tenantId}/eligible/{programId}/{customerType}/{contactOrOrganizationId}","summary":"Gets all of the processes a contact is eligible to use","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-processes/geteligibleprocesses","deprecated":false},{"title":"/applicationProcesses/{tenantId}/program/{program_id}","summary":"Returns a list of records with the specified program_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-processes/listprocessesbyprogramid","deprecated":false},{"title":"/applicationProcesses/{tenantId}/{id}","summary":"Returns a application process from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/application-processes/deleteapplicationprocess","deprecated":false},{"title":"/applicationProcesses/{tenantId}/{id}","summary":"Returns a application process from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-processes/getapplicationprocess","deprecated":false},{"title":"/applicationProcesses/{tenantId}/{id}","summary":"Partially updates a application process with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/application-processes/patchapplicationprocess","deprecated":false},{"title":"/applicationProcesses/{tenantId}/{id}","summary":"Updates a application process with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/application-processes/updateapplicationprocess","deprecated":false}]}]}]}]}},{"type":"group","label":"Application References","link":"/apis/certifications/certifications-v1/application-references","routeSlug":"/apis/certifications/certifications-v1/application-references","items":[{"label":"Creates a new application reference record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-references/createapplicationreference","routeSlug":"/apis/certifications/certifications-v1/application-references/createapplicationreference","metadata":{"seo":{"title":"Creates a new application reference record that does not already exist.","description":"This method will auto-generate an ID and create a new application reference. If an ID is specified for the application reference, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createApplicationReference","name":"Creates a new application reference record that does not already exist.","isWebhook":false,"pointer":"/paths/~1applicationReferences~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new application reference record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new application reference. If an ID is specified for the application reference, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationReferences~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}},"schemaId":"components/schemas/ApplicationReference","pointer":"/paths/~1applicationReferences~1{tenantId}/post/requestBody","description":"The application reference that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicationReferences/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/applicationReferences/{tenantId}","href":"application-references/createapplicationreference","openApiOperationId":"createApplicationReference","summary":"Creates a new application reference record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ApplicationReference","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application reference was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}},"schemaId":"components/schemas/ApplicationReference","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The application reference you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application reference could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add application reference based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationReferences~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationReference","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-references/createapplicationreference"}],"panels":[]}]},"httpPath":"/applicationReferences/{tenantId}"},{"label":"Returns a list of records with the specified application_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-references/listreferencesbyapplicationid","routeSlug":"/apis/certifications/certifications-v1/application-references/listreferencesbyapplicationid","metadata":{"seo":{"title":"Returns a list of records with the specified application_id","description":"Returns a list of records with the specified application_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listReferencesByApplicationId","name":"Returns a list of records with the specified application_id","isWebhook":false,"pointer":"/paths/~1applicationReferences~1{tenantId}~1application~1{application_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified application_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified application_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"application_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The application_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1application~1{application_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1application~1{application_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicationReferences/{tenantId}/application/{application_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationReferences/{tenantId}/application/{application_id}","href":"application-references/listreferencesbyapplicationid","openApiOperationId":"listReferencesByApplicationId","summary":"Returns a list of records with the specified application_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListApplicationReferencesResponse"}},"schemaId":"components/schemas/ListApplicationReferencesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1application~1{application_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListApplicationReferencesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListApplicationReferencesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-references/listreferencesbyapplicationid"}],"panels":[]}]},"httpPath":"/applicationReferences/{tenantId}/application/{application_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-references/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/application-references/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1applicationReferences~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1applicationReferences~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicationReferences/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationReferences/{tenantId}/batch","href":"application-references/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application reference could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application reference based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-references/executebatchoperations"}],"panels":[]}]},"httpPath":"/applicationReferences/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-references/listreferencesbycontactid","routeSlug":"/apis/certifications/certifications-v1/application-references/listreferencesbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listReferencesByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1applicationReferences~1{tenantId}~1contact~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified contact_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicationReferences/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationReferences/{tenantId}/contact/{contact_id}","href":"application-references/listreferencesbycontactid","openApiOperationId":"listReferencesByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListApplicationReferencesResponse"}},"schemaId":"components/schemas/ListApplicationReferencesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListApplicationReferencesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListApplicationReferencesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-references/listreferencesbycontactid"}],"panels":[]}]},"httpPath":"/applicationReferences/{tenantId}/contact/{contact_id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-references/previewemail","routeSlug":"/apis/certifications/certifications-v1/application-references/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewEmail","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1applicationReferences~1{tenantId}~1previewEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the CRC notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the CRC notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1previewEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"schemaId":"components/schemas/PreviewEmailRequest","pointer":"/paths/~1applicationReferences~1{tenantId}~1previewEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicationReferences/{tenantId}/previewEmail","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationReferences/{tenantId}/previewEmail","href":"application-references/previewemail","openApiOperationId":"previewEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1previewEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-references/previewemail"}],"panels":[]}]},"httpPath":"/applicationReferences/{tenantId}/previewEmail"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-references/processreferences","routeSlug":"/apis/certifications/certifications-v1/application-references/processreferences","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processReferences","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1applicationReferences~1{tenantId}~1process~1{application_id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the CRC notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the CRC notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"application_id","in":"path","schemaId":"schema_366","description":"The tenant","required":true}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1process~1{application_id}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"reference_id","in":"query","schemaId":"schema_366","description":"An optional reference ID that constraints processing"}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1process~1{application_id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicationReferences/{tenantId}/process/{application_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"reference_id","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationReferences/{tenantId}/process/{application_id}","href":"application-references/processreferences","openApiOperationId":"processReferences","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1process~1{application_id}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-references/processreferences"}],"panels":[]}]},"httpPath":"/applicationReferences/{tenantId}/process/{application_id}"},{"label":"Submit a reference","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-references/submitreference","routeSlug":"/apis/certifications/certifications-v1/application-references/submitreference","metadata":{"seo":{"title":"Submit a reference","description":"Submit a reference"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"submitReference","name":"Submit a reference","isWebhook":false,"pointer":"/paths/~1applicationReferences~1{tenantId}~1submit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a reference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1submit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}},"schemaId":"components/schemas/ApplicationReference","pointer":"/paths/~1applicationReferences~1{tenantId}~1submit/post/requestBody","description":"Object definition of reference"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicationReferences/{tenantId}/submit","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationReferences/{tenantId}/submit","href":"application-references/submitreference","openApiOperationId":"submitReference","summary":"Submit a reference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ApplicationReference","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1submit/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-references/submitreference"}],"panels":[]}]},"httpPath":"/applicationReferences/{tenantId}/submit"},{"label":"Returns a application reference from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-references/deleteapplicationreference","routeSlug":"/apis/certifications/certifications-v1/application-references/deleteapplicationreference","metadata":{"seo":{"title":"Returns a application reference from the system by its ID.","description":"This method will delete a application reference with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteApplicationReference","name":"Returns a application reference from the system by its ID.","isWebhook":false,"pointer":"/paths/~1applicationReferences~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a application reference from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a application reference with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application reference to delete.","required":true}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/applicationReferences/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/applicationReferences/{tenantId}/{id}","href":"application-references/deleteapplicationreference","openApiOperationId":"deleteApplicationReference","summary":"Returns a application reference from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application reference was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application reference could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application reference could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete application reference based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-references/deleteapplicationreference"}],"panels":[]}]},"httpPath":"/applicationReferences/{tenantId}/{id}"},{"label":"Returns a application reference from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-references/getapplicationreference","routeSlug":"/apis/certifications/certifications-v1/application-references/getapplicationreference","metadata":{"seo":{"title":"Returns a application reference from the system by its ID.","description":"This method will look up a application reference by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getApplicationReference","name":"Returns a application reference from the system by its ID.","isWebhook":false,"pointer":"/paths/~1applicationReferences~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a application reference from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a application reference by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application reference to return.","required":true}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicationReferences/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationReferences/{tenantId}/{id}","href":"application-references/getapplicationreference","openApiOperationId":"getApplicationReference","summary":"Returns a application reference from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application reference was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}},"schemaId":"components/schemas/ApplicationReference","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application reference could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application reference based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationReference","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-references/getapplicationreference"}],"panels":[]}]},"httpPath":"/applicationReferences/{tenantId}/{id}"},{"label":"Partially updates a application reference with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-references/patchapplicationreference","routeSlug":"/apis/certifications/certifications-v1/application-references/patchapplicationreference","metadata":{"seo":{"title":"Partially updates a application reference with the specified ID.","description":"This method will patch an existing application reference with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchApplicationReference","name":"Partially updates a application reference with the specified ID.","isWebhook":false,"pointer":"/paths/~1applicationReferences~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a application reference with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing application reference with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application reference to patch.","required":true}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1applicationReferences~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/applicationReferences/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/applicationReferences/{tenantId}/{id}","href":"application-references/patchapplicationreference","openApiOperationId":"patchApplicationReference","summary":"Partially updates a application reference with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application reference was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}},"schemaId":"components/schemas/ApplicationReference","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application reference could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application reference could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application reference based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationReference","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-references/patchapplicationreference"}],"panels":[]}]},"httpPath":"/applicationReferences/{tenantId}/{id}"},{"label":"Updates a application reference with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/application-references/updateapplicationreference","routeSlug":"/apis/certifications/certifications-v1/application-references/updateapplicationreference","metadata":{"seo":{"title":"Updates a application reference with the specified ID.","description":"This method will update an existing application reference with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateApplicationReference","name":"Updates a application reference with the specified ID.","isWebhook":false,"pointer":"/paths/~1applicationReferences~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a application reference with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing application reference with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application reference to update.","required":true}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}},"schemaId":"components/schemas/ApplicationReference","pointer":"/paths/~1applicationReferences~1{tenantId}~1{id}/put/requestBody","description":"The updated application reference that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/applicationReferences/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/applicationReferences/{tenantId}/{id}","href":"application-references/updateapplicationreference","openApiOperationId":"updateApplicationReference","summary":"Updates a application reference with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ApplicationReference","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application reference was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}},"schemaId":"components/schemas/ApplicationReference","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The application reference supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application reference could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application reference could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application reference based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applicationReferences~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationReference","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationReference"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-references/updateapplicationreference"}],"panels":[]}]},"httpPath":"/applicationReferences/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Application References"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Application References","showPageActions":true},{"nodeType":"markdoc","content":"Application References"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/applicationReferences/{tenantId}","summary":"Creates a new application reference record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application-references/createapplicationreference","deprecated":false},{"title":"/applicationReferences/{tenantId}/application/{application_id}","summary":"Returns a list of records with the specified application_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-references/listreferencesbyapplicationid","deprecated":false},{"title":"/applicationReferences/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application-references/executebatchoperations","deprecated":false},{"title":"/applicationReferences/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-references/listreferencesbycontactid","deprecated":false},{"title":"/applicationReferences/{tenantId}/previewEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application-references/previewemail","deprecated":false},{"title":"/applicationReferences/{tenantId}/process/{application_id}","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application-references/processreferences","deprecated":false},{"title":"/applicationReferences/{tenantId}/submit","summary":"Submit a reference","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application-references/submitreference","deprecated":false},{"title":"/applicationReferences/{tenantId}/{id}","summary":"Returns a application reference from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/application-references/deleteapplicationreference","deprecated":false},{"title":"/applicationReferences/{tenantId}/{id}","summary":"Returns a application reference from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-references/getapplicationreference","deprecated":false},{"title":"/applicationReferences/{tenantId}/{id}","summary":"Partially updates a application reference with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/application-references/patchapplicationreference","deprecated":false},{"title":"/applicationReferences/{tenantId}/{id}","summary":"Updates a application reference with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/application-references/updateapplicationreference","deprecated":false}]}]}]}]}},{"type":"group","label":"Applications","link":"/apis/certifications/certifications-v1/applications","routeSlug":"/apis/certifications/certifications-v1/applications","items":[{"label":"Gets all of the applications in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/listapplications","routeSlug":"/apis/certifications/certifications-v1/applications/listapplications","metadata":{"seo":{"title":"Gets all of the applications in the system.","description":"This method will scan all applications and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listApplications","name":"Gets all of the applications in the system.","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the applications in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all applications and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applications~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1applications~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applications/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applications/{tenantId}","href":"applications/listapplications","openApiOperationId":"listApplications","summary":"Gets all of the applications in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The applicationswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_379"}},"schemaId":"schema_379","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_379","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_379"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/listapplications"}],"panels":[]}]},"httpPath":"/applications/{tenantId}"},{"label":"Creates a new application record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/createapplication","routeSlug":"/apis/certifications/certifications-v1/applications/createapplication","metadata":{"seo":{"title":"Creates a new application record that does not already exist.","description":"This method will auto-generate an ID and create a new application. If an ID is specified for the application, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createApplication","name":"Creates a new application record that does not already exist.","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new application record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new application. If an ID is specified for the application, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applications~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Application"}},"schemaId":"components/schemas/Application","pointer":"/paths/~1applications~1{tenantId}/post/requestBody","description":"The application that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applications/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Application"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/applications/{tenantId}","href":"applications/createapplication","openApiOperationId":"createApplication","summary":"Creates a new application record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Application","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Application"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Application"}},"schemaId":"components/schemas/Application","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The application you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add application based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Application","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Application"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/createapplication"}],"panels":[]}]},"httpPath":"/applications/{tenantId}"},{"label":"Activates a certification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/activatecertificationfromapplication","routeSlug":"/apis/certifications/certifications-v1/applications/activatecertificationfromapplication","metadata":{"seo":{"title":"Activates a certification","description":"Activates a certification"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"activateCertificationFromApplication","name":"Activates a certification","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1activate~1{applicationId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activates a certification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true},{"name":"applicationId","in":"path","schemaId":"schema_366","description":"The application id","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1activate~1{applicationId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applications/{tenantId}/activate/{applicationId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"applicationId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applications/{tenantId}/activate/{applicationId}","href":"applications/activatecertificationfromapplication","openApiOperationId":"activateCertificationFromApplication","summary":"Activates a certification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1activate~1{applicationId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/activatecertificationfromapplication"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/activate/{applicationId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/applications/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1applications~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applications/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applications/{tenantId}/batch","href":"applications/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/executebatchoperations"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/listapplicationsbycontactid","routeSlug":"/apis/certifications/certifications-v1/applications/listapplicationsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listApplicationsByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1contact~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified contact_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1applications~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1applications~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applications/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applications/{tenantId}/contact/{contact_id}","href":"applications/listapplicationsbycontactid","openApiOperationId":"listApplicationsByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListApplicationsResponse"}},"schemaId":"components/schemas/ListApplicationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListApplicationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListApplicationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/listapplicationsbycontactid"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/contact/{contact_id}"},{"label":"Test credit requirement formula","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/testcreditrequirementformula","routeSlug":"/apis/certifications/certifications-v1/applications/testcreditrequirementformula","metadata":{"seo":{"title":"Test credit requirement formula","description":"Use this to test the formula for certification credit requirements"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"testCreditRequirementFormula","name":"Test credit requirement formula","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1creditRequirementFormulaTest~1{applicationId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test credit requirement formula","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this to test the formula for certification credit requirements"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true},{"name":"applicationId","in":"path","schemaId":"schema_366","description":"The id of the application","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1creditRequirementFormulaTest~1{applicationId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditRequirementFormulaTestRequest"}},"schemaId":"components/schemas/CreditRequirementFormulaTestRequest","pointer":"/paths/~1applications~1{tenantId}~1creditRequirementFormulaTest~1{applicationId}/post/requestBody","description":"Credit application request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applications/{tenantId}/creditRequirementFormulaTest/{applicationId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"applicationId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditRequirementFormulaTestRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applications/{tenantId}/creditRequirementFormulaTest/{applicationId}","href":"applications/testcreditrequirementformula","openApiOperationId":"testCreditRequirementFormula","summary":"Test credit requirement formula"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CreditRequirementFormulaTestRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditRequirementFormulaTestRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditRequirementFormulaTestResponse"}},"schemaId":"components/schemas/CreditRequirementFormulaTestResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1creditRequirementFormulaTest~1{applicationId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditRequirementFormulaTestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditRequirementFormulaTestResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/testcreditrequirementformula"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/creditRequirementFormulaTest/{applicationId}"},{"label":"Applies credits to an application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/applycreditstoapplication","routeSlug":"/apis/certifications/certifications-v1/applications/applycreditstoapplication","metadata":{"seo":{"title":"Applies credits to an application","description":"Applies credits to an application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"applyCreditsToApplication","name":"Applies credits to an application","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1credits~1apply~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Applies credits to an application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The id of the application","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1credits~1apply~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditApplicationRequest"}},"schemaId":"components/schemas/CreditApplicationRequest","pointer":"/paths/~1applications~1{tenantId}~1credits~1apply~1{id}/post/requestBody","description":"Credit application request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applications/{tenantId}/credits/apply/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditApplicationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applications/{tenantId}/credits/apply/{id}","href":"applications/applycreditstoapplication","openApiOperationId":"applyCreditsToApplication","summary":"Applies credits to an application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CreditApplicationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditApplicationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1credits~1apply~1{id}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/applycreditstoapplication"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/credits/apply/{id}"},{"label":"Unapplies credits to an application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/unapplycreditstoapplication","routeSlug":"/apis/certifications/certifications-v1/applications/unapplycreditstoapplication","metadata":{"seo":{"title":"Unapplies credits to an application","description":"Unapplies credits to an application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unapplyCreditsToApplication","name":"Unapplies credits to an application","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1credits~1unapply~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unapplies credits to an application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The id of the application","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1credits~1unapply~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditApplicationRequest"}},"schemaId":"components/schemas/CreditApplicationRequest","pointer":"/paths/~1applications~1{tenantId}~1credits~1unapply~1{id}/post/requestBody","description":"Credit application request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applications/{tenantId}/credits/unapply/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditApplicationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applications/{tenantId}/credits/unapply/{id}","href":"applications/unapplycreditstoapplication","openApiOperationId":"unapplyCreditsToApplication","summary":"Unapplies credits to an application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CreditApplicationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditApplicationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1credits~1unapply~1{id}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/unapplycreditstoapplication"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/credits/unapply/{id}"},{"label":"Generates an generation for a contact or organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/generateapplication","routeSlug":"/apis/certifications/certifications-v1/applications/generateapplication","metadata":{"seo":{"title":"Generates an generation for a contact or organization","description":"Generates an generation for a contact or organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateApplication","name":"Generates an generation for a contact or organization","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1generateApplication~1{processId}~1{ownerType}~1{ownerId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates an generation for a contact or organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true},{"name":"processId","in":"path","schemaId":"schema_366","description":"The process id","required":true},{"name":"ownerType","in":"path","schemaId":"schema_378","description":"The contact or organization type","required":true},{"name":"ownerId","in":"path","schemaId":"schema_366","description":"The contact or organization type","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1generateApplication~1{processId}~1{ownerType}~1{ownerId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applications/{tenantId}/generateApplication/{processId}/{ownerType}/{ownerId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"processId","in":"path","required":true,"schemaId":"schema_366"},{"name":"ownerType","in":"path","required":true,"schemaId":"schema_378"},{"name":"ownerId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applications/{tenantId}/generateApplication/{processId}/{ownerType}/{ownerId}","href":"applications/generateapplication","openApiOperationId":"generateApplication","summary":"Generates an generation for a contact or organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationGenerationResult"}},"schemaId":"components/schemas/ApplicationGenerationResult","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1generateApplication~1{processId}~1{ownerType}~1{ownerId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationGenerationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationGenerationResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/generateapplication"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/generateApplication/{processId}/{ownerType}/{ownerId}"},{"label":"Generates an order from a certification application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/generateorder","routeSlug":"/apis/certifications/certifications-v1/applications/generateorder","metadata":{"seo":{"title":"Generates an order from a certification application","description":"This method will examine a certification application and generate an appropriate order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateOrder","name":"Generates an order from a certification application","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1generateOrder/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates an order from a certification application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will examine a certification application and generate an appropriate order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1generateOrder/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Application"}},"schemaId":"components/schemas/Application","pointer":"/paths/~1applications~1{tenantId}~1generateOrder/post/requestBody","description":"The application to generate an order"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applications/{tenantId}/generateOrder","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Application"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applications/{tenantId}/generateOrder","href":"applications/generateorder","openApiOperationId":"generateOrder","summary":"Generates an order from a certification application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Application","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Application"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1generateOrder/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/generateorder"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/generateOrder"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/listapplicationsbyorganizationid","routeSlug":"/apis/certifications/certifications-v1/applications/listapplicationsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listApplicationsByOrganizationId","name":"Returns a list of records with the specified organization_id","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1organization~1{organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified organization_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified organization_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"organization_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1applications~1{tenantId}~1organization~1{organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1applications~1{tenantId}~1organization~1{organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applications/{tenantId}/organization/{organization_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applications/{tenantId}/organization/{organization_id}","href":"applications/listapplicationsbyorganizationid","openApiOperationId":"listApplicationsByOrganizationId","summary":"Returns a list of records with the specified organization_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListApplicationsResponse"}},"schemaId":"components/schemas/ListApplicationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1organization~1{organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListApplicationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListApplicationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/listapplicationsbyorganizationid"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/organization/{organization_id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/previewemail","routeSlug":"/apis/certifications/certifications-v1/applications/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewEmail","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1previewEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the CRC notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the CRC notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1previewEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"schemaId":"components/schemas/PreviewEmailRequest","pointer":"/paths/~1applications~1{tenantId}~1previewEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applications/{tenantId}/previewEmail","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applications/{tenantId}/previewEmail","href":"applications/previewemail","openApiOperationId":"previewEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1previewEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/previewemail"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/previewEmail"},{"label":"Returns a list of records with the specified program_applicant_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/listapplicationsbyprogramapplicantid","routeSlug":"/apis/certifications/certifications-v1/applications/listapplicationsbyprogramapplicantid","metadata":{"seo":{"title":"Returns a list of records with the specified program_applicant_id","description":"Returns a list of records with the specified program_applicant_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listApplicationsByProgramApplicantId","name":"Returns a list of records with the specified program_applicant_id","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1programApplicant~1{programId}~1{ownerType}~1{ownerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified program_applicant_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified program_applicant_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"programId","in":"path","schemaId":"schema_366","description":"The program id to use to for record lookup","required":true},{"name":"ownerType","in":"path","schemaId":"schema_378","description":"The contact or organization type","required":true},{"name":"ownerId","in":"path","schemaId":"schema_366","description":"The contact or organization type","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1programApplicant~1{programId}~1{ownerType}~1{ownerId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1applications~1{tenantId}~1programApplicant~1{programId}~1{ownerType}~1{ownerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applications/{tenantId}/programApplicant/{programId}/{ownerType}/{ownerId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"programId","in":"path","required":true,"schemaId":"schema_366"},{"name":"ownerType","in":"path","required":true,"schemaId":"schema_378"},{"name":"ownerId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applications/{tenantId}/programApplicant/{programId}/{ownerType}/{ownerId}","href":"applications/listapplicationsbyprogramapplicantid","openApiOperationId":"listApplicationsByProgramApplicantId","summary":"Returns a list of records with the specified program_applicant_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListApplicationsResponse"}},"schemaId":"components/schemas/ListApplicationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1programApplicant~1{programId}~1{ownerType}~1{ownerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListApplicationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListApplicationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/listapplicationsbyprogramapplicantid"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/programApplicant/{programId}/{ownerType}/{ownerId}"},{"label":"Searches for applications using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/searchforapplications","routeSlug":"/apis/certifications/certifications-v1/applications/searchforapplications","metadata":{"seo":{"title":"Searches for applications using predefined parameters","description":"Searches for applications using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForApplications","name":"Searches for applications using predefined parameters","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for applications using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for applications using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_366","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1applications~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationSearchParameters"}},"schemaId":"components/schemas/ApplicationSearchParameters","pointer":"/paths/~1applications~1{tenantId}~1search/post/requestBody","description":"The application that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applications/{tenantId}/search","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplicationSearchParameters"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/applications/{tenantId}/search","href":"applications/searchforapplications","openApiOperationId":"searchForApplications","summary":"Searches for applications using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ApplicationSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedApplicationSearchResults"}},"schemaId":"components/schemas/PagedApplicationSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The application you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add application based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedApplicationSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedApplicationSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/searchforapplications"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/search"},{"label":"Sends an application notice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/sendapplicationnotice","routeSlug":"/apis/certifications/certifications-v1/applications/sendapplicationnotice","metadata":{"seo":{"title":"Sends an application notice","description":"This method will examine a certification application and generate an appropriate order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendApplicationNotice","name":"Sends an application notice","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1sendNotice~1{notice_id}~1{application_id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends an application notice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will examine a certification application and generate an appropriate order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true},{"name":"notice_id","in":"path","schemaId":"schema_366","description":"The application notice","required":true},{"name":"application_id","in":"path","schemaId":"schema_366","description":"The application","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1sendNotice~1{notice_id}~1{application_id}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"new_status_reason_id","in":"query","schemaId":"schema_366","description":"The new status reason"}],"pointer":"/paths/~1applications~1{tenantId}~1sendNotice~1{notice_id}~1{application_id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applications/{tenantId}/sendNotice/{notice_id}/{application_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"notice_id","in":"path","required":true,"schemaId":"schema_366"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"new_status_reason_id","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applications/{tenantId}/sendNotice/{notice_id}/{application_id}","href":"applications/sendapplicationnotice","openApiOperationId":"sendApplicationNotice","summary":"Sends an application notice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1sendNotice~1{notice_id}~1{application_id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/sendapplicationnotice"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/sendNotice/{notice_id}/{application_id}"},{"label":"Returns a application from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/deleteapplication","routeSlug":"/apis/certifications/certifications-v1/applications/deleteapplication","metadata":{"seo":{"title":"Returns a application from the system by its ID.","description":"This method will delete a application with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteApplication","name":"Returns a application from the system by its ID.","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a application from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a application with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application to delete.","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/applications/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/applications/{tenantId}/{id}","href":"applications/deleteapplication","openApiOperationId":"deleteApplication","summary":"Returns a application from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete application based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/deleteapplication"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/{id}"},{"label":"Returns a application from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/getapplication","routeSlug":"/apis/certifications/certifications-v1/applications/getapplication","metadata":{"seo":{"title":"Returns a application from the system by its ID.","description":"This method will look up a application by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getApplication","name":"Returns a application from the system by its ID.","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a application from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a application by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application to return.","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1applications~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applications/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applications/{tenantId}/{id}","href":"applications/getapplication","openApiOperationId":"getApplication","summary":"Returns a application from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Application"}},"schemaId":"components/schemas/Application","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Application","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Application"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/getapplication"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/{id}"},{"label":"Partially updates a application with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/patchapplication","routeSlug":"/apis/certifications/certifications-v1/applications/patchapplication","metadata":{"seo":{"title":"Partially updates a application with the specified ID.","description":"This method will patch an existing application with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchApplication","name":"Partially updates a application with the specified ID.","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a application with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing application with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application to patch.","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1applications~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/applications/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/applications/{tenantId}/{id}","href":"applications/patchapplication","openApiOperationId":"patchApplication","summary":"Partially updates a application with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Application"}},"schemaId":"components/schemas/Application","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Application","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Application"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/patchapplication"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/{id}"},{"label":"Updates a application with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/applications/updateapplication","routeSlug":"/apis/certifications/certifications-v1/applications/updateapplication","metadata":{"seo":{"title":"Updates a application with the specified ID.","description":"This method will update an existing application with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateApplication","name":"Updates a application with the specified ID.","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a application with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing application with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the application to update.","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Application"}},"schemaId":"components/schemas/Application","pointer":"/paths/~1applications~1{tenantId}~1{id}/put/requestBody","description":"The updated application that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/applications/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Application"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/applications/{tenantId}/{id}","href":"applications/updateapplication","openApiOperationId":"updateApplication","summary":"Updates a application with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Application","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Application"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The application was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Application"}},"schemaId":"components/schemas/Application","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The application supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The application could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The application could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve application based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1applications~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Application","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Application"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/updateapplication"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Applications"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Applications","showPageActions":true},{"nodeType":"markdoc","content":"Applications"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/applications/{tenantId}","summary":"Gets all of the applications in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/applications/listapplications","deprecated":false},{"title":"/applications/{tenantId}","summary":"Creates a new application record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/applications/createapplication","deprecated":false},{"title":"/applications/{tenantId}/activate/{applicationId}","summary":"Activates a certification","prefix":{"name":"post","color":"post"},"badges":[],"link":"/applications/activatecertificationfromapplication","deprecated":false},{"title":"/applications/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/applications/executebatchoperations","deprecated":false},{"title":"/applications/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/applications/listapplicationsbycontactid","deprecated":false},{"title":"/applications/{tenantId}/creditRequirementFormulaTest/{applicationId}","summary":"Test credit requirement formula","prefix":{"name":"post","color":"post"},"badges":[],"link":"/applications/testcreditrequirementformula","deprecated":false},{"title":"/applications/{tenantId}/credits/apply/{id}","summary":"Applies credits to an application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/applications/applycreditstoapplication","deprecated":false},{"title":"/applications/{tenantId}/credits/unapply/{id}","summary":"Unapplies credits to an application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/applications/unapplycreditstoapplication","deprecated":false},{"title":"/applications/{tenantId}/generateApplication/{processId}/{ownerType}/{ownerId}","summary":"Generates an generation for a contact or organization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/applications/generateapplication","deprecated":false},{"title":"/applications/{tenantId}/generateOrder","summary":"Generates an order from a certification application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/applications/generateorder","deprecated":false},{"title":"/applications/{tenantId}/organization/{organization_id}","summary":"Returns a list of records with the specified organization_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/applications/listapplicationsbyorganizationid","deprecated":false},{"title":"/applications/{tenantId}/previewEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/applications/previewemail","deprecated":false},{"title":"/applications/{tenantId}/programApplicant/{programId}/{ownerType}/{ownerId}","summary":"Returns a list of records with the specified program_applicant_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/applications/listapplicationsbyprogramapplicantid","deprecated":false},{"title":"/applications/{tenantId}/search","summary":"Searches for applications using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/applications/searchforapplications","deprecated":false},{"title":"/applications/{tenantId}/sendNotice/{notice_id}/{application_id}","summary":"Sends an application notice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/applications/sendapplicationnotice","deprecated":false},{"title":"/applications/{tenantId}/{id}","summary":"Returns a application from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/applications/deleteapplication","deprecated":false},{"title":"/applications/{tenantId}/{id}","summary":"Returns a application from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/applications/getapplication","deprecated":false},{"title":"/applications/{tenantId}/{id}","summary":"Partially updates a application with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/applications/patchapplication","deprecated":false},{"title":"/applications/{tenantId}/{id}","summary":"Updates a application with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/applications/updateapplication","deprecated":false}]}]}]}]}},{"type":"group","label":"Billing Run Actions","link":"/apis/certifications/certifications-v1/billing-run-actions","routeSlug":"/apis/certifications/certifications-v1/billing-run-actions","items":[{"label":"Creates a new billing run action record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-run-actions/createbillingrunaction","routeSlug":"/apis/certifications/certifications-v1/billing-run-actions/createbillingrunaction","metadata":{"seo":{"title":"Creates a new billing run action record that does not already exist.","description":"This method will auto-generate an ID and create a new billing run action. If an ID is specified for the billing run action, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBillingRunAction","name":"Creates a new billing run action record that does not already exist.","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new billing run action record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new billing run action. If an ID is specified for the billing run action, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"schemaId":"components/schemas/BillingRunAction","pointer":"/paths/~1billingRunActions~1{tenantId}/post/requestBody","description":"The billing run action that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingRunActions/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRunActions/{tenantId}","href":"billing-run-actions/createbillingrunaction","openApiOperationId":"createBillingRunAction","summary":"Creates a new billing run action record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingRunAction","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run action was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"schemaId":"components/schemas/BillingRunAction","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The billing run action you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The billing run action could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add billing run action based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRunActions~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingRunAction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/createbillingrunaction"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}"},{"label":"Returns a list of records with the specified application_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-run-actions/listactionsbyapplicationid","routeSlug":"/apis/certifications/certifications-v1/billing-run-actions/listactionsbyapplicationid","metadata":{"seo":{"title":"Returns a list of records with the specified application_id","description":"Returns a list of records with the specified application_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listActionsByApplicationId","name":"Returns a list of records with the specified application_id","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}~1application~1{application_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified application_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified application_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"application_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The application_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1application~1{application_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1application~1{application_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingRunActions/{tenantId}/application/{application_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRunActions/{tenantId}/application/{application_id}","href":"billing-run-actions/listactionsbyapplicationid","openApiOperationId":"listActionsByApplicationId","summary":"Returns a list of records with the specified application_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBillingRunActionsResponse"}},"schemaId":"components/schemas/ListBillingRunActionsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1application~1{application_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListBillingRunActionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBillingRunActionsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/listactionsbyapplicationid"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}/application/{application_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-run-actions/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/billing-run-actions/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1billingRunActions~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingRunActions/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRunActions/{tenantId}/batch","href":"billing-run-actions/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The billing run action could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve billing run action based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/executebatchoperations"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}/batch"},{"label":"Returns a list of records with the specified billing_run_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-run-actions/listactionsbybillingrunid","routeSlug":"/apis/certifications/certifications-v1/billing-run-actions/listactionsbybillingrunid","metadata":{"seo":{"title":"Returns a list of records with the specified billing_run_id","description":"Returns a list of records with the specified billing_run_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listActionsByBillingRunId","name":"Returns a list of records with the specified billing_run_id","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}~1billingRun~1{billing_run_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified billing_run_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified billing_run_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"billing_run_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing_run_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1billingRun~1{billing_run_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1billingRun~1{billing_run_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingRunActions/{tenantId}/billingRun/{billing_run_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"billing_run_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRunActions/{tenantId}/billingRun/{billing_run_id}","href":"billing-run-actions/listactionsbybillingrunid","openApiOperationId":"listActionsByBillingRunId","summary":"Returns a list of records with the specified billing_run_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBillingRunActionsResponse"}},"schemaId":"components/schemas/ListBillingRunActionsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1billingRun~1{billing_run_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListBillingRunActionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBillingRunActionsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/listactionsbybillingrunid"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}/billingRun/{billing_run_id}"},{"label":"Returns a list of records with the specified certification_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-run-actions/listactionsbycertificationid","routeSlug":"/apis/certifications/certifications-v1/billing-run-actions/listactionsbycertificationid","metadata":{"seo":{"title":"Returns a list of records with the specified certification_id","description":"Returns a list of records with the specified certification_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listActionsByCertificationId","name":"Returns a list of records with the specified certification_id","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}~1certification~1{certification_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified certification_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified certification_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"certification_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The certification_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1certification~1{certification_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1certification~1{certification_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingRunActions/{tenantId}/certification/{certification_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"certification_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRunActions/{tenantId}/certification/{certification_id}","href":"billing-run-actions/listactionsbycertificationid","openApiOperationId":"listActionsByCertificationId","summary":"Returns a list of records with the specified certification_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBillingRunActionsResponse"}},"schemaId":"components/schemas/ListBillingRunActionsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1certification~1{certification_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListBillingRunActionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBillingRunActionsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/listactionsbycertificationid"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}/certification/{certification_id}"},{"label":"Returns a list of records with the specified training_provider_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-run-actions/listactionsbytrainingproviderid","routeSlug":"/apis/certifications/certifications-v1/billing-run-actions/listactionsbytrainingproviderid","metadata":{"seo":{"title":"Returns a list of records with the specified training_provider_id","description":"Returns a list of records with the specified training_provider_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listActionsByTrainingProviderId","name":"Returns a list of records with the specified training_provider_id","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}~1trainingProvider~1{training_provider_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified training_provider_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified training_provider_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"training_provider_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The training_provider_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1trainingProvider~1{training_provider_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1trainingProvider~1{training_provider_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingRunActions/{tenantId}/trainingProvider/{training_provider_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"training_provider_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRunActions/{tenantId}/trainingProvider/{training_provider_id}","href":"billing-run-actions/listactionsbytrainingproviderid","openApiOperationId":"listActionsByTrainingProviderId","summary":"Returns a list of records with the specified training_provider_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBillingRunActionsResponse"}},"schemaId":"components/schemas/ListBillingRunActionsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1trainingProvider~1{training_provider_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListBillingRunActionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBillingRunActionsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/listactionsbytrainingproviderid"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}/trainingProvider/{training_provider_id}"},{"label":"Returns a billing run action from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-run-actions/deletebillingrunaction","routeSlug":"/apis/certifications/certifications-v1/billing-run-actions/deletebillingrunaction","metadata":{"seo":{"title":"Returns a billing run action from the system by its ID.","description":"This method will delete a billing run action with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBillingRunAction","name":"Returns a billing run action from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing run action from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a billing run action with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the billing run action to delete.","required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/billingRunActions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRunActions/{tenantId}/{id}","href":"billing-run-actions/deletebillingrunaction","openApiOperationId":"deleteBillingRunAction","summary":"Returns a billing run action from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run action was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The billing run action could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The billing run action could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete billing run action based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/deletebillingrunaction"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}/{id}"},{"label":"Returns a billing run action from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-run-actions/getbillingrunaction","routeSlug":"/apis/certifications/certifications-v1/billing-run-actions/getbillingrunaction","metadata":{"seo":{"title":"Returns a billing run action from the system by its ID.","description":"This method will look up a billing run action by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBillingRunAction","name":"Returns a billing run action from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing run action from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a billing run action by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the billing run action to return.","required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingRunActions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRunActions/{tenantId}/{id}","href":"billing-run-actions/getbillingrunaction","openApiOperationId":"getBillingRunAction","summary":"Returns a billing run action from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run action was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"schemaId":"components/schemas/BillingRunAction","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The billing run action could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve billing run action based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingRunAction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/getbillingrunaction"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}/{id}"},{"label":"Partially updates a billing run action with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-run-actions/patchbillingrunaction","routeSlug":"/apis/certifications/certifications-v1/billing-run-actions/patchbillingrunaction","metadata":{"seo":{"title":"Partially updates a billing run action with the specified ID.","description":"This method will patch an existing billing run action with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBillingRunAction","name":"Partially updates a billing run action with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a billing run action with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing billing run action with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the billing run action to patch.","required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/billingRunActions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRunActions/{tenantId}/{id}","href":"billing-run-actions/patchbillingrunaction","openApiOperationId":"patchBillingRunAction","summary":"Partially updates a billing run action with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run action was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"schemaId":"components/schemas/BillingRunAction","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The billing run action could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The billing run action could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve billing run action based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingRunAction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/patchbillingrunaction"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}/{id}"},{"label":"Updates a billing run action with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-run-actions/updatebillingrunaction","routeSlug":"/apis/certifications/certifications-v1/billing-run-actions/updatebillingrunaction","metadata":{"seo":{"title":"Updates a billing run action with the specified ID.","description":"This method will update an existing billing run action with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBillingRunAction","name":"Updates a billing run action with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a billing run action with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing billing run action with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the billing run action to update.","required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"schemaId":"components/schemas/BillingRunAction","pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/put/requestBody","description":"The updated billing run action that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/billingRunActions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRunActions/{tenantId}/{id}","href":"billing-run-actions/updatebillingrunaction","openApiOperationId":"updateBillingRunAction","summary":"Updates a billing run action with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingRunAction","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run action was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"schemaId":"components/schemas/BillingRunAction","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The billing run action supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The billing run action could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The billing run action could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve billing run action based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingRunAction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/updatebillingrunaction"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Billing Run Actions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Billing Run Actions","showPageActions":true},{"nodeType":"markdoc","content":"Billing Run Actions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/billingRunActions/{tenantId}","summary":"Creates a new billing run action record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-run-actions/createbillingrunaction","deprecated":false},{"title":"/billingRunActions/{tenantId}/application/{application_id}","summary":"Returns a list of records with the specified application_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-run-actions/listactionsbyapplicationid","deprecated":false},{"title":"/billingRunActions/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-run-actions/executebatchoperations","deprecated":false},{"title":"/billingRunActions/{tenantId}/billingRun/{billing_run_id}","summary":"Returns a list of records with the specified billing_run_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-run-actions/listactionsbybillingrunid","deprecated":false},{"title":"/billingRunActions/{tenantId}/certification/{certification_id}","summary":"Returns a list of records with the specified certification_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-run-actions/listactionsbycertificationid","deprecated":false},{"title":"/billingRunActions/{tenantId}/trainingProvider/{training_provider_id}","summary":"Returns a list of records with the specified training_provider_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-run-actions/listactionsbytrainingproviderid","deprecated":false},{"title":"/billingRunActions/{tenantId}/{id}","summary":"Returns a billing run action from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/billing-run-actions/deletebillingrunaction","deprecated":false},{"title":"/billingRunActions/{tenantId}/{id}","summary":"Returns a billing run action from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-run-actions/getbillingrunaction","deprecated":false},{"title":"/billingRunActions/{tenantId}/{id}","summary":"Partially updates a billing run action with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/billing-run-actions/patchbillingrunaction","deprecated":false},{"title":"/billingRunActions/{tenantId}/{id}","summary":"Updates a billing run action with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/billing-run-actions/updatebillingrunaction","deprecated":false}]}]}]}]}},{"type":"group","label":"Billing Runs","link":"/apis/certifications/certifications-v1/billing-runs","routeSlug":"/apis/certifications/certifications-v1/billing-runs","items":[{"label":"Creates a new billing run record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-runs/createbillingrun","routeSlug":"/apis/certifications/certifications-v1/billing-runs/createbillingrun","metadata":{"seo":{"title":"Creates a new billing run record that does not already exist.","description":"This method will auto-generate an ID and create a new billing run. If an ID is specified for the billing run, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBillingRun","name":"Creates a new billing run record that does not already exist.","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new billing run record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new billing run. If an ID is specified for the billing run, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"schemaId":"components/schemas/BillingRun","pointer":"/paths/~1billingRuns~1{tenantId}/post/requestBody","description":"The billing run that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingRuns/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRuns/{tenantId}","href":"billing-runs/createbillingrun","openApiOperationId":"createBillingRun","summary":"Creates a new billing run record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingRun","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"schemaId":"components/schemas/BillingRun","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The billing run you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The billing run could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRuns~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRun"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/createbillingrun"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-runs/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/billing-runs/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1billingRuns~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingRuns/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRuns/{tenantId}/batch","href":"billing-runs/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/executebatchoperations"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/batch"},{"label":"Returns a list of records with the specified recurring_billing_run_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-runs/listrunsbyrecurringbillingrunid","routeSlug":"/apis/certifications/certifications-v1/billing-runs/listrunsbyrecurringbillingrunid","metadata":{"seo":{"title":"Returns a list of records with the specified recurring_billing_run_id","description":"Returns a list of records with the specified recurring_billing_run_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRunsByRecurringBillingRunId","name":"Returns a list of records with the specified recurring_billing_run_id","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1recurringBillingRun~1{recurring_billing_run_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified recurring_billing_run_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified recurring_billing_run_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"recurring_billing_run_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recurring_billing_run_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1recurringBillingRun~1{recurring_billing_run_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1recurringBillingRun~1{recurring_billing_run_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"recurring_billing_run_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}","href":"billing-runs/listrunsbyrecurringbillingrunid","openApiOperationId":"listRunsByRecurringBillingRunId","summary":"Returns a list of records with the specified recurring_billing_run_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBillingRunsResponse"}},"schemaId":"components/schemas/ListBillingRunsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1recurringBillingRun~1{recurring_billing_run_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListBillingRunsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBillingRunsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/listrunsbyrecurringbillingrunid"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}"},{"label":"Refreshes a billing run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-runs/refreshbillingrun","routeSlug":"/apis/certifications/certifications-v1/billing-runs/refreshbillingrun","metadata":{"seo":{"title":"Refreshes a billing run","description":"Refreshes a billing run"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"refreshBillingRun","name":"Refreshes a billing run","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1refresh~1{id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refreshes a billing run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing_run_id to use to refresh"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1refresh~1{id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingRuns/{tenantId}/refresh/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRuns/{tenantId}/refresh/{id}","href":"billing-runs/refreshbillingrun","openApiOperationId":"refreshBillingRun","summary":"Refreshes a billing run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1refresh~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/refreshbillingrun"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/refresh/{id}"},{"label":"Searches for billing runs using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-runs/searchforbillingruns","routeSlug":"/apis/certifications/certifications-v1/billing-runs/searchforbillingruns","metadata":{"seo":{"title":"Searches for billing runs using predefined parameters","description":"Searches for billing runs using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForBillingRuns","name":"Searches for billing runs using predefined parameters","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for billing runs using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for billing runs using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_366","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRunSearchParameters"}},"schemaId":"components/schemas/BillingRunSearchParameters","pointer":"/paths/~1billingRuns~1{tenantId}~1search/post/requestBody","description":"The billing run that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingRuns/{tenantId}/search","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingRunSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRuns/{tenantId}/search","href":"billing-runs/searchforbillingruns","openApiOperationId":"searchForBillingRuns","summary":"Searches for billing runs using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingRunSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRunSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedBillingRunSearchResults"}},"schemaId":"components/schemas/PagedBillingRunSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The billing run you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The billing run could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedBillingRunSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedBillingRunSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/searchforbillingruns"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/search"},{"label":"Returns a billing run from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-runs/deletebillingrun","routeSlug":"/apis/certifications/certifications-v1/billing-runs/deletebillingrun","metadata":{"seo":{"title":"Returns a billing run from the system by its ID.","description":"This method will delete a billing run with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBillingRun","name":"Returns a billing run from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing run from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a billing run with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the billing run to delete.","required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/billingRuns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRuns/{tenantId}/{id}","href":"billing-runs/deletebillingrun","openApiOperationId":"deleteBillingRun","summary":"Returns a billing run from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The billing run could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/deletebillingrun"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/{id}"},{"label":"Returns a billing run from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-runs/getbillingrun","routeSlug":"/apis/certifications/certifications-v1/billing-runs/getbillingrun","metadata":{"seo":{"title":"Returns a billing run from the system by its ID.","description":"This method will look up a billing run by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBillingRun","name":"Returns a billing run from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing run from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a billing run by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the billing run to return.","required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingRuns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRuns/{tenantId}/{id}","href":"billing-runs/getbillingrun","openApiOperationId":"getBillingRun","summary":"Returns a billing run from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"schemaId":"components/schemas/BillingRun","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRun"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/getbillingrun"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/{id}"},{"label":"Partially updates a billing run with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-runs/patchbillingrun","routeSlug":"/apis/certifications/certifications-v1/billing-runs/patchbillingrun","metadata":{"seo":{"title":"Partially updates a billing run with the specified ID.","description":"This method will patch an existing billing run with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBillingRun","name":"Partially updates a billing run with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a billing run with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing billing run with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the billing run to patch.","required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/billingRuns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRuns/{tenantId}/{id}","href":"billing-runs/patchbillingrun","openApiOperationId":"patchBillingRun","summary":"Partially updates a billing run with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"schemaId":"components/schemas/BillingRun","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The billing run could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRun"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/patchbillingrun"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/{id}"},{"label":"Updates a billing run with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-runs/updatebillingrun","routeSlug":"/apis/certifications/certifications-v1/billing-runs/updatebillingrun","metadata":{"seo":{"title":"Updates a billing run with the specified ID.","description":"This method will update an existing billing run with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBillingRun","name":"Updates a billing run with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a billing run with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing billing run with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the billing run to update.","required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"schemaId":"components/schemas/BillingRun","pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/put/requestBody","description":"The updated billing run that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/billingRuns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRuns/{tenantId}/{id}","href":"billing-runs/updatebillingrun","openApiOperationId":"updateBillingRun","summary":"Updates a billing run with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingRun","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"schemaId":"components/schemas/BillingRun","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The billing run supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The billing run could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRun"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/updatebillingrun"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Billing Runs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Billing Runs","showPageActions":true},{"nodeType":"markdoc","content":"Billing Runs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/billingRuns/{tenantId}","summary":"Creates a new billing run record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-runs/createbillingrun","deprecated":false},{"title":"/billingRuns/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-runs/executebatchoperations","deprecated":false},{"title":"/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}","summary":"Returns a list of records with the specified recurring_billing_run_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-runs/listrunsbyrecurringbillingrunid","deprecated":false},{"title":"/billingRuns/{tenantId}/refresh/{id}","summary":"Refreshes a billing run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-runs/refreshbillingrun","deprecated":false},{"title":"/billingRuns/{tenantId}/search","summary":"Searches for billing runs using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-runs/searchforbillingruns","deprecated":false},{"title":"/billingRuns/{tenantId}/{id}","summary":"Returns a billing run from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/billing-runs/deletebillingrun","deprecated":false},{"title":"/billingRuns/{tenantId}/{id}","summary":"Returns a billing run from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-runs/getbillingrun","deprecated":false},{"title":"/billingRuns/{tenantId}/{id}","summary":"Partially updates a billing run with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/billing-runs/patchbillingrun","deprecated":false},{"title":"/billingRuns/{tenantId}/{id}","summary":"Updates a billing run with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/billing-runs/updatebillingrun","deprecated":false}]}]}]}]}},{"type":"group","label":"Billing Templates","link":"/apis/certifications/certifications-v1/billing-templates","routeSlug":"/apis/certifications/certifications-v1/billing-templates","items":[{"label":"Gets all of the billing templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-templates/listbillingtemplates","routeSlug":"/apis/certifications/certifications-v1/billing-templates/listbillingtemplates","metadata":{"seo":{"title":"Gets all of the billing templates in the system.","description":"This method will scan all billing templates and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBillingTemplates","name":"Gets all of the billing templates in the system.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the billing templates in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all billing templates and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1billingTemplates~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingTemplates/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingTemplates/{tenantId}","href":"billing-templates/listbillingtemplates","openApiOperationId":"listBillingTemplates","summary":"Gets all of the billing templates in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing templateswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingTemplates~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/listbillingtemplates"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}"},{"label":"Creates a new billing template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-templates/createbillingtemplate","routeSlug":"/apis/certifications/certifications-v1/billing-templates/createbillingtemplate","metadata":{"seo":{"title":"Creates a new billing template record that does not already exist.","description":"This method will auto-generate an ID and create a new billing template. If an ID is specified for the billing template, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBillingTemplate","name":"Creates a new billing template record that does not already exist.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new billing template record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new billing template. If an ID is specified for the billing template, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","pointer":"/paths/~1billingTemplates~1{tenantId}/post/requestBody","description":"The billing template that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingTemplates/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingTemplates/{tenantId}","href":"billing-templates/createbillingtemplate","openApiOperationId":"createBillingTemplate","summary":"Creates a new billing template record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing template was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The billing template you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The billing template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingTemplates~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/createbillingtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-templates/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/billing-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1billingTemplates~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingTemplates/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingTemplates/{tenantId}/batch","href":"billing-templates/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The billing template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/executebatchoperations"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}/batch"},{"label":"Generates a billing run from a template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-templates/generatebillingrunfromtemplate","routeSlug":"/apis/certifications/certifications-v1/billing-templates/generatebillingrunfromtemplate","metadata":{"seo":{"title":"Generates a billing run from a template","description":"Generates a billing run from a template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateBillingRunFromTemplate","name":"Generates a billing run from a template","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}~1fromTemplate~1{templateId}~1{referenceDate}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates a billing run from a template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"templateId","in":"path","schemaId":"schema_366","description":"The template","required":true},{"name":"referenceDate","in":"path","schemaId":"schema_366","description":"The reference date","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1fromTemplate~1{templateId}~1{referenceDate}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingTemplates/{tenantId}/fromTemplate/{templateId}/{referenceDate}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_366"},{"name":"referenceDate","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingTemplates/{tenantId}/fromTemplate/{templateId}/{referenceDate}","href":"billing-templates/generatebillingrunfromtemplate","openApiOperationId":"generateBillingRunFromTemplate","summary":"Generates a billing run from a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1fromTemplate~1{templateId}~1{referenceDate}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/generatebillingrunfromtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}/fromTemplate/{templateId}/{referenceDate}"},{"label":"Returns a billing template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-templates/deletebillingtemplate","routeSlug":"/apis/certifications/certifications-v1/billing-templates/deletebillingtemplate","metadata":{"seo":{"title":"Returns a billing template from the system by its ID.","description":"This method will delete a billing template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBillingTemplate","name":"Returns a billing template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a billing template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the billing template to delete.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/billingTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingTemplates/{tenantId}/{id}","href":"billing-templates/deletebillingtemplate","openApiOperationId":"deleteBillingTemplate","summary":"Returns a billing template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing template was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The billing template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The billing template could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/deletebillingtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Returns a billing template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-templates/getbillingtemplate","routeSlug":"/apis/certifications/certifications-v1/billing-templates/getbillingtemplate","metadata":{"seo":{"title":"Returns a billing template from the system by its ID.","description":"This method will look up a billing template by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBillingTemplate","name":"Returns a billing template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a billing template by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the billing template to return.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingTemplates/{tenantId}/{id}","href":"billing-templates/getbillingtemplate","openApiOperationId":"getBillingTemplate","summary":"Returns a billing template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing template was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The billing template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/getbillingtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Partially updates a billing template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-templates/patchbillingtemplate","routeSlug":"/apis/certifications/certifications-v1/billing-templates/patchbillingtemplate","metadata":{"seo":{"title":"Partially updates a billing template with the specified ID.","description":"This method will patch an existing billing template with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBillingTemplate","name":"Partially updates a billing template with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a billing template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing billing template with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the billing template to patch.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/billingTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingTemplates/{tenantId}/{id}","href":"billing-templates/patchbillingtemplate","openApiOperationId":"patchBillingTemplate","summary":"Partially updates a billing template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing template was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The billing template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The billing template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/patchbillingtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Updates a billing template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/billing-templates/updatebillingtemplate","routeSlug":"/apis/certifications/certifications-v1/billing-templates/updatebillingtemplate","metadata":{"seo":{"title":"Updates a billing template with the specified ID.","description":"This method will update an existing billing template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBillingTemplate","name":"Updates a billing template with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a billing template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing billing template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the billing template to update.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/put/requestBody","description":"The updated billing template that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/billingTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingTemplates/{tenantId}/{id}","href":"billing-templates/updatebillingtemplate","openApiOperationId":"updateBillingTemplate","summary":"Updates a billing template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing template was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The billing template supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The billing template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The billing template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/updatebillingtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Billing Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Billing Templates","showPageActions":true},{"nodeType":"markdoc","content":"Billing Templates"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/billingTemplates/{tenantId}","summary":"Gets all of the billing templates in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-templates/listbillingtemplates","deprecated":false},{"title":"/billingTemplates/{tenantId}","summary":"Creates a new billing template record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-templates/createbillingtemplate","deprecated":false},{"title":"/billingTemplates/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-templates/executebatchoperations","deprecated":false},{"title":"/billingTemplates/{tenantId}/fromTemplate/{templateId}/{referenceDate}","summary":"Generates a billing run from a template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-templates/generatebillingrunfromtemplate","deprecated":false},{"title":"/billingTemplates/{tenantId}/{id}","summary":"Returns a billing template from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/billing-templates/deletebillingtemplate","deprecated":false},{"title":"/billingTemplates/{tenantId}/{id}","summary":"Returns a billing template from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-templates/getbillingtemplate","deprecated":false},{"title":"/billingTemplates/{tenantId}/{id}","summary":"Partially updates a billing template with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/billing-templates/patchbillingtemplate","deprecated":false},{"title":"/billingTemplates/{tenantId}/{id}","summary":"Updates a billing template with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/billing-templates/updatebillingtemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Certifications","link":"/apis/certifications/certifications-v1/certifications","routeSlug":"/apis/certifications/certifications-v1/certifications","items":[{"label":"Gets all of the certifications in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/certifications/listcertifications","routeSlug":"/apis/certifications/certifications-v1/certifications/listcertifications","metadata":{"seo":{"title":"Gets all of the certifications in the system.","description":"This method will scan all certifications and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCertifications","name":"Gets all of the certifications in the system.","isWebhook":false,"pointer":"/paths/~1certifications~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the certifications in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all certifications and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1certifications~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1certifications~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/certifications/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/certifications/{tenantId}","href":"certifications/listcertifications","openApiOperationId":"listCertifications","summary":"Gets all of the certifications in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The certificationswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}},"schemaId":"schema_382","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1certifications~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_382","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_382"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certifications/listcertifications"}],"panels":[]}]},"httpPath":"/certifications/{tenantId}"},{"label":"Creates a new certification record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/certifications/createcertification","routeSlug":"/apis/certifications/certifications-v1/certifications/createcertification","metadata":{"seo":{"title":"Creates a new certification record that does not already exist.","description":"This method will auto-generate an ID and create a new certification. If an ID is specified for the certification, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCertification","name":"Creates a new certification record that does not already exist.","isWebhook":false,"pointer":"/paths/~1certifications~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new certification record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new certification. If an ID is specified for the certification, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1certifications~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Certification"}},"schemaId":"components/schemas/Certification","pointer":"/paths/~1certifications~1{tenantId}/post/requestBody","description":"The certification that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/certifications/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Certification"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/certifications/{tenantId}","href":"certifications/createcertification","openApiOperationId":"createCertification","summary":"Creates a new certification record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Certification","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Certification"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The certification was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Certification"}},"schemaId":"components/schemas/Certification","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The certification you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The certification could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add certification based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1certifications~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Certification","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Certification"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certifications/createcertification"}],"panels":[]}]},"httpPath":"/certifications/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/certifications/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/certifications/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1certifications~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1certifications~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1certifications~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/certifications/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/certifications/{tenantId}/batch","href":"certifications/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The certification could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve certification based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1certifications~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certifications/executebatchoperations"}],"panels":[]}]},"httpPath":"/certifications/{tenantId}/batch"},{"label":"Downloads a Certificate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/certifications/downloadcertificate","routeSlug":"/apis/certifications/certifications-v1/certifications/downloadcertificate","metadata":{"seo":{"title":"Downloads a Certificate","description":"Returns the HTML for the certificate"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadCertificate","name":"Downloads a Certificate","isWebhook":false,"pointer":"/paths/~1certifications~1{tenantId}~1certificate~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Downloads a Certificate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the HTML for the certificate"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the certifications","required":true}],"pointer":"/paths/~1certifications~1{tenantId}~1certificate~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"downloadAsHtml","in":"query","schemaId":"schema_383","description":"If true, return the receipt as HTML"}],"pointer":"/paths/~1certifications~1{tenantId}~1certificate~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/certifications/{tenantId}/certificate/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"downloadAsHtml","in":"query","required":false,"schemaId":"schema_383"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/certifications/{tenantId}/certificate/{id}","href":"certifications/downloadcertificate","openApiOperationId":"downloadCertificate","summary":"Downloads a Certificate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The certifications was downloaded successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1certifications~1{tenantId}~1certificate~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certifications/downloadcertificate"}],"panels":[]}]},"httpPath":"/certifications/{tenantId}/certificate/{id}"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/certifications/listcertificationsbycontactid","routeSlug":"/apis/certifications/certifications-v1/certifications/listcertificationsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCertificationsByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1certifications~1{tenantId}~1contact~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified contact_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1certifications~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1certifications~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/certifications/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/certifications/{tenantId}/contact/{contact_id}","href":"certifications/listcertificationsbycontactid","openApiOperationId":"listCertificationsByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCertificationsResponse"}},"schemaId":"components/schemas/ListCertificationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1certifications~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCertificationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCertificationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certifications/listcertificationsbycontactid"}],"panels":[]}]},"httpPath":"/certifications/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/certifications/listcertificationsbyorganizationid","routeSlug":"/apis/certifications/certifications-v1/certifications/listcertificationsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCertificationsByOrganizationId","name":"Returns a list of records with the specified organization_id","isWebhook":false,"pointer":"/paths/~1certifications~1{tenantId}~1organization~1{organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified organization_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified organization_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"organization_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1certifications~1{tenantId}~1organization~1{organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1certifications~1{tenantId}~1organization~1{organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/certifications/{tenantId}/organization/{organization_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/certifications/{tenantId}/organization/{organization_id}","href":"certifications/listcertificationsbyorganizationid","openApiOperationId":"listCertificationsByOrganizationId","summary":"Returns a list of records with the specified organization_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCertificationsResponse"}},"schemaId":"components/schemas/ListCertificationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1certifications~1{tenantId}~1organization~1{organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCertificationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCertificationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certifications/listcertificationsbyorganizationid"}],"panels":[]}]},"httpPath":"/certifications/{tenantId}/organization/{organization_id}"},{"label":"Sends out a preview of the CRC notification certificate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/certifications/previewcertificate","routeSlug":"/apis/certifications/certifications-v1/certifications/previewcertificate","metadata":{"seo":{"title":"Sends out a preview of the CRC notification certificate","description":"Sends out a preview of the CRC notification certificate"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewCertificate","name":"Sends out a preview of the CRC notification certificate","isWebhook":false,"pointer":"/paths/~1certifications~1{tenantId}~1previewCertificate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the CRC notification certificate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the CRC notification certificate"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true}],"pointer":"/paths/~1certifications~1{tenantId}~1previewCertificate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewCertificateRequest"}},"schemaId":"components/schemas/PreviewCertificateRequest","pointer":"/paths/~1certifications~1{tenantId}~1previewCertificate/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/certifications/{tenantId}/previewCertificate","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewCertificateRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/certifications/{tenantId}/previewCertificate","href":"certifications/previewcertificate","openApiOperationId":"previewCertificate","summary":"Sends out a preview of the CRC notification certificate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewCertificateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewCertificateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1certifications~1{tenantId}~1previewCertificate/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certifications/previewcertificate"}],"panels":[]}]},"httpPath":"/certifications/{tenantId}/previewCertificate"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/certifications/previewemail","routeSlug":"/apis/certifications/certifications-v1/certifications/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewEmail","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1certifications~1{tenantId}~1previewEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the CRC notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the CRC notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true}],"pointer":"/paths/~1certifications~1{tenantId}~1previewEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"schemaId":"components/schemas/PreviewEmailRequest","pointer":"/paths/~1certifications~1{tenantId}~1previewEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/certifications/{tenantId}/previewEmail","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/certifications/{tenantId}/previewEmail","href":"certifications/previewemail","openApiOperationId":"previewEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1certifications~1{tenantId}~1previewEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certifications/previewemail"}],"panels":[]}]},"httpPath":"/certifications/{tenantId}/previewEmail"},{"label":"Searches for certifications using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/certifications/searchforcertifications","routeSlug":"/apis/certifications/certifications-v1/certifications/searchforcertifications","metadata":{"seo":{"title":"Searches for certifications using predefined parameters","description":"Searches for certifications using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForCertifications","name":"Searches for certifications using predefined parameters","isWebhook":false,"pointer":"/paths/~1certifications~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for certifications using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for certifications using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1certifications~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_366","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1certifications~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CertificationSearchParameters"}},"schemaId":"components/schemas/CertificationSearchParameters","pointer":"/paths/~1certifications~1{tenantId}~1search/post/requestBody","description":"The certification that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/certifications/{tenantId}/search","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CertificationSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/certifications/{tenantId}/search","href":"certifications/searchforcertifications","openApiOperationId":"searchForCertifications","summary":"Searches for certifications using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CertificationSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CertificationSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The certification search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCertificationSearchResults"}},"schemaId":"components/schemas/PagedCertificationSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The certification you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The certification could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add certification based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1certifications~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedCertificationSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCertificationSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certifications/searchforcertifications"}],"panels":[]}]},"httpPath":"/certifications/{tenantId}/search"},{"label":"Sends an certification notice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/certifications/sendcertificationnotice","routeSlug":"/apis/certifications/certifications-v1/certifications/sendcertificationnotice","metadata":{"seo":{"title":"Sends an certification notice","description":"This method will examine a certification certification and generate an appropriate order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendCertificationNotice","name":"Sends an certification notice","isWebhook":false,"pointer":"/paths/~1certifications~1{tenantId}~1sendNotice~1{notice_id}~1{id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends an certification notice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will examine a certification certification and generate an appropriate order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true},{"name":"notice_id","in":"path","schemaId":"schema_366","description":"The certification notice","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The certification","required":true}],"pointer":"/paths/~1certifications~1{tenantId}~1sendNotice~1{notice_id}~1{id}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"new_status_reason_id","in":"query","schemaId":"schema_366","description":"The new status reason"}],"pointer":"/paths/~1certifications~1{tenantId}~1sendNotice~1{notice_id}~1{id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/certifications/{tenantId}/sendNotice/{notice_id}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"notice_id","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"new_status_reason_id","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/certifications/{tenantId}/sendNotice/{notice_id}/{id}","href":"certifications/sendcertificationnotice","openApiOperationId":"sendCertificationNotice","summary":"Sends an certification notice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1certifications~1{tenantId}~1sendNotice~1{notice_id}~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certifications/sendcertificationnotice"}],"panels":[]}]},"httpPath":"/certifications/{tenantId}/sendNotice/{notice_id}/{id}"},{"label":"Returns a certification from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/certifications/deletecertification","routeSlug":"/apis/certifications/certifications-v1/certifications/deletecertification","metadata":{"seo":{"title":"Returns a certification from the system by its ID.","description":"This method will delete a certification with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCertification","name":"Returns a certification from the system by its ID.","isWebhook":false,"pointer":"/paths/~1certifications~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a certification from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a certification with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the certification to delete.","required":true}],"pointer":"/paths/~1certifications~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/certifications/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/certifications/{tenantId}/{id}","href":"certifications/deletecertification","openApiOperationId":"deleteCertification","summary":"Returns a certification from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The certification was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The certification could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The certification could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete certification based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1certifications~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certifications/deletecertification"}],"panels":[]}]},"httpPath":"/certifications/{tenantId}/{id}"},{"label":"Returns a certification from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/certifications/getcertification","routeSlug":"/apis/certifications/certifications-v1/certifications/getcertification","metadata":{"seo":{"title":"Returns a certification from the system by its ID.","description":"This method will look up a certification by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCertification","name":"Returns a certification from the system by its ID.","isWebhook":false,"pointer":"/paths/~1certifications~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a certification from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a certification by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the certification to return.","required":true}],"pointer":"/paths/~1certifications~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1certifications~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/certifications/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/certifications/{tenantId}/{id}","href":"certifications/getcertification","openApiOperationId":"getCertification","summary":"Returns a certification from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The certification was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Certification"}},"schemaId":"components/schemas/Certification","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The certification could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve certification based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1certifications~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Certification","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Certification"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certifications/getcertification"}],"panels":[]}]},"httpPath":"/certifications/{tenantId}/{id}"},{"label":"Partially updates a certification with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/certifications/patchcertification","routeSlug":"/apis/certifications/certifications-v1/certifications/patchcertification","metadata":{"seo":{"title":"Partially updates a certification with the specified ID.","description":"This method will patch an existing certification with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCertification","name":"Partially updates a certification with the specified ID.","isWebhook":false,"pointer":"/paths/~1certifications~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a certification with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing certification with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the certification to patch.","required":true}],"pointer":"/paths/~1certifications~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1certifications~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/certifications/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/certifications/{tenantId}/{id}","href":"certifications/patchcertification","openApiOperationId":"patchCertification","summary":"Partially updates a certification with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The certification was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Certification"}},"schemaId":"components/schemas/Certification","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The certification could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The certification could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve certification based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1certifications~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Certification","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Certification"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certifications/patchcertification"}],"panels":[]}]},"httpPath":"/certifications/{tenantId}/{id}"},{"label":"Updates a certification with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/certifications/updatecertification","routeSlug":"/apis/certifications/certifications-v1/certifications/updatecertification","metadata":{"seo":{"title":"Updates a certification with the specified ID.","description":"This method will update an existing certification with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCertification","name":"Updates a certification with the specified ID.","isWebhook":false,"pointer":"/paths/~1certifications~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a certification with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing certification with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the certification to update.","required":true}],"pointer":"/paths/~1certifications~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Certification"}},"schemaId":"components/schemas/Certification","pointer":"/paths/~1certifications~1{tenantId}~1{id}/put/requestBody","description":"The updated certification that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/certifications/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Certification"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/certifications/{tenantId}/{id}","href":"certifications/updatecertification","openApiOperationId":"updateCertification","summary":"Updates a certification with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Certification","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Certification"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The certification was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Certification"}},"schemaId":"components/schemas/Certification","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The certification supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The certification could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The certification could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve certification based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1certifications~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Certification","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Certification"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certifications/updatecertification"}],"panels":[]}]},"httpPath":"/certifications/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Certifications"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Certifications","showPageActions":true},{"nodeType":"markdoc","content":"Certifications"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/certifications/{tenantId}","summary":"Gets all of the certifications in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/certifications/listcertifications","deprecated":false},{"title":"/certifications/{tenantId}","summary":"Creates a new certification record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/certifications/createcertification","deprecated":false},{"title":"/certifications/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/certifications/executebatchoperations","deprecated":false},{"title":"/certifications/{tenantId}/certificate/{id}","summary":"Downloads a Certificate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/certifications/downloadcertificate","deprecated":false},{"title":"/certifications/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/certifications/listcertificationsbycontactid","deprecated":false},{"title":"/certifications/{tenantId}/organization/{organization_id}","summary":"Returns a list of records with the specified organization_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/certifications/listcertificationsbyorganizationid","deprecated":false},{"title":"/certifications/{tenantId}/previewCertificate","summary":"Sends out a preview of the CRC notification certificate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/certifications/previewcertificate","deprecated":false},{"title":"/certifications/{tenantId}/previewEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/certifications/previewemail","deprecated":false},{"title":"/certifications/{tenantId}/search","summary":"Searches for certifications using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/certifications/searchforcertifications","deprecated":false},{"title":"/certifications/{tenantId}/sendNotice/{notice_id}/{id}","summary":"Sends an certification notice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/certifications/sendcertificationnotice","deprecated":false},{"title":"/certifications/{tenantId}/{id}","summary":"Returns a certification from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/certifications/deletecertification","deprecated":false},{"title":"/certifications/{tenantId}/{id}","summary":"Returns a certification from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/certifications/getcertification","deprecated":false},{"title":"/certifications/{tenantId}/{id}","summary":"Partially updates a certification with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/certifications/patchcertification","deprecated":false},{"title":"/certifications/{tenantId}/{id}","summary":"Updates a certification with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/certifications/updatecertification","deprecated":false}]}]}]}]}},{"type":"group","label":"Coupons","link":"/apis/certifications/certifications-v1/coupons","routeSlug":"/apis/certifications/certifications-v1/coupons","items":[{"label":"Gets all of the coupons in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/coupons/listcoupons","routeSlug":"/apis/certifications/certifications-v1/coupons/listcoupons","metadata":{"seo":{"title":"Gets all of the coupons in the system.","description":"This method will scan all coupons and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCoupons","name":"Gets all of the coupons in the system.","isWebhook":false,"pointer":"/paths/~1coupons~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the coupons in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all coupons and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1coupons~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1coupons~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/coupons/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/coupons/{tenantId}","href":"coupons/listcoupons","openApiOperationId":"listCoupons","summary":"Gets all of the coupons in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The couponswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384"}},"schemaId":"schema_384","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1coupons~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_384","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/listcoupons"}],"panels":[]}]},"httpPath":"/coupons/{tenantId}"},{"label":"Creates a new coupon record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/coupons/createcoupon","routeSlug":"/apis/certifications/certifications-v1/coupons/createcoupon","metadata":{"seo":{"title":"Creates a new coupon record that does not already exist.","description":"This method will auto-generate an ID and create a new coupon. If an ID is specified for the coupon, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCoupon","name":"Creates a new coupon record that does not already exist.","isWebhook":false,"pointer":"/paths/~1coupons~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new coupon record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new coupon. If an ID is specified for the coupon, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1coupons~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","pointer":"/paths/~1coupons~1{tenantId}/post/requestBody","description":"The coupon that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/coupons/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Coupon"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/coupons/{tenantId}","href":"coupons/createcoupon","openApiOperationId":"createCoupon","summary":"Creates a new coupon record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Coupon"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The coupon you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The coupon could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add coupon based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1coupons~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/createcoupon"}],"panels":[]}]},"httpPath":"/coupons/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/coupons/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/coupons/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1coupons~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1coupons~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1coupons~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/coupons/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/coupons/{tenantId}/batch","href":"coupons/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The coupon could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve coupon based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1coupons~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/executebatchoperations"}],"panels":[]}]},"httpPath":"/coupons/{tenantId}/batch"},{"label":"Returns a coupon from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/coupons/deletecoupon","routeSlug":"/apis/certifications/certifications-v1/coupons/deletecoupon","metadata":{"seo":{"title":"Returns a coupon from the system by its ID.","description":"This method will delete a coupon with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCoupon","name":"Returns a coupon from the system by its ID.","isWebhook":false,"pointer":"/paths/~1coupons~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a coupon from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a coupon with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the coupon to delete.","required":true}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/coupons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/coupons/{tenantId}/{id}","href":"coupons/deletecoupon","openApiOperationId":"deleteCoupon","summary":"Returns a coupon from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The coupon could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The coupon could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete coupon based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/deletecoupon"}],"panels":[]}]},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Returns a coupon from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/coupons/getcoupon","routeSlug":"/apis/certifications/certifications-v1/coupons/getcoupon","metadata":{"seo":{"title":"Returns a coupon from the system by its ID.","description":"This method will look up a coupon by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCoupon","name":"Returns a coupon from the system by its ID.","isWebhook":false,"pointer":"/paths/~1coupons~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a coupon from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a coupon by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the coupon to return.","required":true}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/coupons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/coupons/{tenantId}/{id}","href":"coupons/getcoupon","openApiOperationId":"getCoupon","summary":"Returns a coupon from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The coupon could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve coupon based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/getcoupon"}],"panels":[]}]},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Partially updates a coupon with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/coupons/patchcoupon","routeSlug":"/apis/certifications/certifications-v1/coupons/patchcoupon","metadata":{"seo":{"title":"Partially updates a coupon with the specified ID.","description":"This method will patch an existing coupon with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCoupon","name":"Partially updates a coupon with the specified ID.","isWebhook":false,"pointer":"/paths/~1coupons~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a coupon with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing coupon with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the coupon to patch.","required":true}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1coupons~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/coupons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/coupons/{tenantId}/{id}","href":"coupons/patchcoupon","openApiOperationId":"patchCoupon","summary":"Partially updates a coupon with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The coupon could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The coupon could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve coupon based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/patchcoupon"}],"panels":[]}]},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Updates a coupon with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/coupons/updatecoupon","routeSlug":"/apis/certifications/certifications-v1/coupons/updatecoupon","metadata":{"seo":{"title":"Updates a coupon with the specified ID.","description":"This method will update an existing coupon with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCoupon","name":"Updates a coupon with the specified ID.","isWebhook":false,"pointer":"/paths/~1coupons~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a coupon with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing coupon with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the coupon to update.","required":true}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","pointer":"/paths/~1coupons~1{tenantId}~1{id}/put/requestBody","description":"The updated coupon that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/coupons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Coupon"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/coupons/{tenantId}/{id}","href":"coupons/updatecoupon","openApiOperationId":"updateCoupon","summary":"Updates a coupon with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Coupon"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The coupon was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}},"schemaId":"components/schemas/Coupon","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The coupon supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The coupon could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The coupon could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve coupon based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Coupon","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Coupon"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coupons/updatecoupon"}],"panels":[]}]},"httpPath":"/coupons/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Coupons"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Coupons","showPageActions":true},{"nodeType":"markdoc","content":"Coupons"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/coupons/{tenantId}","summary":"Gets all of the coupons in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coupons/listcoupons","deprecated":false},{"title":"/coupons/{tenantId}","summary":"Creates a new coupon record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupons/createcoupon","deprecated":false},{"title":"/coupons/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coupons/executebatchoperations","deprecated":false},{"title":"/coupons/{tenantId}/{id}","summary":"Returns a coupon from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/coupons/deletecoupon","deprecated":false},{"title":"/coupons/{tenantId}/{id}","summary":"Returns a coupon from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coupons/getcoupon","deprecated":false},{"title":"/coupons/{tenantId}/{id}","summary":"Partially updates a coupon with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/coupons/patchcoupon","deprecated":false},{"title":"/coupons/{tenantId}/{id}","summary":"Updates a coupon with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/coupons/updatecoupon","deprecated":false}]}]}]}]}},{"type":"group","label":"Course Fees","link":"/apis/certifications/certifications-v1/course-fees","routeSlug":"/apis/certifications/certifications-v1/course-fees","items":[{"label":"Creates a new course fee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-fees/createcoursefee","routeSlug":"/apis/certifications/certifications-v1/course-fees/createcoursefee","metadata":{"seo":{"title":"Creates a new course fee record that does not already exist.","description":"This method will auto-generate an ID and create a new course fee. If an ID is specified for the course fee, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCourseFee","name":"Creates a new course fee record that does not already exist.","isWebhook":false,"pointer":"/paths/~1courseFees~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new course fee record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new course fee. If an ID is specified for the course fee, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseFees~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseFee"}},"schemaId":"components/schemas/CourseFee","pointer":"/paths/~1courseFees~1{tenantId}/post/requestBody","description":"The course fee that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseFees/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CourseFee"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseFees/{tenantId}","href":"course-fees/createcoursefee","openApiOperationId":"createCourseFee","summary":"Creates a new course fee record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CourseFee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseFee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course fee was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseFee"}},"schemaId":"components/schemas/CourseFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course fee you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add course fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseFees~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-fees/createcoursefee"}],"panels":[]}]},"httpPath":"/courseFees/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-fees/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/course-fees/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1courseFees~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseFees~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1courseFees~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseFees/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseFees/{tenantId}/batch","href":"course-fees/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseFees~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-fees/executebatchoperations"}],"panels":[]}]},"httpPath":"/courseFees/{tenantId}/batch"},{"label":"Returns a list of records with the specified course_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-fees/listfeesbycourseid","routeSlug":"/apis/certifications/certifications-v1/course-fees/listfeesbycourseid","metadata":{"seo":{"title":"Returns a list of records with the specified course_id","description":"Returns a list of records with the specified course_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFeesByCourseId","name":"Returns a list of records with the specified course_id","isWebhook":false,"pointer":"/paths/~1courseFees~1{tenantId}~1course~1{course_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified course_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified course_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"course_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The course_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1courseFees~1{tenantId}~1course~1{course_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1courseFees~1{tenantId}~1course~1{course_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseFees/{tenantId}/course/{course_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"course_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseFees/{tenantId}/course/{course_id}","href":"course-fees/listfeesbycourseid","openApiOperationId":"listFeesByCourseId","summary":"Returns a list of records with the specified course_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseFeesResponse"}},"schemaId":"components/schemas/ListCourseFeesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseFees~1{tenantId}~1course~1{course_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCourseFeesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseFeesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-fees/listfeesbycourseid"}],"panels":[]}]},"httpPath":"/courseFees/{tenantId}/course/{course_id}"},{"label":"Get Fees for Online Store","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-fees/getfeesforonlinestore","routeSlug":"/apis/certifications/certifications-v1/course-fees/getfeesforonlinestore","metadata":{"seo":{"title":"Get Fees for Online Store","description":"Public endpoint that gets fees for use in the online store"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFeesForOnlineStore","name":"Get Fees for Online Store","isWebhook":false,"pointer":"/paths/~1courseFees~1{tenantId}~1public~1onlineStore/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Fees for Online Store","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Public endpoint that gets fees for use in the online store"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true}],"pointer":"/paths/~1courseFees~1{tenantId}~1public~1onlineStore/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicCertificationCourseFeesRequest"}},"schemaId":"components/schemas/PublicCertificationCourseFeesRequest","pointer":"/paths/~1courseFees~1{tenantId}~1public~1onlineStore/post/requestBody","description":"Restrictions"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseFees/{tenantId}/public/onlineStore","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PublicCertificationCourseFeesRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseFees/{tenantId}/public/onlineStore","href":"course-fees/getfeesforonlinestore","openApiOperationId":"getFeesForOnlineStore","summary":"Get Fees for Online Store"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PublicCertificationCourseFeesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicCertificationCourseFeesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The store was retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PublicCertificationCourseFeesResponse"}},"schemaId":"components/schemas/PublicCertificationCourseFeesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseFees~1{tenantId}~1public~1onlineStore/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PublicCertificationCourseFeesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PublicCertificationCourseFeesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-fees/getfeesforonlinestore"}],"panels":[]}]},"httpPath":"/courseFees/{tenantId}/public/onlineStore"},{"label":"Returns a course fee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-fees/deletecoursefee","routeSlug":"/apis/certifications/certifications-v1/course-fees/deletecoursefee","metadata":{"seo":{"title":"Returns a course fee from the system by its ID.","description":"This method will delete a course fee with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCourseFee","name":"Returns a course fee from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courseFees~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course fee from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a course fee with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course fee to delete.","required":true}],"pointer":"/paths/~1courseFees~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/courseFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseFees/{tenantId}/{id}","href":"course-fees/deletecoursefee","openApiOperationId":"deleteCourseFee","summary":"Returns a course fee from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course fee was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course fee could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete course fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseFees~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-fees/deletecoursefee"}],"panels":[]}]},"httpPath":"/courseFees/{tenantId}/{id}"},{"label":"Returns a course fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-fees/getcoursefee","routeSlug":"/apis/certifications/certifications-v1/course-fees/getcoursefee","metadata":{"seo":{"title":"Returns a course fee from the system by its ID.","description":"This method will look up a course fee by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCourseFee","name":"Returns a course fee from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courseFees~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course fee from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a course fee by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course fee to return.","required":true}],"pointer":"/paths/~1courseFees~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1courseFees~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseFees/{tenantId}/{id}","href":"course-fees/getcoursefee","openApiOperationId":"getCourseFee","summary":"Returns a course fee from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course fee was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseFee"}},"schemaId":"components/schemas/CourseFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseFees~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-fees/getcoursefee"}],"panels":[]}]},"httpPath":"/courseFees/{tenantId}/{id}"},{"label":"Partially updates a course fee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-fees/patchcoursefee","routeSlug":"/apis/certifications/certifications-v1/course-fees/patchcoursefee","metadata":{"seo":{"title":"Partially updates a course fee with the specified ID.","description":"This method will patch an existing course fee with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCourseFee","name":"Partially updates a course fee with the specified ID.","isWebhook":false,"pointer":"/paths/~1courseFees~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a course fee with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing course fee with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course fee to patch.","required":true}],"pointer":"/paths/~1courseFees~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1courseFees~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/courseFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseFees/{tenantId}/{id}","href":"course-fees/patchcoursefee","openApiOperationId":"patchCourseFee","summary":"Partially updates a course fee with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course fee was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseFee"}},"schemaId":"components/schemas/CourseFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseFees~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-fees/patchcoursefee"}],"panels":[]}]},"httpPath":"/courseFees/{tenantId}/{id}"},{"label":"Updates a course fee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-fees/updatecoursefee","routeSlug":"/apis/certifications/certifications-v1/course-fees/updatecoursefee","metadata":{"seo":{"title":"Updates a course fee with the specified ID.","description":"This method will update an existing course fee with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCourseFee","name":"Updates a course fee with the specified ID.","isWebhook":false,"pointer":"/paths/~1courseFees~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a course fee with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing course fee with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course fee to update.","required":true}],"pointer":"/paths/~1courseFees~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseFee"}},"schemaId":"components/schemas/CourseFee","pointer":"/paths/~1courseFees~1{tenantId}~1{id}/put/requestBody","description":"The updated course fee that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/courseFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CourseFee"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseFees/{tenantId}/{id}","href":"course-fees/updatecoursefee","openApiOperationId":"updateCourseFee","summary":"Updates a course fee with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CourseFee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseFee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course fee was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseFee"}},"schemaId":"components/schemas/CourseFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course fee supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseFees~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-fees/updatecoursefee"}],"panels":[]}]},"httpPath":"/courseFees/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Course Fees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Course Fees","showPageActions":true},{"nodeType":"markdoc","content":"Course Fees"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/courseFees/{tenantId}","summary":"Creates a new course fee record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-fees/createcoursefee","deprecated":false},{"title":"/courseFees/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-fees/executebatchoperations","deprecated":false},{"title":"/courseFees/{tenantId}/course/{course_id}","summary":"Returns a list of records with the specified course_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-fees/listfeesbycourseid","deprecated":false},{"title":"/courseFees/{tenantId}/public/onlineStore","summary":"Get Fees for Online Store","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-fees/getfeesforonlinestore","deprecated":false},{"title":"/courseFees/{tenantId}/{id}","summary":"Returns a course fee from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/course-fees/deletecoursefee","deprecated":false},{"title":"/courseFees/{tenantId}/{id}","summary":"Returns a course fee from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-fees/getcoursefee","deprecated":false},{"title":"/courseFees/{tenantId}/{id}","summary":"Partially updates a course fee with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/course-fees/patchcoursefee","deprecated":false},{"title":"/courseFees/{tenantId}/{id}","summary":"Updates a course fee with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/course-fees/updatecoursefee","deprecated":false}]}]}]}]}},{"type":"group","label":"Course Instructors","link":"/apis/certifications/certifications-v1/course-instructors","routeSlug":"/apis/certifications/certifications-v1/course-instructors","items":[{"label":"Returns a list of records with the specified tenant_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-instructors/listinstructorsbytenantid","routeSlug":"/apis/certifications/certifications-v1/course-instructors/listinstructorsbytenantid","metadata":{"seo":{"title":"Returns a list of records with the specified tenant_id","description":"Returns a list of records with the specified tenant_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInstructorsByTenantId","name":"Returns a list of records with the specified tenant_id","isWebhook":false,"pointer":"/paths/~1courseInstructors~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified tenant_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified tenant_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true}],"pointer":"/paths/~1courseInstructors~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1courseInstructors~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseInstructors/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/courseInstructors/{tenantId}","href":"course-instructors/listinstructorsbytenantid","openApiOperationId":"listInstructorsByTenantId","summary":"Returns a list of records with the specified tenant_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseInstructorsResponse"}},"schemaId":"components/schemas/ListCourseInstructorsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseInstructors~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCourseInstructorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseInstructorsResponse"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-instructors/listinstructorsbytenantid"}],"panels":[]}]},"httpPath":"/courseInstructors/{tenantId}"},{"label":"Creates a new course instructor record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-instructors/createcourseinstructor","routeSlug":"/apis/certifications/certifications-v1/course-instructors/createcourseinstructor","metadata":{"seo":{"title":"Creates a new course instructor record that does not already exist.","description":"This method will auto-generate an ID and create a new course instructor. If an ID is specified for the course instructor, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCourseInstructor","name":"Creates a new course instructor record that does not already exist.","isWebhook":false,"pointer":"/paths/~1courseInstructors~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new course instructor record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new course instructor. If an ID is specified for the course instructor, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseInstructors~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseInstructor"}},"schemaId":"components/schemas/CourseInstructor","pointer":"/paths/~1courseInstructors~1{tenantId}/post/requestBody","description":"The course instructor that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseInstructors/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CourseInstructor"}},"responseCodes":["200","400","401","403","409","429","500"],"pointer":"/courseInstructors/{tenantId}","href":"course-instructors/createcourseinstructor","openApiOperationId":"createCourseInstructor","summary":"Creates a new course instructor record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CourseInstructor","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseInstructor"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course instructor was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseInstructor"}},"schemaId":"components/schemas/CourseInstructor","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course instructor you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course instructor could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add course instructor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseInstructors~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseInstructor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseInstructor"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-instructors/createcourseinstructor"}],"panels":[]}]},"httpPath":"/courseInstructors/{tenantId}"},{"label":"Returns a course instructor from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-instructors/deletecourseinstructor","routeSlug":"/apis/certifications/certifications-v1/course-instructors/deletecourseinstructor","metadata":{"seo":{"title":"Returns a course instructor from the system by its ID.","description":"This method will delete a course instructor with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCourseInstructor","name":"Returns a course instructor from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courseInstructors~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course instructor from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a course instructor with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course instructor to delete.","required":true}],"pointer":"/paths/~1courseInstructors~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/courseInstructors/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseInstructors/{tenantId}/{id}","href":"course-instructors/deletecourseinstructor","openApiOperationId":"deleteCourseInstructor","summary":"Returns a course instructor from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course instructor was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course instructor could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course instructor could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete course instructor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseInstructors~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-instructors/deletecourseinstructor"}],"panels":[]}]},"httpPath":"/courseInstructors/{tenantId}/{id}"},{"label":"Returns a course instructor from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-instructors/getcourseinstructor","routeSlug":"/apis/certifications/certifications-v1/course-instructors/getcourseinstructor","metadata":{"seo":{"title":"Returns a course instructor from the system by its ID.","description":"This method will look up a course instructor by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCourseInstructor","name":"Returns a course instructor from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courseInstructors~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course instructor from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a course instructor by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course instructor to return.","required":true}],"pointer":"/paths/~1courseInstructors~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1courseInstructors~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseInstructors/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseInstructors/{tenantId}/{id}","href":"course-instructors/getcourseinstructor","openApiOperationId":"getCourseInstructor","summary":"Returns a course instructor from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course instructor was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseInstructor"}},"schemaId":"components/schemas/CourseInstructor","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course instructor could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course instructor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseInstructors~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseInstructor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseInstructor"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-instructors/getcourseinstructor"}],"panels":[]}]},"httpPath":"/courseInstructors/{tenantId}/{id}"},{"label":"Partially updates a course instructor with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-instructors/patchcourseinstructor","routeSlug":"/apis/certifications/certifications-v1/course-instructors/patchcourseinstructor","metadata":{"seo":{"title":"Partially updates a course instructor with the specified ID.","description":"This method will patch an existing course instructor with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCourseInstructor","name":"Partially updates a course instructor with the specified ID.","isWebhook":false,"pointer":"/paths/~1courseInstructors~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a course instructor with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing course instructor with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course instructor to patch.","required":true}],"pointer":"/paths/~1courseInstructors~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1courseInstructors~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/courseInstructors/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseInstructors/{tenantId}/{id}","href":"course-instructors/patchcourseinstructor","openApiOperationId":"patchCourseInstructor","summary":"Partially updates a course instructor with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course instructor was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseInstructor"}},"schemaId":"components/schemas/CourseInstructor","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course instructor could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course instructor could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course instructor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseInstructors~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseInstructor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseInstructor"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-instructors/patchcourseinstructor"}],"panels":[]}]},"httpPath":"/courseInstructors/{tenantId}/{id}"},{"label":"Updates a course instructor with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-instructors/updatecourseinstructor","routeSlug":"/apis/certifications/certifications-v1/course-instructors/updatecourseinstructor","metadata":{"seo":{"title":"Updates a course instructor with the specified ID.","description":"This method will update an existing course instructor with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCourseInstructor","name":"Updates a course instructor with the specified ID.","isWebhook":false,"pointer":"/paths/~1courseInstructors~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a course instructor with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing course instructor with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course instructor to update.","required":true}],"pointer":"/paths/~1courseInstructors~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseInstructor"}},"schemaId":"components/schemas/CourseInstructor","pointer":"/paths/~1courseInstructors~1{tenantId}~1{id}/put/requestBody","description":"The updated course instructor that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/courseInstructors/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CourseInstructor"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseInstructors/{tenantId}/{id}","href":"course-instructors/updatecourseinstructor","openApiOperationId":"updateCourseInstructor","summary":"Updates a course instructor with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CourseInstructor","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseInstructor"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course instructor was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseInstructor"}},"schemaId":"components/schemas/CourseInstructor","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course instructor supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course instructor could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course instructor could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course instructor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseInstructors~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseInstructor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseInstructor"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-instructors/updatecourseinstructor"}],"panels":[]}]},"httpPath":"/courseInstructors/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Course Instructors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Course Instructors","showPageActions":true},{"nodeType":"markdoc","content":"Course Instructors"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/courseInstructors/{tenantId}","summary":"Returns a list of records with the specified tenant_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-instructors/listinstructorsbytenantid","deprecated":false},{"title":"/courseInstructors/{tenantId}","summary":"Creates a new course instructor record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-instructors/createcourseinstructor","deprecated":false},{"title":"/courseInstructors/{tenantId}/{id}","summary":"Returns a course instructor from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/course-instructors/deletecourseinstructor","deprecated":false},{"title":"/courseInstructors/{tenantId}/{id}","summary":"Returns a course instructor from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-instructors/getcourseinstructor","deprecated":false},{"title":"/courseInstructors/{tenantId}/{id}","summary":"Partially updates a course instructor with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/course-instructors/patchcourseinstructor","deprecated":false},{"title":"/courseInstructors/{tenantId}/{id}","summary":"Updates a course instructor with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/course-instructors/updatecourseinstructor","deprecated":false}]}]}]}]}},{"type":"group","label":"Course Offerings","link":"/apis/certifications/certifications-v1/course-offerings","routeSlug":"/apis/certifications/certifications-v1/course-offerings","items":[{"label":"Creates a new course offering record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-offerings/createcourseoffering","routeSlug":"/apis/certifications/certifications-v1/course-offerings/createcourseoffering","metadata":{"seo":{"title":"Creates a new course offering record that does not already exist.","description":"This method will auto-generate an ID and create a new course offering. If an ID is specified for the course offering, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCourseOffering","name":"Creates a new course offering record that does not already exist.","isWebhook":false,"pointer":"/paths/~1courseOfferings~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new course offering record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new course offering. If an ID is specified for the course offering, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseOfferings~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseOffering"}},"schemaId":"components/schemas/CourseOffering","pointer":"/paths/~1courseOfferings~1{tenantId}/post/requestBody","description":"The course offering that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseOfferings/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CourseOffering"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseOfferings/{tenantId}","href":"course-offerings/createcourseoffering","openApiOperationId":"createCourseOffering","summary":"Creates a new course offering record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CourseOffering","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseOffering"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course offering was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseOffering"}},"schemaId":"components/schemas/CourseOffering","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course offering you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course offering could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add course offering based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseOfferings~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseOffering","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseOffering"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-offerings/createcourseoffering"}],"panels":[]}]},"httpPath":"/courseOfferings/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-offerings/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/course-offerings/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1courseOfferings~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1courseOfferings~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseOfferings/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseOfferings/{tenantId}/batch","href":"course-offerings/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course offering could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course offering based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-offerings/executebatchoperations"}],"panels":[]}]},"httpPath":"/courseOfferings/{tenantId}/batch"},{"label":"Returns a list of records with the specified course_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-offerings/listofferingsbycourseid","routeSlug":"/apis/certifications/certifications-v1/course-offerings/listofferingsbycourseid","metadata":{"seo":{"title":"Returns a list of records with the specified course_id","description":"Returns a list of records with the specified course_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOfferingsByCourseId","name":"Returns a list of records with the specified course_id","isWebhook":false,"pointer":"/paths/~1courseOfferings~1{tenantId}~1course~1{course_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified course_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified course_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"course_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The course_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1course~1{course_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includePastOfferings","in":"query","schemaId":"schema_366","description":"If set, past offerings are included in the list"},{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1course~1{course_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseOfferings/{tenantId}/course/{course_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"course_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"includePastOfferings","in":"query","required":false,"schemaId":"schema_366"},{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseOfferings/{tenantId}/course/{course_id}","href":"course-offerings/listofferingsbycourseid","openApiOperationId":"listOfferingsByCourseId","summary":"Returns a list of records with the specified course_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseOfferingsResponse"}},"schemaId":"components/schemas/ListCourseOfferingsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1course~1{course_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCourseOfferingsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseOfferingsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-offerings/listofferingsbycourseid"}],"panels":[]}]},"httpPath":"/courseOfferings/{tenantId}/course/{course_id}"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-offerings/listofferingsbyeventid","routeSlug":"/apis/certifications/certifications-v1/course-offerings/listofferingsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOfferingsByEventId","name":"Returns a list of records with the specified event_id","isWebhook":false,"pointer":"/paths/~1courseOfferings~1{tenantId}~1event~1{event_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified event_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified event_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"event_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1event~1{event_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1event~1{event_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseOfferings/{tenantId}/event/{event_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"event_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseOfferings/{tenantId}/event/{event_id}","href":"course-offerings/listofferingsbyeventid","openApiOperationId":"listOfferingsByEventId","summary":"Returns a list of records with the specified event_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseOfferingsResponse"}},"schemaId":"components/schemas/ListCourseOfferingsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1event~1{event_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCourseOfferingsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseOfferingsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-offerings/listofferingsbyeventid"}],"panels":[]}]},"httpPath":"/courseOfferings/{tenantId}/event/{event_id}"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-offerings/listofferingsbyeventidpublic","routeSlug":"/apis/certifications/certifications-v1/course-offerings/listofferingsbyeventidpublic","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOfferingsByEventIdPublic","name":"Returns a list of records with the specified event_id","isWebhook":false,"pointer":"/paths/~1courseOfferings~1{tenantId}~1event~1{event_id}~1public/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified event_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified event_id"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"event_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1event~1{event_id}~1public/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1event~1{event_id}~1public/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseOfferings/{tenantId}/event/{event_id}/public","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"event_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseOfferings/{tenantId}/event/{event_id}/public","href":"course-offerings/listofferingsbyeventidpublic","openApiOperationId":"listOfferingsByEventIdPublic","summary":"Returns a list of records with the specified event_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseOfferingsResponse"}},"schemaId":"components/schemas/ListCourseOfferingsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1event~1{event_id}~1public/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCourseOfferingsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseOfferingsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-offerings/listofferingsbyeventidpublic"}],"panels":[]}]},"httpPath":"/courseOfferings/{tenantId}/event/{event_id}/public"},{"label":"Returns a list of records with the specified instructor_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-offerings/listofferingsbyinstructorid","routeSlug":"/apis/certifications/certifications-v1/course-offerings/listofferingsbyinstructorid","metadata":{"seo":{"title":"Returns a list of records with the specified instructor_id","description":"Returns a list of records with the specified instructor_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOfferingsByInstructorId","name":"Returns a list of records with the specified instructor_id","isWebhook":false,"pointer":"/paths/~1courseOfferings~1{tenantId}~1instructor~1{instructor_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified instructor_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified instructor_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"instructor_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The instructor_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1instructor~1{instructor_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1instructor~1{instructor_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseOfferings/{tenantId}/instructor/{instructor_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"instructor_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseOfferings/{tenantId}/instructor/{instructor_id}","href":"course-offerings/listofferingsbyinstructorid","openApiOperationId":"listOfferingsByInstructorId","summary":"Returns a list of records with the specified instructor_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseOfferingsResponse"}},"schemaId":"components/schemas/ListCourseOfferingsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1instructor~1{instructor_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCourseOfferingsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseOfferingsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-offerings/listofferingsbyinstructorid"}],"panels":[]}]},"httpPath":"/courseOfferings/{tenantId}/instructor/{instructor_id}"},{"label":"Returns a list of records with the specified course_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-offerings/describeofferings","routeSlug":"/apis/certifications/certifications-v1/course-offerings/describeofferings","metadata":{"seo":{"title":"Returns a list of records with the specified course_id","description":"Returns a list of records with the specified course_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"describeOfferings","name":"Returns a list of records with the specified course_id","isWebhook":false,"pointer":"/paths/~1courseOfferings~1{tenantId}~1portal~1{contact_id}~1describeForCourse~1{course_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified course_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified course_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"course_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The course_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1portal~1{contact_id}~1describeForCourse~1{course_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1portal~1{contact_id}~1describeForCourse~1{course_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseOfferings/{tenantId}/portal/{contact_id}/describeForCourse/{course_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_366"},{"name":"course_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseOfferings/{tenantId}/portal/{contact_id}/describeForCourse/{course_id}","href":"course-offerings/describeofferings","openApiOperationId":"describeOfferings","summary":"Returns a list of records with the specified course_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DescribeCourseOfferingsResponse"}},"schemaId":"components/schemas/DescribeCourseOfferingsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1portal~1{contact_id}~1describeForCourse~1{course_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DescribeCourseOfferingsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DescribeCourseOfferingsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-offerings/describeofferings"}],"panels":[]}]},"httpPath":"/courseOfferings/{tenantId}/portal/{contact_id}/describeForCourse/{course_id}"},{"label":"Returns a course offering from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-offerings/getcoursepublic","routeSlug":"/apis/certifications/certifications-v1/course-offerings/getcoursepublic","metadata":{"seo":{"title":"Returns a course offering from the system by its ID.","description":"This method will look up a course offering by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCoursePublic","name":"Returns a course offering from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courseOfferings~1{tenantId}~1public~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course offering from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a course offering by the specified ID and return it back."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course offering to return.","required":true}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1public~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1public~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseOfferings/{tenantId}/public/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseOfferings/{tenantId}/public/{id}","href":"course-offerings/getcoursepublic","openApiOperationId":"getCoursePublic","summary":"Returns a course offering from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course offering was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseOffering"}},"schemaId":"components/schemas/CourseOffering","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course offering could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course offering based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1public~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseOffering","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseOffering"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-offerings/getcoursepublic"}],"panels":[]}]},"httpPath":"/courseOfferings/{tenantId}/public/{id}"},{"label":"Searches for course offerings using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-offerings/searchforcourseofferings","routeSlug":"/apis/certifications/certifications-v1/course-offerings/searchforcourseofferings","metadata":{"seo":{"title":"Searches for course offerings using predefined parameters","description":"Searches for course offerings using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForCourseOfferings","name":"Searches for course offerings using predefined parameters","isWebhook":false,"pointer":"/paths/~1courseOfferings~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for course offerings using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for course offerings using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_366","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseOfferingSearchParameters"}},"schemaId":"components/schemas/CourseOfferingSearchParameters","pointer":"/paths/~1courseOfferings~1{tenantId}~1search/post/requestBody","description":"The course offering that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseOfferings/{tenantId}/search","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CourseOfferingSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseOfferings/{tenantId}/search","href":"course-offerings/searchforcourseofferings","openApiOperationId":"searchForCourseOfferings","summary":"Searches for course offerings using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CourseOfferingSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseOfferingSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course offering search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCourseOfferingSearchResults"}},"schemaId":"components/schemas/PagedCourseOfferingSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course offering you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course offering could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add course offering based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedCourseOfferingSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCourseOfferingSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-offerings/searchforcourseofferings"}],"panels":[]}]},"httpPath":"/courseOfferings/{tenantId}/search"},{"label":"Searches for course offerings using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-offerings/searchcourseofferingspublic","routeSlug":"/apis/certifications/certifications-v1/course-offerings/searchcourseofferingspublic","metadata":{"seo":{"title":"Searches for course offerings using predefined parameters","description":"Searches for course offerings using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchCourseOfferingsPublic","name":"Searches for course offerings using predefined parameters","isWebhook":false,"pointer":"/paths/~1courseOfferings~1{tenantId}~1search~1public/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for course offerings using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for course offerings using predefined parameters"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1search~1public/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_366","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1search~1public/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseOfferingSearchParameters"}},"schemaId":"components/schemas/CourseOfferingSearchParameters","pointer":"/paths/~1courseOfferings~1{tenantId}~1search~1public/post/requestBody","description":"The course offering that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseOfferings/{tenantId}/search/public","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CourseOfferingSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseOfferings/{tenantId}/search/public","href":"course-offerings/searchcourseofferingspublic","openApiOperationId":"searchCourseOfferingsPublic","summary":"Searches for course offerings using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CourseOfferingSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseOfferingSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course offering search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCourseOfferingSearchResults"}},"schemaId":"components/schemas/PagedCourseOfferingSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course offering you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course offering could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add course offering based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1search~1public/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedCourseOfferingSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCourseOfferingSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-offerings/searchcourseofferingspublic"}],"panels":[]}]},"httpPath":"/courseOfferings/{tenantId}/search/public"},{"label":"Returns a course offering from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-offerings/deletecourseoffering","routeSlug":"/apis/certifications/certifications-v1/course-offerings/deletecourseoffering","metadata":{"seo":{"title":"Returns a course offering from the system by its ID.","description":"This method will delete a course offering with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCourseOffering","name":"Returns a course offering from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courseOfferings~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course offering from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a course offering with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course offering to delete.","required":true}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/courseOfferings/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseOfferings/{tenantId}/{id}","href":"course-offerings/deletecourseoffering","openApiOperationId":"deleteCourseOffering","summary":"Returns a course offering from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course offering was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course offering could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course offering could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete course offering based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-offerings/deletecourseoffering"}],"panels":[]}]},"httpPath":"/courseOfferings/{tenantId}/{id}"},{"label":"Returns a course offering from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-offerings/getcourseoffering","routeSlug":"/apis/certifications/certifications-v1/course-offerings/getcourseoffering","metadata":{"seo":{"title":"Returns a course offering from the system by its ID.","description":"This method will look up a course offering by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCourseOffering","name":"Returns a course offering from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courseOfferings~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course offering from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a course offering by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course offering to return.","required":true}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseOfferings/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseOfferings/{tenantId}/{id}","href":"course-offerings/getcourseoffering","openApiOperationId":"getCourseOffering","summary":"Returns a course offering from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course offering was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseOffering"}},"schemaId":"components/schemas/CourseOffering","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course offering could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course offering based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseOffering","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseOffering"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-offerings/getcourseoffering"}],"panels":[]}]},"httpPath":"/courseOfferings/{tenantId}/{id}"},{"label":"Partially updates a course offering with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-offerings/patchcourseoffering","routeSlug":"/apis/certifications/certifications-v1/course-offerings/patchcourseoffering","metadata":{"seo":{"title":"Partially updates a course offering with the specified ID.","description":"This method will patch an existing course offering with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCourseOffering","name":"Partially updates a course offering with the specified ID.","isWebhook":false,"pointer":"/paths/~1courseOfferings~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a course offering with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing course offering with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course offering to patch.","required":true}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1courseOfferings~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/courseOfferings/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseOfferings/{tenantId}/{id}","href":"course-offerings/patchcourseoffering","openApiOperationId":"patchCourseOffering","summary":"Partially updates a course offering with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course offering was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseOffering"}},"schemaId":"components/schemas/CourseOffering","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course offering could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course offering could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course offering based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseOffering","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseOffering"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-offerings/patchcourseoffering"}],"panels":[]}]},"httpPath":"/courseOfferings/{tenantId}/{id}"},{"label":"Updates a course offering with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-offerings/updatecourseoffering","routeSlug":"/apis/certifications/certifications-v1/course-offerings/updatecourseoffering","metadata":{"seo":{"title":"Updates a course offering with the specified ID.","description":"This method will update an existing course offering with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCourseOffering","name":"Updates a course offering with the specified ID.","isWebhook":false,"pointer":"/paths/~1courseOfferings~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a course offering with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing course offering with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course offering to update.","required":true}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseOffering"}},"schemaId":"components/schemas/CourseOffering","pointer":"/paths/~1courseOfferings~1{tenantId}~1{id}/put/requestBody","description":"The updated course offering that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/courseOfferings/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CourseOffering"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseOfferings/{tenantId}/{id}","href":"course-offerings/updatecourseoffering","openApiOperationId":"updateCourseOffering","summary":"Updates a course offering with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CourseOffering","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseOffering"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course offering was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseOffering"}},"schemaId":"components/schemas/CourseOffering","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course offering supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course offering could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course offering could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course offering based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseOfferings~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseOffering","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseOffering"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-offerings/updatecourseoffering"}],"panels":[]}]},"httpPath":"/courseOfferings/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Course Offerings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Course Offerings","showPageActions":true},{"nodeType":"markdoc","content":"Course Offerings"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/courseOfferings/{tenantId}","summary":"Creates a new course offering record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-offerings/createcourseoffering","deprecated":false},{"title":"/courseOfferings/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-offerings/executebatchoperations","deprecated":false},{"title":"/courseOfferings/{tenantId}/course/{course_id}","summary":"Returns a list of records with the specified course_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-offerings/listofferingsbycourseid","deprecated":false},{"title":"/courseOfferings/{tenantId}/event/{event_id}","summary":"Returns a list of records with the specified event_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-offerings/listofferingsbyeventid","deprecated":false},{"title":"/courseOfferings/{tenantId}/event/{event_id}/public","summary":"Returns a list of records with the specified event_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-offerings/listofferingsbyeventidpublic","deprecated":false},{"title":"/courseOfferings/{tenantId}/instructor/{instructor_id}","summary":"Returns a list of records with the specified instructor_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-offerings/listofferingsbyinstructorid","deprecated":false},{"title":"/courseOfferings/{tenantId}/portal/{contact_id}/describeForCourse/{course_id}","summary":"Returns a list of records with the specified course_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-offerings/describeofferings","deprecated":false},{"title":"/courseOfferings/{tenantId}/public/{id}","summary":"Returns a course offering from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-offerings/getcoursepublic","deprecated":false},{"title":"/courseOfferings/{tenantId}/search","summary":"Searches for course offerings using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-offerings/searchforcourseofferings","deprecated":false},{"title":"/courseOfferings/{tenantId}/search/public","summary":"Searches for course offerings using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-offerings/searchcourseofferingspublic","deprecated":false},{"title":"/courseOfferings/{tenantId}/{id}","summary":"Returns a course offering from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/course-offerings/deletecourseoffering","deprecated":false},{"title":"/courseOfferings/{tenantId}/{id}","summary":"Returns a course offering from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-offerings/getcourseoffering","deprecated":false},{"title":"/courseOfferings/{tenantId}/{id}","summary":"Partially updates a course offering with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/course-offerings/patchcourseoffering","deprecated":false},{"title":"/courseOfferings/{tenantId}/{id}","summary":"Updates a course offering with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/course-offerings/updatecourseoffering","deprecated":false}]}]}]}]}},{"type":"group","label":"Course Reg Processes","link":"/apis/certifications/certifications-v1/course-reg-processes","routeSlug":"/apis/certifications/certifications-v1/course-reg-processes","items":[{"label":"Gets all of the course reg processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-reg-processes/listcourseregprocesses","routeSlug":"/apis/certifications/certifications-v1/course-reg-processes/listcourseregprocesses","metadata":{"seo":{"title":"Gets all of the course reg processes in the system.","description":"This method will scan all course reg processes and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCourseRegProcesses","name":"Gets all of the course reg processes in the system.","isWebhook":false,"pointer":"/paths/~1courseRegProcesses~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the course reg processes in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all course reg processes and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseRegProcesses/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegProcesses/{tenantId}","href":"course-reg-processes/listcourseregprocesses","openApiOperationId":"listCourseRegProcesses","summary":"Gets all of the course reg processes in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course reg processeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}},"schemaId":"schema_385","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_385","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-reg-processes/listcourseregprocesses"}],"panels":[]}]},"httpPath":"/courseRegProcesses/{tenantId}"},{"label":"Creates a new course reg process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-reg-processes/createcourseregprocess","routeSlug":"/apis/certifications/certifications-v1/course-reg-processes/createcourseregprocess","metadata":{"seo":{"title":"Creates a new course reg process record that does not already exist.","description":"This method will auto-generate an ID and create a new course reg process. If an ID is specified for the course reg process, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCourseRegProcess","name":"Creates a new course reg process record that does not already exist.","isWebhook":false,"pointer":"/paths/~1courseRegProcesses~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new course reg process record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new course reg process. If an ID is specified for the course reg process, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseRegProcess"}},"schemaId":"components/schemas/CourseRegProcess","pointer":"/paths/~1courseRegProcesses~1{tenantId}/post/requestBody","description":"The course reg process that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseRegProcesses/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CourseRegProcess"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseRegProcesses/{tenantId}","href":"course-reg-processes/createcourseregprocess","openApiOperationId":"createCourseRegProcess","summary":"Creates a new course reg process record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CourseRegProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseRegProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course reg process was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegProcess"}},"schemaId":"components/schemas/CourseRegProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course reg process you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course reg process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add course reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseRegProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-reg-processes/createcourseregprocess"}],"panels":[]}]},"httpPath":"/courseRegProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-reg-processes/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/course-reg-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1courseRegProcesses~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseRegProcesses/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegProcesses/{tenantId}/batch","href":"course-reg-processes/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course reg process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-reg-processes/executebatchoperations"}],"panels":[]}]},"httpPath":"/courseRegProcesses/{tenantId}/batch"},{"label":"Gets all of the processes a contact is eligible to use","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-reg-processes/geteligibleprocesses","routeSlug":"/apis/certifications/certifications-v1/course-reg-processes/geteligibleprocesses","metadata":{"seo":{"title":"Gets all of the processes a contact is eligible to use","description":"Gets all of the processes a contact is eligible to use"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEligibleProcesses","name":"Gets all of the processes a contact is eligible to use","isWebhook":false,"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1eligible~1{contactId}~1{courseId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the processes a contact is eligible to use","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The contact id","required":true},{"name":"courseId","in":"path","schemaId":"schema_366","description":"The course id","required":true}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1eligible~1{contactId}~1{courseId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseRegProcesses/{tenantId}/eligible/{contactId}/{courseId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"},{"name":"courseId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegProcesses/{tenantId}/eligible/{contactId}/{courseId}","href":"course-reg-processes/geteligibleprocesses","openApiOperationId":"getEligibleProcesses","summary":"Gets all of the processes a contact is eligible to use"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Processes were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}},"schemaId":"schema_385","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1eligible~1{contactId}~1{courseId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_385","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-reg-processes/geteligibleprocesses"}],"panels":[]}]},"httpPath":"/courseRegProcesses/{tenantId}/eligible/{contactId}/{courseId}"},{"label":"Returns a course reg process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-reg-processes/deletecourseregprocess","routeSlug":"/apis/certifications/certifications-v1/course-reg-processes/deletecourseregprocess","metadata":{"seo":{"title":"Returns a course reg process from the system by its ID.","description":"This method will delete a course reg process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCourseRegProcess","name":"Returns a course reg process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course reg process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a course reg process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course reg process to delete.","required":true}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/courseRegProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseRegProcesses/{tenantId}/{id}","href":"course-reg-processes/deletecourseregprocess","openApiOperationId":"deleteCourseRegProcess","summary":"Returns a course reg process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course reg process was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course reg process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course reg process could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete course reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-reg-processes/deletecourseregprocess"}],"panels":[]}]},"httpPath":"/courseRegProcesses/{tenantId}/{id}"},{"label":"Returns a course reg process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-reg-processes/getcourseregprocess","routeSlug":"/apis/certifications/certifications-v1/course-reg-processes/getcourseregprocess","metadata":{"seo":{"title":"Returns a course reg process from the system by its ID.","description":"This method will look up a course reg process by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCourseRegProcess","name":"Returns a course reg process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course reg process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a course reg process by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course reg process to return.","required":true}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseRegProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegProcesses/{tenantId}/{id}","href":"course-reg-processes/getcourseregprocess","openApiOperationId":"getCourseRegProcess","summary":"Returns a course reg process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course reg process was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegProcess"}},"schemaId":"components/schemas/CourseRegProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course reg process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseRegProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-reg-processes/getcourseregprocess"}],"panels":[]}]},"httpPath":"/courseRegProcesses/{tenantId}/{id}"},{"label":"Partially updates a course reg process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-reg-processes/patchcourseregprocess","routeSlug":"/apis/certifications/certifications-v1/course-reg-processes/patchcourseregprocess","metadata":{"seo":{"title":"Partially updates a course reg process with the specified ID.","description":"This method will patch an existing course reg process with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCourseRegProcess","name":"Partially updates a course reg process with the specified ID.","isWebhook":false,"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a course reg process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing course reg process with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course reg process to patch.","required":true}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1courseRegProcesses~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/courseRegProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseRegProcesses/{tenantId}/{id}","href":"course-reg-processes/patchcourseregprocess","openApiOperationId":"patchCourseRegProcess","summary":"Partially updates a course reg process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course reg process was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegProcess"}},"schemaId":"components/schemas/CourseRegProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course reg process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course reg process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseRegProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-reg-processes/patchcourseregprocess"}],"panels":[]}]},"httpPath":"/courseRegProcesses/{tenantId}/{id}"},{"label":"Updates a course reg process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-reg-processes/updatecourseregprocess","routeSlug":"/apis/certifications/certifications-v1/course-reg-processes/updatecourseregprocess","metadata":{"seo":{"title":"Updates a course reg process with the specified ID.","description":"This method will update an existing course reg process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCourseRegProcess","name":"Updates a course reg process with the specified ID.","isWebhook":false,"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a course reg process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing course reg process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course reg process to update.","required":true}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseRegProcess"}},"schemaId":"components/schemas/CourseRegProcess","pointer":"/paths/~1courseRegProcesses~1{tenantId}~1{id}/put/requestBody","description":"The updated course reg process that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/courseRegProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CourseRegProcess"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseRegProcesses/{tenantId}/{id}","href":"course-reg-processes/updatecourseregprocess","openApiOperationId":"updateCourseRegProcess","summary":"Updates a course reg process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CourseRegProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseRegProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course reg process was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegProcess"}},"schemaId":"components/schemas/CourseRegProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course reg process supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course reg process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course reg process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegProcesses~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseRegProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-reg-processes/updatecourseregprocess"}],"panels":[]}]},"httpPath":"/courseRegProcesses/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Course Reg Processes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Course Reg Processes","showPageActions":true},{"nodeType":"markdoc","content":"Course Reg Processes"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/courseRegProcesses/{tenantId}","summary":"Gets all of the course reg processes in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-reg-processes/listcourseregprocesses","deprecated":false},{"title":"/courseRegProcesses/{tenantId}","summary":"Creates a new course reg process record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-reg-processes/createcourseregprocess","deprecated":false},{"title":"/courseRegProcesses/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-reg-processes/executebatchoperations","deprecated":false},{"title":"/courseRegProcesses/{tenantId}/eligible/{contactId}/{courseId}","summary":"Gets all of the processes a contact is eligible to use","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-reg-processes/geteligibleprocesses","deprecated":false},{"title":"/courseRegProcesses/{tenantId}/{id}","summary":"Returns a course reg process from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/course-reg-processes/deletecourseregprocess","deprecated":false},{"title":"/courseRegProcesses/{tenantId}/{id}","summary":"Returns a course reg process from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-reg-processes/getcourseregprocess","deprecated":false},{"title":"/courseRegProcesses/{tenantId}/{id}","summary":"Partially updates a course reg process with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/course-reg-processes/patchcourseregprocess","deprecated":false},{"title":"/courseRegProcesses/{tenantId}/{id}","summary":"Updates a course reg process with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/course-reg-processes/updatecourseregprocess","deprecated":false}]}]}]}]}},{"type":"group","label":"Course Registrations","link":"/apis/certifications/certifications-v1/course-registrations","routeSlug":"/apis/certifications/certifications-v1/course-registrations","items":[{"label":"Gets all of the course registrations in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/listcourseregistrations","routeSlug":"/apis/certifications/certifications-v1/course-registrations/listcourseregistrations","metadata":{"seo":{"title":"Gets all of the course registrations in the system.","description":"This method will scan all course registrations and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCourseRegistrations","name":"Gets all of the course registrations in the system.","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the course registrations in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all course registrations and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseRegistrations/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegistrations/{tenantId}","href":"course-registrations/listcourseregistrations","openApiOperationId":"listCourseRegistrations","summary":"Gets all of the course registrations in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course registrationswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_386"}},"schemaId":"schema_386","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_386","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_386"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/listcourseregistrations"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}"},{"label":"Creates a new course registration record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/createcourseregistration","routeSlug":"/apis/certifications/certifications-v1/course-registrations/createcourseregistration","metadata":{"seo":{"title":"Creates a new course registration record that does not already exist.","description":"This method will auto-generate an ID and create a new course registration. If an ID is specified for the course registration, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCourseRegistration","name":"Creates a new course registration record that does not already exist.","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new course registration record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new course registration. If an ID is specified for the course registration, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}},"schemaId":"components/schemas/CourseRegistration","pointer":"/paths/~1courseRegistrations~1{tenantId}/post/requestBody","description":"The course registration that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseRegistrations/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseRegistrations/{tenantId}","href":"course-registrations/createcourseregistration","openApiOperationId":"createCourseRegistration","summary":"Creates a new course registration record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CourseRegistration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course registration was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}},"schemaId":"components/schemas/CourseRegistration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course registration you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course registration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add course registration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseRegistration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/createcourseregistration"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}"},{"label":"Returns a list of records with the specified application_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/listregistrationsbyapplicationid","routeSlug":"/apis/certifications/certifications-v1/course-registrations/listregistrationsbyapplicationid","metadata":{"seo":{"title":"Returns a list of records with the specified application_id","description":"Returns a list of records with the specified application_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRegistrationsByApplicationId","name":"Returns a list of records with the specified application_id","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1application~1{application_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified application_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified application_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"application_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The application_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1application~1{application_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1application~1{application_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseRegistrations/{tenantId}/application/{application_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegistrations/{tenantId}/application/{application_id}","href":"course-registrations/listregistrationsbyapplicationid","openApiOperationId":"listRegistrationsByApplicationId","summary":"Returns a list of records with the specified application_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseRegistrationsResponse"}},"schemaId":"components/schemas/ListCourseRegistrationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1application~1{application_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCourseRegistrationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseRegistrationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/listregistrationsbyapplicationid"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/application/{application_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/course-registrations/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1courseRegistrations~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseRegistrations/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegistrations/{tenantId}/batch","href":"course-registrations/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course registration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course registration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/executebatchoperations"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/batch"},{"label":"Returns a list of records with the specified course_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/listregistrationsbycourseid","routeSlug":"/apis/certifications/certifications-v1/course-registrations/listregistrationsbycourseid","metadata":{"seo":{"title":"Returns a list of records with the specified course_id","description":"Returns a list of records with the specified course_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRegistrationsByCourseId","name":"Returns a list of records with the specified course_id","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1course~1{course_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified course_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified course_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"course_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The course_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1course~1{course_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1course~1{course_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseRegistrations/{tenantId}/course/{course_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"course_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegistrations/{tenantId}/course/{course_id}","href":"course-registrations/listregistrationsbycourseid","openApiOperationId":"listRegistrationsByCourseId","summary":"Returns a list of records with the specified course_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseRegistrationsResponse"}},"schemaId":"components/schemas/ListCourseRegistrationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1course~1{course_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCourseRegistrationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseRegistrationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/listregistrationsbycourseid"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/course/{course_id}"},{"label":"Returns a list of records with the specified course_offering_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/listregistrationsbycourseofferingid","routeSlug":"/apis/certifications/certifications-v1/course-registrations/listregistrationsbycourseofferingid","metadata":{"seo":{"title":"Returns a list of records with the specified course_offering_id","description":"Returns a list of records with the specified course_offering_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRegistrationsByCourseOfferingId","name":"Returns a list of records with the specified course_offering_id","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1courseOffering~1{course_offering_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified course_offering_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified course_offering_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"course_offering_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The course_offering_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1courseOffering~1{course_offering_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeActiveOnly","in":"query","schemaId":"schema_383","description":"If true, only active/attended registrations"},{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1courseOffering~1{course_offering_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseRegistrations/{tenantId}/courseOffering/{course_offering_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"course_offering_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"includeActiveOnly","in":"query","required":false,"schemaId":"schema_383"},{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegistrations/{tenantId}/courseOffering/{course_offering_id}","href":"course-registrations/listregistrationsbycourseofferingid","openApiOperationId":"listRegistrationsByCourseOfferingId","summary":"Returns a list of records with the specified course_offering_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseRegistrationsResponse"}},"schemaId":"components/schemas/ListCourseRegistrationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1courseOffering~1{course_offering_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCourseRegistrationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseRegistrationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/listregistrationsbycourseofferingid"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/courseOffering/{course_offering_id}"},{"label":"Returns a list of records with the specified event_registration_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/listregistrationsbyeventregistrationid","routeSlug":"/apis/certifications/certifications-v1/course-registrations/listregistrationsbyeventregistrationid","metadata":{"seo":{"title":"Returns a list of records with the specified event_registration_id","description":"Returns a list of records with the specified event_registration_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRegistrationsByEventRegistrationId","name":"Returns a list of records with the specified event_registration_id","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1eventRegistration~1{event_registration_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified event_registration_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified event_registration_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"event_registration_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event_registration_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1eventRegistration~1{event_registration_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1eventRegistration~1{event_registration_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseRegistrations/{tenantId}/eventRegistration/{event_registration_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"event_registration_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegistrations/{tenantId}/eventRegistration/{event_registration_id}","href":"course-registrations/listregistrationsbyeventregistrationid","openApiOperationId":"listRegistrationsByEventRegistrationId","summary":"Returns a list of records with the specified event_registration_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseRegistrationsResponse"}},"schemaId":"components/schemas/ListCourseRegistrationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1eventRegistration~1{event_registration_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCourseRegistrationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseRegistrationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/listregistrationsbyeventregistrationid"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/eventRegistration/{event_registration_id}"},{"label":"Generates an order from a membership registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/generateorder","routeSlug":"/apis/certifications/certifications-v1/course-registrations/generateorder","metadata":{"seo":{"title":"Generates an order from a membership registration","description":"This method will courseine a cert course reg and generate an appropriate order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateOrder","name":"Generates an order from a membership registration","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1generateOrder/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates an order from a membership registration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will courseine a cert course reg and generate an appropriate order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1generateOrder/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}},"schemaId":"components/schemas/CourseRegistration","pointer":"/paths/~1courseRegistrations~1{tenantId}~1generateOrder/post/requestBody","description":"The registration to generate an order"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseRegistrations/{tenantId}/generateOrder","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegistrations/{tenantId}/generateOrder","href":"course-registrations/generateorder","openApiOperationId":"generateOrder","summary":"Generates an order from a membership registration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CourseRegistration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1generateOrder/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/generateorder"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/generateOrder"},{"label":"Generates an registration for a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/generateregistration","routeSlug":"/apis/certifications/certifications-v1/course-registrations/generateregistration","metadata":{"seo":{"title":"Generates an registration for a contact","description":"Generates an registration for a contact"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateRegistration","name":"Generates an registration for a contact","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1generateRegistration~1{processId}~1{contactId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates an registration for a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true},{"name":"processId","in":"path","schemaId":"schema_366","description":"The process id","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The contact contact","required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1generateRegistration~1{processId}~1{contactId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseRegistrations/{tenantId}/generateRegistration/{processId}/{contactId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"processId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegistrations/{tenantId}/generateRegistration/{processId}/{contactId}","href":"course-registrations/generateregistration","openApiOperationId":"generateRegistration","summary":"Generates an registration for a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}},"schemaId":"components/schemas/CourseRegistration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1generateRegistration~1{processId}~1{contactId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseRegistration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/generateregistration"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/generateRegistration/{processId}/{contactId}"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/listregistrationsbyorderid","routeSlug":"/apis/certifications/certifications-v1/course-registrations/listregistrationsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRegistrationsByOrderId","name":"Returns a list of records with the specified order_id","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1order~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified order_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified order_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"order_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1order~1{order_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1order~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseRegistrations/{tenantId}/order/{order_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegistrations/{tenantId}/order/{order_id}","href":"course-registrations/listregistrationsbyorderid","openApiOperationId":"listRegistrationsByOrderId","summary":"Returns a list of records with the specified order_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseRegistrationsResponse"}},"schemaId":"components/schemas/ListCourseRegistrationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1order~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCourseRegistrationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseRegistrationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/listregistrationsbyorderid"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/order/{order_id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/previewemail","routeSlug":"/apis/certifications/certifications-v1/course-registrations/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewEmail","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1previewEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the CRC notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the CRC notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1previewEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"schemaId":"components/schemas/PreviewEmailRequest","pointer":"/paths/~1courseRegistrations~1{tenantId}~1previewEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseRegistrations/{tenantId}/previewEmail","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegistrations/{tenantId}/previewEmail","href":"course-registrations/previewemail","openApiOperationId":"previewEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1previewEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/previewemail"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/previewEmail"},{"label":"Searches for course registrations using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/searchforcourseregistrations","routeSlug":"/apis/certifications/certifications-v1/course-registrations/searchforcourseregistrations","metadata":{"seo":{"title":"Searches for course registrations using predefined parameters","description":"Searches for course registrations using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForCourseRegistrations","name":"Searches for course registrations using predefined parameters","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for course registrations using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for course registrations using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_366","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseRegistrationSearchParameters"}},"schemaId":"components/schemas/CourseRegistrationSearchParameters","pointer":"/paths/~1courseRegistrations~1{tenantId}~1search/post/requestBody","description":"The course registration that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseRegistrations/{tenantId}/search","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CourseRegistrationSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseRegistrations/{tenantId}/search","href":"course-registrations/searchforcourseregistrations","openApiOperationId":"searchForCourseRegistrations","summary":"Searches for course registrations using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CourseRegistrationSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseRegistrationSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course registration search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCourseRegistrationSearchResults"}},"schemaId":"components/schemas/PagedCourseRegistrationSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course registration you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course registration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add course registration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedCourseRegistrationSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCourseRegistrationSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/searchforcourseregistrations"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/search"},{"label":"Returns a list of records with the specified student_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/listregistrationsbystudentid","routeSlug":"/apis/certifications/certifications-v1/course-registrations/listregistrationsbystudentid","metadata":{"seo":{"title":"Returns a list of records with the specified student_id","description":"Returns a list of records with the specified student_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRegistrationsByStudentId","name":"Returns a list of records with the specified student_id","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1student~1{student_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified student_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified student_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"student_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The student_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1student~1{student_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1student~1{student_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseRegistrations/{tenantId}/student/{student_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"student_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegistrations/{tenantId}/student/{student_id}","href":"course-registrations/listregistrationsbystudentid","openApiOperationId":"listRegistrationsByStudentId","summary":"Returns a list of records with the specified student_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseRegistrationsResponse"}},"schemaId":"components/schemas/ListCourseRegistrationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1student~1{student_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCourseRegistrationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseRegistrationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/listregistrationsbystudentid"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/student/{student_id}"},{"label":"Returns a list of records with the specified student_course_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/listregistrationsbystudentidandcourseid","routeSlug":"/apis/certifications/certifications-v1/course-registrations/listregistrationsbystudentidandcourseid","metadata":{"seo":{"title":"Returns a list of records with the specified student_course_id","description":"Returns a list of records with the specified student_course_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRegistrationsByStudentIdAndCourseId","name":"Returns a list of records with the specified student_course_id","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1studentCourse~1{student_id}~1{course_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified student_course_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified student_course_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"student_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The student_course_id to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"course_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The student_course_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1studentCourse~1{student_id}~1{course_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1studentCourse~1{student_id}~1{course_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseRegistrations/{tenantId}/studentCourse/{student_id}/{course_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"student_id","in":"path","required":true,"schemaId":"schema_366"},{"name":"course_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegistrations/{tenantId}/studentCourse/{student_id}/{course_id}","href":"course-registrations/listregistrationsbystudentidandcourseid","openApiOperationId":"listRegistrationsByStudentIdAndCourseId","summary":"Returns a list of records with the specified student_course_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseRegistrationsResponse"}},"schemaId":"components/schemas/ListCourseRegistrationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1studentCourse~1{student_id}~1{course_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCourseRegistrationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCourseRegistrationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/listregistrationsbystudentidandcourseid"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/studentCourse/{student_id}/{course_id}"},{"label":"Transfer a course registration to new student/offering","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/transferregistration","routeSlug":"/apis/certifications/certifications-v1/course-registrations/transferregistration","metadata":{"seo":{"title":"Transfer a course registration to new student/offering","description":"This method will courseine a cert course reg and generate an appropriate order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"transferRegistration","name":"Transfer a course registration to new student/offering","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1transferRegistration~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer a course registration to new student/offering","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will courseine a cert course reg and generate an appropriate order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The id of the registration","required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1transferRegistration~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransferRegistrationRequest"}},"schemaId":"components/schemas/TransferRegistrationRequest","pointer":"/paths/~1courseRegistrations~1{tenantId}~1transferRegistration~1{id}/post/requestBody","description":"The registration to generate an order"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseRegistrations/{tenantId}/transferRegistration/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransferRegistrationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegistrations/{tenantId}/transferRegistration/{id}","href":"course-registrations/transferregistration","openApiOperationId":"transferRegistration","summary":"Transfer a course registration to new student/offering"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/TransferRegistrationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransferRegistrationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1transferRegistration~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/transferregistration"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/transferRegistration/{id}"},{"label":"Returns a course registration from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/deletecourseregistration","routeSlug":"/apis/certifications/certifications-v1/course-registrations/deletecourseregistration","metadata":{"seo":{"title":"Returns a course registration from the system by its ID.","description":"This method will delete a course registration with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCourseRegistration","name":"Returns a course registration from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course registration from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a course registration with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course registration to delete.","required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/courseRegistrations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseRegistrations/{tenantId}/{id}","href":"course-registrations/deletecourseregistration","openApiOperationId":"deleteCourseRegistration","summary":"Returns a course registration from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course registration was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course registration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course registration could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete course registration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/deletecourseregistration"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/{id}"},{"label":"Returns a course registration from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/getcourseregistration","routeSlug":"/apis/certifications/certifications-v1/course-registrations/getcourseregistration","metadata":{"seo":{"title":"Returns a course registration from the system by its ID.","description":"This method will look up a course registration by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCourseRegistration","name":"Returns a course registration from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course registration from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a course registration by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course registration to return.","required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseRegistrations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseRegistrations/{tenantId}/{id}","href":"course-registrations/getcourseregistration","openApiOperationId":"getCourseRegistration","summary":"Returns a course registration from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course registration was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}},"schemaId":"components/schemas/CourseRegistration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course registration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course registration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseRegistration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/getcourseregistration"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/{id}"},{"label":"Partially updates a course registration with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/patchcourseregistration","routeSlug":"/apis/certifications/certifications-v1/course-registrations/patchcourseregistration","metadata":{"seo":{"title":"Partially updates a course registration with the specified ID.","description":"This method will patch an existing course registration with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCourseRegistration","name":"Partially updates a course registration with the specified ID.","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a course registration with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing course registration with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course registration to patch.","required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1courseRegistrations~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/courseRegistrations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseRegistrations/{tenantId}/{id}","href":"course-registrations/patchcourseregistration","openApiOperationId":"patchCourseRegistration","summary":"Partially updates a course registration with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course registration was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}},"schemaId":"components/schemas/CourseRegistration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course registration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course registration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course registration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseRegistration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/patchcourseregistration"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/{id}"},{"label":"Updates a course registration with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-registrations/updatecourseregistration","routeSlug":"/apis/certifications/certifications-v1/course-registrations/updatecourseregistration","metadata":{"seo":{"title":"Updates a course registration with the specified ID.","description":"This method will update an existing course registration with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCourseRegistration","name":"Updates a course registration with the specified ID.","isWebhook":false,"pointer":"/paths/~1courseRegistrations~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a course registration with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing course registration with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course registration to update.","required":true}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}},"schemaId":"components/schemas/CourseRegistration","pointer":"/paths/~1courseRegistrations~1{tenantId}~1{id}/put/requestBody","description":"The updated course registration that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/courseRegistrations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/courseRegistrations/{tenantId}/{id}","href":"course-registrations/updatecourseregistration","openApiOperationId":"updateCourseRegistration","summary":"Updates a course registration with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CourseRegistration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course registration was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}},"schemaId":"components/schemas/CourseRegistration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course registration supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course registration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course registration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course registration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseRegistrations~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseRegistration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseRegistration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-registrations/updatecourseregistration"}],"panels":[]}]},"httpPath":"/courseRegistrations/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Course Registrations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Course Registrations","showPageActions":true},{"nodeType":"markdoc","content":"Course Registrations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/courseRegistrations/{tenantId}","summary":"Gets all of the course registrations in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-registrations/listcourseregistrations","deprecated":false},{"title":"/courseRegistrations/{tenantId}","summary":"Creates a new course registration record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-registrations/createcourseregistration","deprecated":false},{"title":"/courseRegistrations/{tenantId}/application/{application_id}","summary":"Returns a list of records with the specified application_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-registrations/listregistrationsbyapplicationid","deprecated":false},{"title":"/courseRegistrations/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-registrations/executebatchoperations","deprecated":false},{"title":"/courseRegistrations/{tenantId}/course/{course_id}","summary":"Returns a list of records with the specified course_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-registrations/listregistrationsbycourseid","deprecated":false},{"title":"/courseRegistrations/{tenantId}/courseOffering/{course_offering_id}","summary":"Returns a list of records with the specified course_offering_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-registrations/listregistrationsbycourseofferingid","deprecated":false},{"title":"/courseRegistrations/{tenantId}/eventRegistration/{event_registration_id}","summary":"Returns a list of records with the specified event_registration_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-registrations/listregistrationsbyeventregistrationid","deprecated":false},{"title":"/courseRegistrations/{tenantId}/generateOrder","summary":"Generates an order from a membership registration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-registrations/generateorder","deprecated":false},{"title":"/courseRegistrations/{tenantId}/generateRegistration/{processId}/{contactId}","summary":"Generates an registration for a contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-registrations/generateregistration","deprecated":false},{"title":"/courseRegistrations/{tenantId}/order/{order_id}","summary":"Returns a list of records with the specified order_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-registrations/listregistrationsbyorderid","deprecated":false},{"title":"/courseRegistrations/{tenantId}/previewEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-registrations/previewemail","deprecated":false},{"title":"/courseRegistrations/{tenantId}/search","summary":"Searches for course registrations using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-registrations/searchforcourseregistrations","deprecated":false},{"title":"/courseRegistrations/{tenantId}/student/{student_id}","summary":"Returns a list of records with the specified student_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-registrations/listregistrationsbystudentid","deprecated":false},{"title":"/courseRegistrations/{tenantId}/studentCourse/{student_id}/{course_id}","summary":"Returns a list of records with the specified student_course_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-registrations/listregistrationsbystudentidandcourseid","deprecated":false},{"title":"/courseRegistrations/{tenantId}/transferRegistration/{id}","summary":"Transfer a course registration to new student/offering","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-registrations/transferregistration","deprecated":false},{"title":"/courseRegistrations/{tenantId}/{id}","summary":"Returns a course registration from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/course-registrations/deletecourseregistration","deprecated":false},{"title":"/courseRegistrations/{tenantId}/{id}","summary":"Returns a course registration from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-registrations/getcourseregistration","deprecated":false},{"title":"/courseRegistrations/{tenantId}/{id}","summary":"Partially updates a course registration with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/course-registrations/patchcourseregistration","deprecated":false},{"title":"/courseRegistrations/{tenantId}/{id}","summary":"Updates a course registration with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/course-registrations/updatecourseregistration","deprecated":false}]}]}]}]}},{"type":"group","label":"Course Types","link":"/apis/certifications/certifications-v1/course-types","routeSlug":"/apis/certifications/certifications-v1/course-types","items":[{"label":"Gets all of the course types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-types/listcoursetypes","routeSlug":"/apis/certifications/certifications-v1/course-types/listcoursetypes","metadata":{"seo":{"title":"Gets all of the course types in the system.","description":"This method will scan all course types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCourseTypes","name":"Gets all of the course types in the system.","isWebhook":false,"pointer":"/paths/~1courseTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the course types in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all course types and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1courseTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseTypes/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseTypes/{tenantId}","href":"course-types/listcoursetypes","openApiOperationId":"listCourseTypes","summary":"Gets all of the course types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_387","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_387","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_387"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-types/listcoursetypes"}],"panels":[]}]},"httpPath":"/courseTypes/{tenantId}"},{"label":"Creates a new course type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-types/createcoursetype","routeSlug":"/apis/certifications/certifications-v1/course-types/createcoursetype","metadata":{"seo":{"title":"Creates a new course type record that does not already exist.","description":"This method will auto-generate an ID and create a new course type. If an ID is specified for the course type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCourseType","name":"Creates a new course type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1courseTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new course type record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new course type. If an ID is specified for the course type, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseTypes~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseType"}},"schemaId":"components/schemas/CourseType","pointer":"/paths/~1courseTypes~1{tenantId}/post/requestBody","description":"The course type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseTypes/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CourseType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/courseTypes/{tenantId}","href":"course-types/createcoursetype","openApiOperationId":"createCourseType","summary":"Creates a new course type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CourseType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseType"}},"schemaId":"components/schemas/CourseType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course type you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add course type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-types/createcoursetype"}],"panels":[]}]},"httpPath":"/courseTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-types/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/course-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1courseTypes~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseTypes~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1courseTypes~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courseTypes/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseTypes/{tenantId}/batch","href":"course-types/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseTypes~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-types/executebatchoperations"}],"panels":[]}]},"httpPath":"/courseTypes/{tenantId}/batch"},{"label":"Gets all of the course types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-types/listcoursetypespublic","routeSlug":"/apis/certifications/certifications-v1/course-types/listcoursetypespublic","metadata":{"seo":{"title":"Gets all of the course types in the system.","description":"This method will scan all course types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCourseTypesPublic","name":"Gets all of the course types in the system.","isWebhook":false,"pointer":"/paths/~1courseTypes~1{tenantId}~1public/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the course types in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all course types and and return them to the caller."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courseTypes~1{tenantId}~1public/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1courseTypes~1{tenantId}~1public/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseTypes/{tenantId}/public","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseTypes/{tenantId}/public","href":"course-types/listcoursetypespublic","openApiOperationId":"listCourseTypesPublic","summary":"Gets all of the course types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_387","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseTypes~1{tenantId}~1public/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_387","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_387"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-types/listcoursetypespublic"}],"panels":[]}]},"httpPath":"/courseTypes/{tenantId}/public"},{"label":"Returns a course type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-types/getcoursetypepublic","routeSlug":"/apis/certifications/certifications-v1/course-types/getcoursetypepublic","metadata":{"seo":{"title":"Returns a course type from the system by its ID.","description":"This method will look up a course type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCourseTypePublic","name":"Returns a course type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courseTypes~1{tenantId}~1public~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a course type by the specified ID and return it back."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course type to return.","required":true}],"pointer":"/paths/~1courseTypes~1{tenantId}~1public~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1courseTypes~1{tenantId}~1public~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseTypes/{tenantId}/public/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseTypes/{tenantId}/public/{id}","href":"course-types/getcoursetypepublic","openApiOperationId":"getCourseTypePublic","summary":"Returns a course type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseType"}},"schemaId":"components/schemas/CourseType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseTypes~1{tenantId}~1public~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-types/getcoursetypepublic"}],"panels":[]}]},"httpPath":"/courseTypes/{tenantId}/public/{id}"},{"label":"Returns a course type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-types/deletecoursetype","routeSlug":"/apis/certifications/certifications-v1/course-types/deletecoursetype","metadata":{"seo":{"title":"Returns a course type from the system by its ID.","description":"This method will delete a course type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCourseType","name":"Returns a course type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courseTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a course type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course type to delete.","required":true}],"pointer":"/paths/~1courseTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/courseTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/courseTypes/{tenantId}/{id}","href":"course-types/deletecoursetype","openApiOperationId":"deleteCourseType","summary":"Returns a course type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course type could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete course type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-types/deletecoursetype"}],"panels":[]}]},"httpPath":"/courseTypes/{tenantId}/{id}"},{"label":"Returns a course type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-types/getcoursetype","routeSlug":"/apis/certifications/certifications-v1/course-types/getcoursetype","metadata":{"seo":{"title":"Returns a course type from the system by its ID.","description":"This method will look up a course type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCourseType","name":"Returns a course type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courseTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a course type by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course type to return.","required":true}],"pointer":"/paths/~1courseTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1courseTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courseTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courseTypes/{tenantId}/{id}","href":"course-types/getcoursetype","openApiOperationId":"getCourseType","summary":"Returns a course type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseType"}},"schemaId":"components/schemas/CourseType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-types/getcoursetype"}],"panels":[]}]},"httpPath":"/courseTypes/{tenantId}/{id}"},{"label":"Partially updates a course type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-types/patchcoursetype","routeSlug":"/apis/certifications/certifications-v1/course-types/patchcoursetype","metadata":{"seo":{"title":"Partially updates a course type with the specified ID.","description":"This method will patch an existing course type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCourseType","name":"Partially updates a course type with the specified ID.","isWebhook":false,"pointer":"/paths/~1courseTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a course type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing course type with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course type to patch.","required":true}],"pointer":"/paths/~1courseTypes~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1courseTypes~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/courseTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/courseTypes/{tenantId}/{id}","href":"course-types/patchcoursetype","openApiOperationId":"patchCourseType","summary":"Partially updates a course type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseType"}},"schemaId":"components/schemas/CourseType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-types/patchcoursetype"}],"panels":[]}]},"httpPath":"/courseTypes/{tenantId}/{id}"},{"label":"Updates a course type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/course-types/updatecoursetype","routeSlug":"/apis/certifications/certifications-v1/course-types/updatecoursetype","metadata":{"seo":{"title":"Updates a course type with the specified ID.","description":"This method will update an existing course type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCourseType","name":"Updates a course type with the specified ID.","isWebhook":false,"pointer":"/paths/~1courseTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a course type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing course type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course type to update.","required":true}],"pointer":"/paths/~1courseTypes~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseType"}},"schemaId":"components/schemas/CourseType","pointer":"/paths/~1courseTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated course type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/courseTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CourseType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/courseTypes/{tenantId}/{id}","href":"course-types/updatecoursetype","openApiOperationId":"updateCourseType","summary":"Updates a course type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CourseType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CourseType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseType"}},"schemaId":"components/schemas/CourseType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course type supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courseTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CourseType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CourseType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/course-types/updatecoursetype"}],"panels":[]}]},"httpPath":"/courseTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Course Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Course Types","showPageActions":true},{"nodeType":"markdoc","content":"Course Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/courseTypes/{tenantId}","summary":"Gets all of the course types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-types/listcoursetypes","deprecated":false},{"title":"/courseTypes/{tenantId}","summary":"Creates a new course type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-types/createcoursetype","deprecated":false},{"title":"/courseTypes/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/course-types/executebatchoperations","deprecated":false},{"title":"/courseTypes/{tenantId}/public","summary":"Gets all of the course types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-types/listcoursetypespublic","deprecated":false},{"title":"/courseTypes/{tenantId}/public/{id}","summary":"Returns a course type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-types/getcoursetypepublic","deprecated":false},{"title":"/courseTypes/{tenantId}/{id}","summary":"Returns a course type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/course-types/deletecoursetype","deprecated":false},{"title":"/courseTypes/{tenantId}/{id}","summary":"Returns a course type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/course-types/getcoursetype","deprecated":false},{"title":"/courseTypes/{tenantId}/{id}","summary":"Partially updates a course type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/course-types/patchcoursetype","deprecated":false},{"title":"/courseTypes/{tenantId}/{id}","summary":"Updates a course type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/course-types/updatecoursetype","deprecated":false}]}]}]}]}},{"type":"group","label":"Courses","link":"/apis/certifications/certifications-v1/courses","routeSlug":"/apis/certifications/certifications-v1/courses","items":[{"label":"Gets all of the courses in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/courses/listcourses","routeSlug":"/apis/certifications/certifications-v1/courses/listcourses","metadata":{"seo":{"title":"Gets all of the courses in the system.","description":"This method will scan all courses and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCourses","name":"Gets all of the courses in the system.","isWebhook":false,"pointer":"/paths/~1courses~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the courses in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all courses and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courses~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1courses~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courses/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courses/{tenantId}","href":"courses/listcourses","openApiOperationId":"listCourses","summary":"Gets all of the courses in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The courseswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}},"schemaId":"schema_388","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courses~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_388","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/courses/listcourses"}],"panels":[]}]},"httpPath":"/courses/{tenantId}"},{"label":"Creates a new course record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/courses/createcourse","routeSlug":"/apis/certifications/certifications-v1/courses/createcourse","metadata":{"seo":{"title":"Creates a new course record that does not already exist.","description":"This method will auto-generate an ID and create a new course. If an ID is specified for the course, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCourse","name":"Creates a new course record that does not already exist.","isWebhook":false,"pointer":"/paths/~1courses~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new course record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new course. If an ID is specified for the course, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courses~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Course"}},"schemaId":"components/schemas/Course","pointer":"/paths/~1courses~1{tenantId}/post/requestBody","description":"The course that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courses/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Course"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/courses/{tenantId}","href":"courses/createcourse","openApiOperationId":"createCourse","summary":"Creates a new course record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Course","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Course"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Course"}},"schemaId":"components/schemas/Course","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add course based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courses~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Course","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Course"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/courses/createcourse"}],"panels":[]}]},"httpPath":"/courses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/courses/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/courses/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1courses~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courses~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1courses~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/courses/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courses/{tenantId}/batch","href":"courses/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courses~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/courses/executebatchoperations"}],"panels":[]}]},"httpPath":"/courses/{tenantId}/batch"},{"label":"Gets all of the courses in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/courses/listallcoursespublic","routeSlug":"/apis/certifications/certifications-v1/courses/listallcoursespublic","metadata":{"seo":{"title":"Gets all of the courses in the system.","description":"This method will scan all courses and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAllCoursesPublic","name":"Gets all of the courses in the system.","isWebhook":false,"pointer":"/paths/~1courses~1{tenantId}~1public/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the courses in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all courses and and return them to the caller."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1courses~1{tenantId}~1public/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1courses~1{tenantId}~1public/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courses/{tenantId}/public","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courses/{tenantId}/public","href":"courses/listallcoursespublic","openApiOperationId":"listAllCoursesPublic","summary":"Gets all of the courses in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The courseswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}},"schemaId":"schema_388","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courses~1{tenantId}~1public/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_388","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_388"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/courses/listallcoursespublic"}],"panels":[]}]},"httpPath":"/courses/{tenantId}/public"},{"label":"Returns a course from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/courses/getcoursepublic","routeSlug":"/apis/certifications/certifications-v1/courses/getcoursepublic","metadata":{"seo":{"title":"Returns a course from the system by its ID.","description":"This method will look up a course by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCoursePublic","name":"Returns a course from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courses~1{tenantId}~1public~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a course by the specified ID and return it back."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course to return.","required":true}],"pointer":"/paths/~1courses~1{tenantId}~1public~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1courses~1{tenantId}~1public~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courses/{tenantId}/public/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courses/{tenantId}/public/{id}","href":"courses/getcoursepublic","openApiOperationId":"getCoursePublic","summary":"Returns a course from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Course"}},"schemaId":"components/schemas/Course","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courses~1{tenantId}~1public~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Course","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Course"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/courses/getcoursepublic"}],"panels":[]}]},"httpPath":"/courses/{tenantId}/public/{id}"},{"label":"Returns a course from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/courses/deletecourse","routeSlug":"/apis/certifications/certifications-v1/courses/deletecourse","metadata":{"seo":{"title":"Returns a course from the system by its ID.","description":"This method will delete a course with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCourse","name":"Returns a course from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courses~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a course with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course to delete.","required":true}],"pointer":"/paths/~1courses~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/courses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/courses/{tenantId}/{id}","href":"courses/deletecourse","openApiOperationId":"deleteCourse","summary":"Returns a course from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete course based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courses~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/courses/deletecourse"}],"panels":[]}]},"httpPath":"/courses/{tenantId}/{id}"},{"label":"Returns a course from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/courses/getcourse","routeSlug":"/apis/certifications/certifications-v1/courses/getcourse","metadata":{"seo":{"title":"Returns a course from the system by its ID.","description":"This method will look up a course by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCourse","name":"Returns a course from the system by its ID.","isWebhook":false,"pointer":"/paths/~1courses~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a course from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a course by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course to return.","required":true}],"pointer":"/paths/~1courses~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1courses~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/courses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/courses/{tenantId}/{id}","href":"courses/getcourse","openApiOperationId":"getCourse","summary":"Returns a course from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Course"}},"schemaId":"components/schemas/Course","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courses~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Course","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Course"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/courses/getcourse"}],"panels":[]}]},"httpPath":"/courses/{tenantId}/{id}"},{"label":"Partially updates a course with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/courses/patchcourse","routeSlug":"/apis/certifications/certifications-v1/courses/patchcourse","metadata":{"seo":{"title":"Partially updates a course with the specified ID.","description":"This method will patch an existing course with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCourse","name":"Partially updates a course with the specified ID.","isWebhook":false,"pointer":"/paths/~1courses~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a course with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing course with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course to patch.","required":true}],"pointer":"/paths/~1courses~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1courses~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/courses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/courses/{tenantId}/{id}","href":"courses/patchcourse","openApiOperationId":"patchCourse","summary":"Partially updates a course with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Course"}},"schemaId":"components/schemas/Course","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courses~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Course","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Course"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/courses/patchcourse"}],"panels":[]}]},"httpPath":"/courses/{tenantId}/{id}"},{"label":"Updates a course with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/courses/updatecourse","routeSlug":"/apis/certifications/certifications-v1/courses/updatecourse","metadata":{"seo":{"title":"Updates a course with the specified ID.","description":"This method will update an existing course with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCourse","name":"Updates a course with the specified ID.","isWebhook":false,"pointer":"/paths/~1courses~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a course with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing course with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the course to update.","required":true}],"pointer":"/paths/~1courses~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Course"}},"schemaId":"components/schemas/Course","pointer":"/paths/~1courses~1{tenantId}~1{id}/put/requestBody","description":"The updated course that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/courses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Course"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/courses/{tenantId}/{id}","href":"courses/updatecourse","openApiOperationId":"updateCourse","summary":"Updates a course with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Course","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Course"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The course was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Course"}},"schemaId":"components/schemas/Course","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The course supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The course could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The course could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve course based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1courses~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Course","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Course"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/courses/updatecourse"}],"panels":[]}]},"httpPath":"/courses/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Courses"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Courses","showPageActions":true},{"nodeType":"markdoc","content":"Courses"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/courses/{tenantId}","summary":"Gets all of the courses in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/courses/listcourses","deprecated":false},{"title":"/courses/{tenantId}","summary":"Creates a new course record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/courses/createcourse","deprecated":false},{"title":"/courses/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/courses/executebatchoperations","deprecated":false},{"title":"/courses/{tenantId}/public","summary":"Gets all of the courses in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/courses/listallcoursespublic","deprecated":false},{"title":"/courses/{tenantId}/public/{id}","summary":"Returns a course from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/courses/getcoursepublic","deprecated":false},{"title":"/courses/{tenantId}/{id}","summary":"Returns a course from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/courses/deletecourse","deprecated":false},{"title":"/courses/{tenantId}/{id}","summary":"Returns a course from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/courses/getcourse","deprecated":false},{"title":"/courses/{tenantId}/{id}","summary":"Partially updates a course with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/courses/patchcourse","deprecated":false},{"title":"/courses/{tenantId}/{id}","summary":"Updates a course with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/courses/updatecourse","deprecated":false}]}]}]}]}},{"type":"group","label":"Credit Types","link":"/apis/certifications/certifications-v1/credit-types","routeSlug":"/apis/certifications/certifications-v1/credit-types","items":[{"label":"Gets all of the credit types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credit-types/listcredittypes","routeSlug":"/apis/certifications/certifications-v1/credit-types/listcredittypes","metadata":{"seo":{"title":"Gets all of the credit types in the system.","description":"This method will scan all credit types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCreditTypes","name":"Gets all of the credit types in the system.","isWebhook":false,"pointer":"/paths/~1creditTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the credit types in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all credit types and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1creditTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1creditTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/creditTypes/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/creditTypes/{tenantId}","href":"credit-types/listcredittypes","openApiOperationId":"listCreditTypes","summary":"Gets all of the credit types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_389"}},"schemaId":"schema_389","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1creditTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_389","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_389"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-types/listcredittypes"}],"panels":[]}]},"httpPath":"/creditTypes/{tenantId}"},{"label":"Creates a new credit type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credit-types/createcredittype","routeSlug":"/apis/certifications/certifications-v1/credit-types/createcredittype","metadata":{"seo":{"title":"Creates a new credit type record that does not already exist.","description":"This method will auto-generate an ID and create a new credit type. If an ID is specified for the credit type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCreditType","name":"Creates a new credit type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1creditTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new credit type record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new credit type. If an ID is specified for the credit type, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1creditTypes~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditType"}},"schemaId":"components/schemas/CreditType","pointer":"/paths/~1creditTypes~1{tenantId}/post/requestBody","description":"The credit type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/creditTypes/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/creditTypes/{tenantId}","href":"credit-types/createcredittype","openApiOperationId":"createCreditType","summary":"Creates a new credit type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CreditType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditType"}},"schemaId":"components/schemas/CreditType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The credit type you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The credit type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add credit type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1creditTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-types/createcredittype"}],"panels":[]}]},"httpPath":"/creditTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credit-types/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/credit-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1creditTypes~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1creditTypes~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1creditTypes~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/creditTypes/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/creditTypes/{tenantId}/batch","href":"credit-types/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The credit type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve credit type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1creditTypes~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-types/executebatchoperations"}],"panels":[]}]},"httpPath":"/creditTypes/{tenantId}/batch"},{"label":"Returns a credit type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credit-types/deletecredittype","routeSlug":"/apis/certifications/certifications-v1/credit-types/deletecredittype","metadata":{"seo":{"title":"Returns a credit type from the system by its ID.","description":"This method will delete a credit type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCreditType","name":"Returns a credit type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1creditTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a credit type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a credit type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the credit type to delete.","required":true}],"pointer":"/paths/~1creditTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/creditTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/creditTypes/{tenantId}/{id}","href":"credit-types/deletecredittype","openApiOperationId":"deleteCreditType","summary":"Returns a credit type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The credit type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The credit type could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete credit type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1creditTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-types/deletecredittype"}],"panels":[]}]},"httpPath":"/creditTypes/{tenantId}/{id}"},{"label":"Returns a credit type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credit-types/getcredittype","routeSlug":"/apis/certifications/certifications-v1/credit-types/getcredittype","metadata":{"seo":{"title":"Returns a credit type from the system by its ID.","description":"This method will look up a credit type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCreditType","name":"Returns a credit type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1creditTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a credit type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a credit type by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the credit type to return.","required":true}],"pointer":"/paths/~1creditTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1creditTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/creditTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/creditTypes/{tenantId}/{id}","href":"credit-types/getcredittype","openApiOperationId":"getCreditType","summary":"Returns a credit type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditType"}},"schemaId":"components/schemas/CreditType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The credit type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve credit type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1creditTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-types/getcredittype"}],"panels":[]}]},"httpPath":"/creditTypes/{tenantId}/{id}"},{"label":"Partially updates a credit type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credit-types/patchcredittype","routeSlug":"/apis/certifications/certifications-v1/credit-types/patchcredittype","metadata":{"seo":{"title":"Partially updates a credit type with the specified ID.","description":"This method will patch an existing credit type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCreditType","name":"Partially updates a credit type with the specified ID.","isWebhook":false,"pointer":"/paths/~1creditTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a credit type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing credit type with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the credit type to patch.","required":true}],"pointer":"/paths/~1creditTypes~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1creditTypes~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/creditTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/creditTypes/{tenantId}/{id}","href":"credit-types/patchcredittype","openApiOperationId":"patchCreditType","summary":"Partially updates a credit type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditType"}},"schemaId":"components/schemas/CreditType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The credit type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The credit type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve credit type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1creditTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-types/patchcredittype"}],"panels":[]}]},"httpPath":"/creditTypes/{tenantId}/{id}"},{"label":"Updates a credit type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credit-types/updatecredittype","routeSlug":"/apis/certifications/certifications-v1/credit-types/updatecredittype","metadata":{"seo":{"title":"Updates a credit type with the specified ID.","description":"This method will update an existing credit type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCreditType","name":"Updates a credit type with the specified ID.","isWebhook":false,"pointer":"/paths/~1creditTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a credit type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing credit type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the credit type to update.","required":true}],"pointer":"/paths/~1creditTypes~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditType"}},"schemaId":"components/schemas/CreditType","pointer":"/paths/~1creditTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated credit type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/creditTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/creditTypes/{tenantId}/{id}","href":"credit-types/updatecredittype","openApiOperationId":"updateCreditType","summary":"Updates a credit type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CreditType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditType"}},"schemaId":"components/schemas/CreditType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The credit type supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The credit type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The credit type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve credit type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1creditTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-types/updatecredittype"}],"panels":[]}]},"httpPath":"/creditTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Credit Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit Types","showPageActions":true},{"nodeType":"markdoc","content":"Credit Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/creditTypes/{tenantId}","summary":"Gets all of the credit types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-types/listcredittypes","deprecated":false},{"title":"/creditTypes/{tenantId}","summary":"Creates a new credit type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-types/createcredittype","deprecated":false},{"title":"/creditTypes/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-types/executebatchoperations","deprecated":false},{"title":"/creditTypes/{tenantId}/{id}","summary":"Returns a credit type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/credit-types/deletecredittype","deprecated":false},{"title":"/creditTypes/{tenantId}/{id}","summary":"Returns a credit type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-types/getcredittype","deprecated":false},{"title":"/creditTypes/{tenantId}/{id}","summary":"Partially updates a credit type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/credit-types/patchcredittype","deprecated":false},{"title":"/creditTypes/{tenantId}/{id}","summary":"Updates a credit type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credit-types/updatecredittype","deprecated":false}]}]}]}]}},{"type":"group","label":"Credits","link":"/apis/certifications/certifications-v1/credits","routeSlug":"/apis/certifications/certifications-v1/credits","items":[{"label":"Gets all of the credits in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credits/listcredits","routeSlug":"/apis/certifications/certifications-v1/credits/listcredits","metadata":{"seo":{"title":"Gets all of the credits in the system.","description":"This method will scan all credits and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCredits","name":"Gets all of the credits in the system.","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the credits in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all credits and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1credits~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1credits~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credits/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/credits/{tenantId}","href":"credits/listcredits","openApiOperationId":"listCredits","summary":"Gets all of the credits in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The creditswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_390"}},"schemaId":"schema_390","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1credits~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_390","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_390"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/listcredits"}],"panels":[]}]},"httpPath":"/credits/{tenantId}"},{"label":"Creates a new credit record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credits/createcredit","routeSlug":"/apis/certifications/certifications-v1/credits/createcredit","metadata":{"seo":{"title":"Creates a new credit record that does not already exist.","description":"This method will auto-generate an ID and create a new credit. If an ID is specified for the credit, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCredit","name":"Creates a new credit record that does not already exist.","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new credit record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new credit. If an ID is specified for the credit, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1credits~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Credit"}},"schemaId":"components/schemas/Credit","pointer":"/paths/~1credits~1{tenantId}/post/requestBody","description":"The credit that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credits/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Credit"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/credits/{tenantId}","href":"credits/createcredit","openApiOperationId":"createCredit","summary":"Creates a new credit record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Credit","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Credit"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}},"schemaId":"components/schemas/Credit","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The credit you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The credit could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add credit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1credits~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Credit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/createcredit"}],"panels":[]}]},"httpPath":"/credits/{tenantId}"},{"label":"Returns a list of records with the specified activity_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credits/listcreditsbyactivityid","routeSlug":"/apis/certifications/certifications-v1/credits/listcreditsbyactivityid","metadata":{"seo":{"title":"Returns a list of records with the specified activity_id","description":"Returns a list of records with the specified activity_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCreditsByActivityId","name":"Returns a list of records with the specified activity_id","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1activity~1{activity_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified activity_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified activity_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"activity_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The activity_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1credits~1{tenantId}~1activity~1{activity_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1credits~1{tenantId}~1activity~1{activity_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credits/{tenantId}/activity/{activity_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"activity_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/credits/{tenantId}/activity/{activity_id}","href":"credits/listcreditsbyactivityid","openApiOperationId":"listCreditsByActivityId","summary":"Returns a list of records with the specified activity_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditsResponse"}},"schemaId":"components/schemas/ListCreditsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1credits~1{tenantId}~1activity~1{activity_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCreditsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/listcreditsbyactivityid"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/activity/{activity_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credits/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/credits/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1credits~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1credits~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credits/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/credits/{tenantId}/batch","href":"credits/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The credit could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve credit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1credits~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/executebatchoperations"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credits/listcreditsbycontactid","routeSlug":"/apis/certifications/certifications-v1/credits/listcreditsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCreditsByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1contact~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified contact_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1credits~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filterUnavailable","in":"query","schemaId":"schema_383","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}]},{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1credits~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credits/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"filterUnavailable","in":"query","required":false,"schemaId":"schema_383"},{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/credits/{tenantId}/contact/{contact_id}","href":"credits/listcreditsbycontactid","openApiOperationId":"listCreditsByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditsResponse"}},"schemaId":"components/schemas/ListCreditsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1credits~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCreditsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/listcreditsbycontactid"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified course_registration_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credits/listcreditsbycourseregistrationid","routeSlug":"/apis/certifications/certifications-v1/credits/listcreditsbycourseregistrationid","metadata":{"seo":{"title":"Returns a list of records with the specified course_registration_id","description":"Returns a list of records with the specified course_registration_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCreditsByCourseRegistrationId","name":"Returns a list of records with the specified course_registration_id","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1courseRegistration~1{course_registration_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified course_registration_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified course_registration_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"course_registration_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The course_registration_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1credits~1{tenantId}~1courseRegistration~1{course_registration_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1credits~1{tenantId}~1courseRegistration~1{course_registration_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credits/{tenantId}/courseRegistration/{course_registration_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"course_registration_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/credits/{tenantId}/courseRegistration/{course_registration_id}","href":"credits/listcreditsbycourseregistrationid","openApiOperationId":"listCreditsByCourseRegistrationId","summary":"Returns a list of records with the specified course_registration_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditsResponse"}},"schemaId":"components/schemas/ListCreditsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1credits~1{tenantId}~1courseRegistration~1{course_registration_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCreditsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/listcreditsbycourseregistrationid"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/courseRegistration/{course_registration_id}"},{"label":"Returns a list of records with the specified event_registration_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credits/listcreditsbyeventregistrationid","routeSlug":"/apis/certifications/certifications-v1/credits/listcreditsbyeventregistrationid","metadata":{"seo":{"title":"Returns a list of records with the specified event_registration_id","description":"Returns a list of records with the specified event_registration_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCreditsByEventRegistrationId","name":"Returns a list of records with the specified event_registration_id","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1eventRegistration~1{event_registration_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified event_registration_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified event_registration_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"event_registration_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event_registration_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1credits~1{tenantId}~1eventRegistration~1{event_registration_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1credits~1{tenantId}~1eventRegistration~1{event_registration_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credits/{tenantId}/eventRegistration/{event_registration_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"event_registration_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/credits/{tenantId}/eventRegistration/{event_registration_id}","href":"credits/listcreditsbyeventregistrationid","openApiOperationId":"listCreditsByEventRegistrationId","summary":"Returns a list of records with the specified event_registration_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditsResponse"}},"schemaId":"components/schemas/ListCreditsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1credits~1{tenantId}~1eventRegistration~1{event_registration_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCreditsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/listcreditsbyeventregistrationid"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/eventRegistration/{event_registration_id}"},{"label":"Searches for credits using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credits/searchforcredits","routeSlug":"/apis/certifications/certifications-v1/credits/searchforcredits","metadata":{"seo":{"title":"Searches for credits using predefined parameters","description":"Searches for credits using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForCredits","name":"Searches for credits using predefined parameters","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for credits using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for credits using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1credits~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_366","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1credits~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditSearchParameters"}},"schemaId":"components/schemas/CreditSearchParameters","pointer":"/paths/~1credits~1{tenantId}~1search/post/requestBody","description":"The credit that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credits/{tenantId}/search","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/credits/{tenantId}/search","href":"credits/searchforcredits","openApiOperationId":"searchForCredits","summary":"Searches for credits using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CreditSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCreditSearchResults"}},"schemaId":"components/schemas/PagedCreditSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The credit you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The credit could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add credit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1credits~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedCreditSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCreditSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/searchforcredits"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/search"},{"label":"Returns a credit from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credits/deletecredit","routeSlug":"/apis/certifications/certifications-v1/credits/deletecredit","metadata":{"seo":{"title":"Returns a credit from the system by its ID.","description":"This method will delete a credit with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCredit","name":"Returns a credit from the system by its ID.","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a credit from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a credit with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the credit to delete.","required":true}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/credits/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/credits/{tenantId}/{id}","href":"credits/deletecredit","openApiOperationId":"deleteCredit","summary":"Returns a credit from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The credit could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The credit could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete credit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/deletecredit"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/{id}"},{"label":"Returns a credit from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credits/getcredit","routeSlug":"/apis/certifications/certifications-v1/credits/getcredit","metadata":{"seo":{"title":"Returns a credit from the system by its ID.","description":"This method will look up a credit by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCredit","name":"Returns a credit from the system by its ID.","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a credit from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a credit by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the credit to return.","required":true}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credits/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/credits/{tenantId}/{id}","href":"credits/getcredit","openApiOperationId":"getCredit","summary":"Returns a credit from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}},"schemaId":"components/schemas/Credit","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The credit could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve credit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Credit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/getcredit"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/{id}"},{"label":"Partially updates a credit with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credits/patchcredit","routeSlug":"/apis/certifications/certifications-v1/credits/patchcredit","metadata":{"seo":{"title":"Partially updates a credit with the specified ID.","description":"This method will patch an existing credit with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCredit","name":"Partially updates a credit with the specified ID.","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a credit with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing credit with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the credit to patch.","required":true}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1credits~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/credits/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/credits/{tenantId}/{id}","href":"credits/patchcredit","openApiOperationId":"patchCredit","summary":"Partially updates a credit with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}},"schemaId":"components/schemas/Credit","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The credit could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The credit could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve credit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Credit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/patchcredit"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/{id}"},{"label":"Updates a credit with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/credits/updatecredit","routeSlug":"/apis/certifications/certifications-v1/credits/updatecredit","metadata":{"seo":{"title":"Updates a credit with the specified ID.","description":"This method will update an existing credit with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCredit","name":"Updates a credit with the specified ID.","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a credit with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing credit with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the credit to update.","required":true}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Credit"}},"schemaId":"components/schemas/Credit","pointer":"/paths/~1credits~1{tenantId}~1{id}/put/requestBody","description":"The updated credit that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/credits/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Credit"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/credits/{tenantId}/{id}","href":"credits/updatecredit","openApiOperationId":"updateCredit","summary":"Updates a credit with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Credit","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Credit"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}},"schemaId":"components/schemas/Credit","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The credit supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The credit could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The credit could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve credit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Credit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/updatecredit"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Credits"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credits","showPageActions":true},{"nodeType":"markdoc","content":"Credits"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/credits/{tenantId}","summary":"Gets all of the credits in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credits/listcredits","deprecated":false},{"title":"/credits/{tenantId}","summary":"Creates a new credit record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credits/createcredit","deprecated":false},{"title":"/credits/{tenantId}/activity/{activity_id}","summary":"Returns a list of records with the specified activity_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credits/listcreditsbyactivityid","deprecated":false},{"title":"/credits/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credits/executebatchoperations","deprecated":false},{"title":"/credits/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credits/listcreditsbycontactid","deprecated":false},{"title":"/credits/{tenantId}/courseRegistration/{course_registration_id}","summary":"Returns a list of records with the specified course_registration_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credits/listcreditsbycourseregistrationid","deprecated":false},{"title":"/credits/{tenantId}/eventRegistration/{event_registration_id}","summary":"Returns a list of records with the specified event_registration_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credits/listcreditsbyeventregistrationid","deprecated":false},{"title":"/credits/{tenantId}/search","summary":"Searches for credits using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credits/searchforcredits","deprecated":false},{"title":"/credits/{tenantId}/{id}","summary":"Returns a credit from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/credits/deletecredit","deprecated":false},{"title":"/credits/{tenantId}/{id}","summary":"Returns a credit from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credits/getcredit","deprecated":false},{"title":"/credits/{tenantId}/{id}","summary":"Partially updates a credit with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/credits/patchcredit","deprecated":false},{"title":"/credits/{tenantId}/{id}","summary":"Updates a credit with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credits/updatecredit","deprecated":false}]}]}]}]}},{"type":"group","label":"Directories","link":"/apis/certifications/certifications-v1/directories","routeSlug":"/apis/certifications/certifications-v1/directories","items":[{"label":"Gets all of the directories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/directories/listdirectories","routeSlug":"/apis/certifications/certifications-v1/directories/listdirectories","metadata":{"seo":{"title":"Gets all of the directories in the system.","description":"This method will scan all directories and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDirectories","name":"Gets all of the directories in the system.","isWebhook":false,"pointer":"/paths/~1directories~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the directories in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all directories and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1directories~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1directories~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/directories/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/directories/{tenantId}","href":"directories/listdirectories","openApiOperationId":"listDirectories","summary":"Gets all of the directories in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The directorieswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_391"}},"schemaId":"schema_391","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1directories~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_391","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_391"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/directories/listdirectories"}],"panels":[]}]},"httpPath":"/directories/{tenantId}"},{"label":"Creates a new directory record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/directories/createdirectory","routeSlug":"/apis/certifications/certifications-v1/directories/createdirectory","metadata":{"seo":{"title":"Creates a new directory record that does not already exist.","description":"This method will auto-generate an ID and create a new directory. If an ID is specified for the directory, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDirectory","name":"Creates a new directory record that does not already exist.","isWebhook":false,"pointer":"/paths/~1directories~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new directory record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new directory. If an ID is specified for the directory, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1directories~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Directory"}},"schemaId":"components/schemas/Directory","pointer":"/paths/~1directories~1{tenantId}/post/requestBody","description":"The directory that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/directories/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Directory"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/directories/{tenantId}","href":"directories/createdirectory","openApiOperationId":"createDirectory","summary":"Creates a new directory record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Directory","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Directory"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The directory was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Directory"}},"schemaId":"components/schemas/Directory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The directory you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The directory could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1directories~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Directory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Directory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/directories/createdirectory"}],"panels":[]}]},"httpPath":"/directories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/directories/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/directories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1directories~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1directories~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1directories~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/directories/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/directories/{tenantId}/batch","href":"directories/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1directories~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/directories/executebatchoperations"}],"panels":[]}]},"httpPath":"/directories/{tenantId}/batch"},{"label":"Gets an entry in the directory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/directories/getdirectoryentry","routeSlug":"/apis/certifications/certifications-v1/directories/getdirectoryentry","metadata":{"seo":{"title":"Gets an entry in the directory","description":"Gets an entry in the directory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDirectoryEntry","name":"Gets an entry in the directory","isWebhook":false,"pointer":"/paths/~1directories~1{tenantId}~1public~1entry~1{id}~1{entryId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets an entry in the directory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"Parameters to the query","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"directory","required":true},{"name":"entryId","in":"path","schemaId":"schema_366","description":"The id of the entry","required":true}],"pointer":"/paths/~1directories~1{tenantId}~1public~1entry~1{id}~1{entryId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/directories/{tenantId}/public/entry/{id}/{entryId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"},{"name":"entryId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/directories/{tenantId}/public/entry/{id}/{entryId}","href":"directories/getdirectoryentry","openApiOperationId":"getDirectoryEntry","summary":"Gets an entry in the directory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was merged successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The contact supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to merge contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1directories~1{tenantId}~1public~1entry~1{id}~1{entryId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/directories/getdirectoryentry"}],"panels":[]}]},"httpPath":"/directories/{tenantId}/public/entry/{id}/{entryId}"},{"label":"Searches the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/directories/searchpublicdirectory","routeSlug":"/apis/certifications/certifications-v1/directories/searchpublicdirectory","metadata":{"seo":{"title":"Searches the directory","description":"Searches the directory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchPublicDirectory","name":"Searches the directory","isWebhook":false,"pointer":"/paths/~1directories~1{tenantId}~1public~1search~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches the directory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"Parameters to the query","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"directory","required":true}],"pointer":"/paths/~1directories~1{tenantId}~1public~1search~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"schemaId":"components/schemas/DirectorySearchCriteria","pointer":"/paths/~1directories~1{tenantId}~1public~1search~1{id}/post/requestBody","description":"The query"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/directories/{tenantId}/public/search/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/directories/{tenantId}/public/search/{id}","href":"directories/searchpublicdirectory","openApiOperationId":"searchPublicDirectory","summary":"Searches the directory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DirectorySearchCriteria","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was merged successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectorySearchResults"}},"schemaId":"components/schemas/DirectorySearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The contact supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to merge contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1directories~1{tenantId}~1public~1search~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DirectorySearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectorySearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/directories/searchpublicdirectory"}],"panels":[]}]},"httpPath":"/directories/{tenantId}/public/search/{id}"},{"label":"Sends a message to an entry in the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/directories/senddirectorymessage","routeSlug":"/apis/certifications/certifications-v1/directories/senddirectorymessage","metadata":{"seo":{"title":"Sends a message to an entry in the directory","description":"Sends a message to an entry in the directory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendDirectoryMessage","name":"Sends a message to an entry in the directory","isWebhook":false,"pointer":"/paths/~1directories~1{tenantId}~1public~1sendMessage~1{directoryId}~1{entryId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends a message to an entry in the directory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"Parameters to the query","required":true},{"name":"directoryId","in":"path","schemaId":"schema_366","description":"directory","required":true},{"name":"entryId","in":"path","schemaId":"schema_366","description":"The id of the entry","required":true}],"pointer":"/paths/~1directories~1{tenantId}~1public~1sendMessage~1{directoryId}~1{entryId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectoryMessage"}},"schemaId":"components/schemas/DirectoryMessage","pointer":"/paths/~1directories~1{tenantId}~1public~1sendMessage~1{directoryId}~1{entryId}/post/requestBody","description":"The message to send"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/directories/{tenantId}/public/sendMessage/{directoryId}/{entryId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"directoryId","in":"path","required":true,"schemaId":"schema_366"},{"name":"entryId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/DirectoryMessage"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/directories/{tenantId}/public/sendMessage/{directoryId}/{entryId}","href":"directories/senddirectorymessage","openApiOperationId":"sendDirectoryMessage","summary":"Sends a message to an entry in the directory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DirectoryMessage","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectoryMessage"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was merged successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The contact supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to merge contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1directories~1{tenantId}~1public~1sendMessage~1{directoryId}~1{entryId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/directories/senddirectorymessage"}],"panels":[]}]},"httpPath":"/directories/{tenantId}/public/sendMessage/{directoryId}/{entryId}"},{"label":"Returns a directory from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/directories/getpublicdirectory","routeSlug":"/apis/certifications/certifications-v1/directories/getpublicdirectory","metadata":{"seo":{"title":"Returns a directory from the system by its ID.","description":"This method will look up a directory by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPublicDirectory","name":"Returns a directory from the system by its ID.","isWebhook":false,"pointer":"/paths/~1directories~1{tenantId}~1public~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a directory from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a directory by the specified ID and return it back."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the directory to return.","required":true}],"pointer":"/paths/~1directories~1{tenantId}~1public~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1directories~1{tenantId}~1public~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/directories/{tenantId}/public/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/directories/{tenantId}/public/{id}","href":"directories/getpublicdirectory","openApiOperationId":"getPublicDirectory","summary":"Returns a directory from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The directory was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Directory"}},"schemaId":"components/schemas/Directory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1directories~1{tenantId}~1public~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Directory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Directory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/directories/getpublicdirectory"}],"panels":[]}]},"httpPath":"/directories/{tenantId}/public/{id}"},{"label":"Searches the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/directories/searchdirectory","routeSlug":"/apis/certifications/certifications-v1/directories/searchdirectory","metadata":{"seo":{"title":"Searches the directory","description":"Searches the directory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchDirectory","name":"Searches the directory","isWebhook":false,"pointer":"/paths/~1directories~1{tenantId}~1search~1{id}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches the directory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"Parameters to the query","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"directory","required":true}],"pointer":"/paths/~1directories~1{tenantId}~1search~1{id}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"schemaId":"components/schemas/DirectorySearchCriteria","pointer":"/paths/~1directories~1{tenantId}~1search~1{id}/post/requestBody","description":"The query"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/directories/{tenantId}/search/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/directories/{tenantId}/search/{id}","href":"directories/searchdirectory","openApiOperationId":"searchDirectory","summary":"Searches the directory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DirectorySearchCriteria","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectorySearchCriteria"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was merged successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectorySearchResults"}},"schemaId":"components/schemas/DirectorySearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The contact supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to merge contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1directories~1{tenantId}~1search~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DirectorySearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectorySearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/directories/searchdirectory"}],"panels":[]}]},"httpPath":"/directories/{tenantId}/search/{id}"},{"label":"Returns a directory from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/directories/deletedirectory","routeSlug":"/apis/certifications/certifications-v1/directories/deletedirectory","metadata":{"seo":{"title":"Returns a directory from the system by its ID.","description":"This method will delete a directory with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDirectory","name":"Returns a directory from the system by its ID.","isWebhook":false,"pointer":"/paths/~1directories~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a directory from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a directory with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the directory to delete.","required":true}],"pointer":"/paths/~1directories~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/directories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/directories/{tenantId}/{id}","href":"directories/deletedirectory","openApiOperationId":"deleteDirectory","summary":"Returns a directory from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The directory was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The directory could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1directories~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/directories/deletedirectory"}],"panels":[]}]},"httpPath":"/directories/{tenantId}/{id}"},{"label":"Returns a directory from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/directories/getdirectory","routeSlug":"/apis/certifications/certifications-v1/directories/getdirectory","metadata":{"seo":{"title":"Returns a directory from the system by its ID.","description":"This method will look up a directory by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDirectory","name":"Returns a directory from the system by its ID.","isWebhook":false,"pointer":"/paths/~1directories~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a directory from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a directory by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the directory to return.","required":true}],"pointer":"/paths/~1directories~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1directories~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/directories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/directories/{tenantId}/{id}","href":"directories/getdirectory","openApiOperationId":"getDirectory","summary":"Returns a directory from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The directory was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Directory"}},"schemaId":"components/schemas/Directory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1directories~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Directory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Directory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/directories/getdirectory"}],"panels":[]}]},"httpPath":"/directories/{tenantId}/{id}"},{"label":"Partially updates a directory with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/directories/patchdirectory","routeSlug":"/apis/certifications/certifications-v1/directories/patchdirectory","metadata":{"seo":{"title":"Partially updates a directory with the specified ID.","description":"This method will patch an existing directory with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchDirectory","name":"Partially updates a directory with the specified ID.","isWebhook":false,"pointer":"/paths/~1directories~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a directory with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing directory with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the directory to patch.","required":true}],"pointer":"/paths/~1directories~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1directories~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/directories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/directories/{tenantId}/{id}","href":"directories/patchdirectory","openApiOperationId":"patchDirectory","summary":"Partially updates a directory with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The directory was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Directory"}},"schemaId":"components/schemas/Directory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The directory could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1directories~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Directory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Directory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/directories/patchdirectory"}],"panels":[]}]},"httpPath":"/directories/{tenantId}/{id}"},{"label":"Updates a directory with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/directories/updatedirectory","routeSlug":"/apis/certifications/certifications-v1/directories/updatedirectory","metadata":{"seo":{"title":"Updates a directory with the specified ID.","description":"This method will update an existing directory with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDirectory","name":"Updates a directory with the specified ID.","isWebhook":false,"pointer":"/paths/~1directories~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a directory with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing directory with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the directory to update.","required":true}],"pointer":"/paths/~1directories~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Directory"}},"schemaId":"components/schemas/Directory","pointer":"/paths/~1directories~1{tenantId}~1{id}/put/requestBody","description":"The updated directory that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/directories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Directory"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/directories/{tenantId}/{id}","href":"directories/updatedirectory","openApiOperationId":"updateDirectory","summary":"Updates a directory with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Directory","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Directory"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The directory was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Directory"}},"schemaId":"components/schemas/Directory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The directory supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The directory could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The directory could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve directory based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1directories~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Directory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Directory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/directories/updatedirectory"}],"panels":[]}]},"httpPath":"/directories/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Directories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Directories","showPageActions":true},{"nodeType":"markdoc","content":"Directories"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/directories/{tenantId}","summary":"Gets all of the directories in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/directories/listdirectories","deprecated":false},{"title":"/directories/{tenantId}","summary":"Creates a new directory record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/directories/createdirectory","deprecated":false},{"title":"/directories/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/directories/executebatchoperations","deprecated":false},{"title":"/directories/{tenantId}/public/entry/{id}/{entryId}","summary":"Gets an entry in the directory","prefix":{"name":"get","color":"get"},"badges":[],"link":"/directories/getdirectoryentry","deprecated":false},{"title":"/directories/{tenantId}/public/search/{id}","summary":"Searches the directory","prefix":{"name":"post","color":"post"},"badges":[],"link":"/directories/searchpublicdirectory","deprecated":false},{"title":"/directories/{tenantId}/public/sendMessage/{directoryId}/{entryId}","summary":"Sends a message to an entry in the directory","prefix":{"name":"post","color":"post"},"badges":[],"link":"/directories/senddirectorymessage","deprecated":false},{"title":"/directories/{tenantId}/public/{id}","summary":"Returns a directory from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/directories/getpublicdirectory","deprecated":false},{"title":"/directories/{tenantId}/search/{id}","summary":"Searches the directory","prefix":{"name":"post","color":"post"},"badges":[],"link":"/directories/searchdirectory","deprecated":false},{"title":"/directories/{tenantId}/{id}","summary":"Returns a directory from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/directories/deletedirectory","deprecated":false},{"title":"/directories/{tenantId}/{id}","summary":"Returns a directory from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/directories/getdirectory","deprecated":false},{"title":"/directories/{tenantId}/{id}","summary":"Partially updates a directory with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/directories/patchdirectory","deprecated":false},{"title":"/directories/{tenantId}/{id}","summary":"Updates a directory with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/directories/updatedirectory","deprecated":false}]}]}]}]}},{"type":"group","label":"Exam Fees","link":"/apis/certifications/certifications-v1/exam-fees","routeSlug":"/apis/certifications/certifications-v1/exam-fees","items":[{"label":"Creates a new exam fee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-fees/createexamfee","routeSlug":"/apis/certifications/certifications-v1/exam-fees/createexamfee","metadata":{"seo":{"title":"Creates a new exam fee record that does not already exist.","description":"This method will auto-generate an ID and create a new exam fee. If an ID is specified for the exam fee, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createExamFee","name":"Creates a new exam fee record that does not already exist.","isWebhook":false,"pointer":"/paths/~1examFees~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new exam fee record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new exam fee. If an ID is specified for the exam fee, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1examFees~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamFee"}},"schemaId":"components/schemas/ExamFee","pointer":"/paths/~1examFees~1{tenantId}/post/requestBody","description":"The exam fee that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examFees/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExamFee"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examFees/{tenantId}","href":"exam-fees/createexamfee","openApiOperationId":"createExamFee","summary":"Creates a new exam fee record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExamFee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamFee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam fee was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamFee"}},"schemaId":"components/schemas/ExamFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The exam fee you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add exam fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examFees~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-fees/createexamfee"}],"panels":[]}]},"httpPath":"/examFees/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-fees/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/exam-fees/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1examFees~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1examFees~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1examFees~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examFees/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examFees/{tenantId}/batch","href":"exam-fees/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examFees~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-fees/executebatchoperations"}],"panels":[]}]},"httpPath":"/examFees/{tenantId}/batch"},{"label":"Returns a list of records with the specified exam_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-fees/listfeesbyexamid","routeSlug":"/apis/certifications/certifications-v1/exam-fees/listfeesbyexamid","metadata":{"seo":{"title":"Returns a list of records with the specified exam_id","description":"Returns a list of records with the specified exam_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFeesByExamId","name":"Returns a list of records with the specified exam_id","isWebhook":false,"pointer":"/paths/~1examFees~1{tenantId}~1exam~1{exam_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified exam_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified exam_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"exam_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The exam_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1examFees~1{tenantId}~1exam~1{exam_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1examFees~1{tenantId}~1exam~1{exam_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examFees/{tenantId}/exam/{exam_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"exam_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examFees/{tenantId}/exam/{exam_id}","href":"exam-fees/listfeesbyexamid","openApiOperationId":"listFeesByExamId","summary":"Returns a list of records with the specified exam_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamFeesResponse"}},"schemaId":"components/schemas/ListExamFeesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examFees~1{tenantId}~1exam~1{exam_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExamFeesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamFeesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-fees/listfeesbyexamid"}],"panels":[]}]},"httpPath":"/examFees/{tenantId}/exam/{exam_id}"},{"label":"Get Fees for Online Store","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-fees/getfeesforonlinestore","routeSlug":"/apis/certifications/certifications-v1/exam-fees/getfeesforonlinestore","metadata":{"seo":{"title":"Get Fees for Online Store","description":"Public endpoint that gets fees for use in the online store"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFeesForOnlineStore","name":"Get Fees for Online Store","isWebhook":false,"pointer":"/paths/~1examFees~1{tenantId}~1public~1onlineStore/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Fees for Online Store","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Public endpoint that gets fees for use in the online store"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true}],"pointer":"/paths/~1examFees~1{tenantId}~1public~1onlineStore/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicCertificationExamFeesRequest"}},"schemaId":"components/schemas/PublicCertificationExamFeesRequest","pointer":"/paths/~1examFees~1{tenantId}~1public~1onlineStore/post/requestBody","description":"Restrictions"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examFees/{tenantId}/public/onlineStore","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PublicCertificationExamFeesRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examFees/{tenantId}/public/onlineStore","href":"exam-fees/getfeesforonlinestore","openApiOperationId":"getFeesForOnlineStore","summary":"Get Fees for Online Store"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PublicCertificationExamFeesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicCertificationExamFeesRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The store was retrieved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PublicCertificationExamFeesResponse"}},"schemaId":"components/schemas/PublicCertificationExamFeesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examFees~1{tenantId}~1public~1onlineStore/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PublicCertificationExamFeesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PublicCertificationExamFeesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-fees/getfeesforonlinestore"}],"panels":[]}]},"httpPath":"/examFees/{tenantId}/public/onlineStore"},{"label":"Returns a exam fee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-fees/deleteexamfee","routeSlug":"/apis/certifications/certifications-v1/exam-fees/deleteexamfee","metadata":{"seo":{"title":"Returns a exam fee from the system by its ID.","description":"This method will delete a exam fee with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteExamFee","name":"Returns a exam fee from the system by its ID.","isWebhook":false,"pointer":"/paths/~1examFees~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a exam fee from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a exam fee with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam fee to delete.","required":true}],"pointer":"/paths/~1examFees~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/examFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examFees/{tenantId}/{id}","href":"exam-fees/deleteexamfee","openApiOperationId":"deleteExamFee","summary":"Returns a exam fee from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam fee was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam fee could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete exam fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examFees~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-fees/deleteexamfee"}],"panels":[]}]},"httpPath":"/examFees/{tenantId}/{id}"},{"label":"Returns a exam fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-fees/getexamfee","routeSlug":"/apis/certifications/certifications-v1/exam-fees/getexamfee","metadata":{"seo":{"title":"Returns a exam fee from the system by its ID.","description":"This method will look up a exam fee by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExamFee","name":"Returns a exam fee from the system by its ID.","isWebhook":false,"pointer":"/paths/~1examFees~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a exam fee from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a exam fee by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam fee to return.","required":true}],"pointer":"/paths/~1examFees~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1examFees~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examFees/{tenantId}/{id}","href":"exam-fees/getexamfee","openApiOperationId":"getExamFee","summary":"Returns a exam fee from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam fee was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamFee"}},"schemaId":"components/schemas/ExamFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examFees~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-fees/getexamfee"}],"panels":[]}]},"httpPath":"/examFees/{tenantId}/{id}"},{"label":"Partially updates a exam fee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-fees/patchexamfee","routeSlug":"/apis/certifications/certifications-v1/exam-fees/patchexamfee","metadata":{"seo":{"title":"Partially updates a exam fee with the specified ID.","description":"This method will patch an existing exam fee with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchExamFee","name":"Partially updates a exam fee with the specified ID.","isWebhook":false,"pointer":"/paths/~1examFees~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a exam fee with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing exam fee with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam fee to patch.","required":true}],"pointer":"/paths/~1examFees~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1examFees~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/examFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examFees/{tenantId}/{id}","href":"exam-fees/patchexamfee","openApiOperationId":"patchExamFee","summary":"Partially updates a exam fee with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam fee was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamFee"}},"schemaId":"components/schemas/ExamFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examFees~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-fees/patchexamfee"}],"panels":[]}]},"httpPath":"/examFees/{tenantId}/{id}"},{"label":"Updates a exam fee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-fees/updateexamfee","routeSlug":"/apis/certifications/certifications-v1/exam-fees/updateexamfee","metadata":{"seo":{"title":"Updates a exam fee with the specified ID.","description":"This method will update an existing exam fee with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateExamFee","name":"Updates a exam fee with the specified ID.","isWebhook":false,"pointer":"/paths/~1examFees~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a exam fee with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing exam fee with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam fee to update.","required":true}],"pointer":"/paths/~1examFees~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamFee"}},"schemaId":"components/schemas/ExamFee","pointer":"/paths/~1examFees~1{tenantId}~1{id}/put/requestBody","description":"The updated exam fee that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/examFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExamFee"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examFees/{tenantId}/{id}","href":"exam-fees/updateexamfee","openApiOperationId":"updateExamFee","summary":"Updates a exam fee with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExamFee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamFee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam fee was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamFee"}},"schemaId":"components/schemas/ExamFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The exam fee supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examFees~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-fees/updateexamfee"}],"panels":[]}]},"httpPath":"/examFees/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Exam Fees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exam Fees","showPageActions":true},{"nodeType":"markdoc","content":"Exam Fees"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/examFees/{tenantId}","summary":"Creates a new exam fee record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-fees/createexamfee","deprecated":false},{"title":"/examFees/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-fees/executebatchoperations","deprecated":false},{"title":"/examFees/{tenantId}/exam/{exam_id}","summary":"Returns a list of records with the specified exam_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-fees/listfeesbyexamid","deprecated":false},{"title":"/examFees/{tenantId}/public/onlineStore","summary":"Get Fees for Online Store","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-fees/getfeesforonlinestore","deprecated":false},{"title":"/examFees/{tenantId}/{id}","summary":"Returns a exam fee from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/exam-fees/deleteexamfee","deprecated":false},{"title":"/examFees/{tenantId}/{id}","summary":"Returns a exam fee from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-fees/getexamfee","deprecated":false},{"title":"/examFees/{tenantId}/{id}","summary":"Partially updates a exam fee with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/exam-fees/patchexamfee","deprecated":false},{"title":"/examFees/{tenantId}/{id}","summary":"Updates a exam fee with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/exam-fees/updateexamfee","deprecated":false}]}]}]}]}},{"type":"group","label":"Exam Notices","link":"/apis/certifications/certifications-v1/exam-notices","routeSlug":"/apis/certifications/certifications-v1/exam-notices","items":[{"label":"Gets all of the exam notices in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-notices/listexamnotices","routeSlug":"/apis/certifications/certifications-v1/exam-notices/listexamnotices","metadata":{"seo":{"title":"Gets all of the exam notices in the system.","description":"This method will scan all exam notices and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listExamNotices","name":"Gets all of the exam notices in the system.","isWebhook":false,"pointer":"/paths/~1examNotices~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the exam notices in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all exam notices and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1examNotices~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1examNotices~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examNotices/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examNotices/{tenantId}","href":"exam-notices/listexamnotices","openApiOperationId":"listExamNotices","summary":"Gets all of the exam notices in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam noticeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_392"}},"schemaId":"schema_392","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examNotices~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_392","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_392"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-notices/listexamnotices"}],"panels":[]}]},"httpPath":"/examNotices/{tenantId}"},{"label":"Creates a new exam notice record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-notices/createexamnotice","routeSlug":"/apis/certifications/certifications-v1/exam-notices/createexamnotice","metadata":{"seo":{"title":"Creates a new exam notice record that does not already exist.","description":"This method will auto-generate an ID and create a new exam notice. If an ID is specified for the exam notice, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createExamNotice","name":"Creates a new exam notice record that does not already exist.","isWebhook":false,"pointer":"/paths/~1examNotices~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new exam notice record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new exam notice. If an ID is specified for the exam notice, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1examNotices~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamNotice"}},"schemaId":"components/schemas/ExamNotice","pointer":"/paths/~1examNotices~1{tenantId}/post/requestBody","description":"The exam notice that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examNotices/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExamNotice"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/examNotices/{tenantId}","href":"exam-notices/createexamnotice","openApiOperationId":"createExamNotice","summary":"Creates a new exam notice record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExamNotice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamNotice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam notice was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamNotice"}},"schemaId":"components/schemas/ExamNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The exam notice you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add exam notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examNotices~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-notices/createexamnotice"}],"panels":[]}]},"httpPath":"/examNotices/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-notices/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/exam-notices/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1examNotices~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1examNotices~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1examNotices~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examNotices/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examNotices/{tenantId}/batch","href":"exam-notices/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examNotices~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-notices/executebatchoperations"}],"panels":[]}]},"httpPath":"/examNotices/{tenantId}/batch"},{"label":"Returns a exam notice from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-notices/deleteexamnotice","routeSlug":"/apis/certifications/certifications-v1/exam-notices/deleteexamnotice","metadata":{"seo":{"title":"Returns a exam notice from the system by its ID.","description":"This method will delete a exam notice with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteExamNotice","name":"Returns a exam notice from the system by its ID.","isWebhook":false,"pointer":"/paths/~1examNotices~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a exam notice from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a exam notice with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam notice to delete.","required":true}],"pointer":"/paths/~1examNotices~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/examNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/examNotices/{tenantId}/{id}","href":"exam-notices/deleteexamnotice","openApiOperationId":"deleteExamNotice","summary":"Returns a exam notice from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam notice was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam notice could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete exam notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examNotices~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-notices/deleteexamnotice"}],"panels":[]}]},"httpPath":"/examNotices/{tenantId}/{id}"},{"label":"Returns a exam notice from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-notices/getexamnotice","routeSlug":"/apis/certifications/certifications-v1/exam-notices/getexamnotice","metadata":{"seo":{"title":"Returns a exam notice from the system by its ID.","description":"This method will look up a exam notice by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExamNotice","name":"Returns a exam notice from the system by its ID.","isWebhook":false,"pointer":"/paths/~1examNotices~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a exam notice from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a exam notice by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam notice to return.","required":true}],"pointer":"/paths/~1examNotices~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1examNotices~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examNotices/{tenantId}/{id}","href":"exam-notices/getexamnotice","openApiOperationId":"getExamNotice","summary":"Returns a exam notice from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam notice was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamNotice"}},"schemaId":"components/schemas/ExamNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examNotices~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-notices/getexamnotice"}],"panels":[]}]},"httpPath":"/examNotices/{tenantId}/{id}"},{"label":"Partially updates a exam notice with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-notices/patchexamnotice","routeSlug":"/apis/certifications/certifications-v1/exam-notices/patchexamnotice","metadata":{"seo":{"title":"Partially updates a exam notice with the specified ID.","description":"This method will patch an existing exam notice with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchExamNotice","name":"Partially updates a exam notice with the specified ID.","isWebhook":false,"pointer":"/paths/~1examNotices~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a exam notice with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing exam notice with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam notice to patch.","required":true}],"pointer":"/paths/~1examNotices~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1examNotices~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/examNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/examNotices/{tenantId}/{id}","href":"exam-notices/patchexamnotice","openApiOperationId":"patchExamNotice","summary":"Partially updates a exam notice with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam notice was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamNotice"}},"schemaId":"components/schemas/ExamNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examNotices~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-notices/patchexamnotice"}],"panels":[]}]},"httpPath":"/examNotices/{tenantId}/{id}"},{"label":"Updates a exam notice with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-notices/updateexamnotice","routeSlug":"/apis/certifications/certifications-v1/exam-notices/updateexamnotice","metadata":{"seo":{"title":"Updates a exam notice with the specified ID.","description":"This method will update an existing exam notice with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateExamNotice","name":"Updates a exam notice with the specified ID.","isWebhook":false,"pointer":"/paths/~1examNotices~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a exam notice with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing exam notice with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam notice to update.","required":true}],"pointer":"/paths/~1examNotices~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamNotice"}},"schemaId":"components/schemas/ExamNotice","pointer":"/paths/~1examNotices~1{tenantId}~1{id}/put/requestBody","description":"The updated exam notice that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/examNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExamNotice"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/examNotices/{tenantId}/{id}","href":"exam-notices/updateexamnotice","openApiOperationId":"updateExamNotice","summary":"Updates a exam notice with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExamNotice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamNotice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam notice was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamNotice"}},"schemaId":"components/schemas/ExamNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The exam notice supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examNotices~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-notices/updateexamnotice"}],"panels":[]}]},"httpPath":"/examNotices/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Exam Notices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exam Notices","showPageActions":true},{"nodeType":"markdoc","content":"Exam Notices"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/examNotices/{tenantId}","summary":"Gets all of the exam notices in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-notices/listexamnotices","deprecated":false},{"title":"/examNotices/{tenantId}","summary":"Creates a new exam notice record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-notices/createexamnotice","deprecated":false},{"title":"/examNotices/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-notices/executebatchoperations","deprecated":false},{"title":"/examNotices/{tenantId}/{id}","summary":"Returns a exam notice from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/exam-notices/deleteexamnotice","deprecated":false},{"title":"/examNotices/{tenantId}/{id}","summary":"Returns a exam notice from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-notices/getexamnotice","deprecated":false},{"title":"/examNotices/{tenantId}/{id}","summary":"Partially updates a exam notice with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/exam-notices/patchexamnotice","deprecated":false},{"title":"/examNotices/{tenantId}/{id}","summary":"Updates a exam notice with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/exam-notices/updateexamnotice","deprecated":false}]}]}]}]}},{"type":"group","label":"Exam Offerings","link":"/apis/certifications/certifications-v1/exam-offerings","routeSlug":"/apis/certifications/certifications-v1/exam-offerings","items":[{"label":"Creates a new exam offering record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-offerings/createexamoffering","routeSlug":"/apis/certifications/certifications-v1/exam-offerings/createexamoffering","metadata":{"seo":{"title":"Creates a new exam offering record that does not already exist.","description":"This method will auto-generate an ID and create a new exam offering. If an ID is specified for the exam offering, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createExamOffering","name":"Creates a new exam offering record that does not already exist.","isWebhook":false,"pointer":"/paths/~1examOfferings~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new exam offering record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new exam offering. If an ID is specified for the exam offering, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1examOfferings~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamOffering"}},"schemaId":"components/schemas/ExamOffering","pointer":"/paths/~1examOfferings~1{tenantId}/post/requestBody","description":"The exam offering that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examOfferings/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExamOffering"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examOfferings/{tenantId}","href":"exam-offerings/createexamoffering","openApiOperationId":"createExamOffering","summary":"Creates a new exam offering record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExamOffering","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamOffering"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam offering was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamOffering"}},"schemaId":"components/schemas/ExamOffering","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The exam offering you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam offering could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add exam offering based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examOfferings~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamOffering","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamOffering"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-offerings/createexamoffering"}],"panels":[]}]},"httpPath":"/examOfferings/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-offerings/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/exam-offerings/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1examOfferings~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1examOfferings~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1examOfferings~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examOfferings/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examOfferings/{tenantId}/batch","href":"exam-offerings/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam offering could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam offering based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examOfferings~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-offerings/executebatchoperations"}],"panels":[]}]},"httpPath":"/examOfferings/{tenantId}/batch"},{"label":"Returns a list of records with the specified course_offering_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-offerings/listofferingsbycourseofferingid","routeSlug":"/apis/certifications/certifications-v1/exam-offerings/listofferingsbycourseofferingid","metadata":{"seo":{"title":"Returns a list of records with the specified course_offering_id","description":"Returns a list of records with the specified course_offering_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOfferingsByCourseOfferingId","name":"Returns a list of records with the specified course_offering_id","isWebhook":false,"pointer":"/paths/~1examOfferings~1{tenantId}~1courseOffering~1{course_offering_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified course_offering_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified course_offering_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"course_offering_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The course_offering_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1examOfferings~1{tenantId}~1courseOffering~1{course_offering_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1examOfferings~1{tenantId}~1courseOffering~1{course_offering_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examOfferings/{tenantId}/courseOffering/{course_offering_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"course_offering_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examOfferings/{tenantId}/courseOffering/{course_offering_id}","href":"exam-offerings/listofferingsbycourseofferingid","openApiOperationId":"listOfferingsByCourseOfferingId","summary":"Returns a list of records with the specified course_offering_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamOfferingsResponse"}},"schemaId":"components/schemas/ListExamOfferingsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examOfferings~1{tenantId}~1courseOffering~1{course_offering_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExamOfferingsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamOfferingsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-offerings/listofferingsbycourseofferingid"}],"panels":[]}]},"httpPath":"/examOfferings/{tenantId}/courseOffering/{course_offering_id}"},{"label":"Returns a list of records with the specified exam_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-offerings/listofferingsbyexamid","routeSlug":"/apis/certifications/certifications-v1/exam-offerings/listofferingsbyexamid","metadata":{"seo":{"title":"Returns a list of records with the specified exam_id","description":"Returns a list of records with the specified exam_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOfferingsByExamId","name":"Returns a list of records with the specified exam_id","isWebhook":false,"pointer":"/paths/~1examOfferings~1{tenantId}~1exam~1{exam_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified exam_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified exam_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"exam_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The exam_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1examOfferings~1{tenantId}~1exam~1{exam_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includePastOfferings","in":"query","schemaId":"schema_366","description":"If set, past offerings are included in the list"},{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1examOfferings~1{tenantId}~1exam~1{exam_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examOfferings/{tenantId}/exam/{exam_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"exam_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"includePastOfferings","in":"query","required":false,"schemaId":"schema_366"},{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examOfferings/{tenantId}/exam/{exam_id}","href":"exam-offerings/listofferingsbyexamid","openApiOperationId":"listOfferingsByExamId","summary":"Returns a list of records with the specified exam_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamOfferingsResponse"}},"schemaId":"components/schemas/ListExamOfferingsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examOfferings~1{tenantId}~1exam~1{exam_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExamOfferingsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamOfferingsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-offerings/listofferingsbyexamid"}],"panels":[]}]},"httpPath":"/examOfferings/{tenantId}/exam/{exam_id}"},{"label":"Returns a list of records with the specified exam_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-offerings/describeofferings","routeSlug":"/apis/certifications/certifications-v1/exam-offerings/describeofferings","metadata":{"seo":{"title":"Returns a list of records with the specified exam_id","description":"Returns a list of records with the specified exam_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"describeOfferings","name":"Returns a list of records with the specified exam_id","isWebhook":false,"pointer":"/paths/~1examOfferings~1{tenantId}~1portal~1{contact_id}~1describeForExam~1{exam_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified exam_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified exam_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"exam_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The exam_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1examOfferings~1{tenantId}~1portal~1{contact_id}~1describeForExam~1{exam_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1examOfferings~1{tenantId}~1portal~1{contact_id}~1describeForExam~1{exam_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examOfferings/{tenantId}/portal/{contact_id}/describeForExam/{exam_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_366"},{"name":"exam_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examOfferings/{tenantId}/portal/{contact_id}/describeForExam/{exam_id}","href":"exam-offerings/describeofferings","openApiOperationId":"describeOfferings","summary":"Returns a list of records with the specified exam_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamOfferingsResponse"}},"schemaId":"components/schemas/ListExamOfferingsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examOfferings~1{tenantId}~1portal~1{contact_id}~1describeForExam~1{exam_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExamOfferingsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamOfferingsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-offerings/describeofferings"}],"panels":[]}]},"httpPath":"/examOfferings/{tenantId}/portal/{contact_id}/describeForExam/{exam_id}"},{"label":"Searches for exam offerings using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-offerings/searchforexamofferings","routeSlug":"/apis/certifications/certifications-v1/exam-offerings/searchforexamofferings","metadata":{"seo":{"title":"Searches for exam offerings using predefined parameters","description":"Searches for exam offerings using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForExamOfferings","name":"Searches for exam offerings using predefined parameters","isWebhook":false,"pointer":"/paths/~1examOfferings~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for exam offerings using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for exam offerings using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1examOfferings~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_366","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1examOfferings~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamOfferingSearchParameters"}},"schemaId":"components/schemas/ExamOfferingSearchParameters","pointer":"/paths/~1examOfferings~1{tenantId}~1search/post/requestBody","description":"The exam offering that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examOfferings/{tenantId}/search","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExamOfferingSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examOfferings/{tenantId}/search","href":"exam-offerings/searchforexamofferings","openApiOperationId":"searchForExamOfferings","summary":"Searches for exam offerings using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExamOfferingSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamOfferingSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam offering search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedExamOfferingSearchResults"}},"schemaId":"components/schemas/PagedExamOfferingSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The exam offering you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam offering could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add exam offering based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examOfferings~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedExamOfferingSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedExamOfferingSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-offerings/searchforexamofferings"}],"panels":[]}]},"httpPath":"/examOfferings/{tenantId}/search"},{"label":"Returns a list of records with the specified testing_facility_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-offerings/listofferingsbytestingfacilityid","routeSlug":"/apis/certifications/certifications-v1/exam-offerings/listofferingsbytestingfacilityid","metadata":{"seo":{"title":"Returns a list of records with the specified testing_facility_id","description":"Returns a list of records with the specified testing_facility_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOfferingsByTestingFacilityId","name":"Returns a list of records with the specified testing_facility_id","isWebhook":false,"pointer":"/paths/~1examOfferings~1{tenantId}~1testingFacility~1{testing_facility_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified testing_facility_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified testing_facility_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"testing_facility_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The testing_facility_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1examOfferings~1{tenantId}~1testingFacility~1{testing_facility_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1examOfferings~1{tenantId}~1testingFacility~1{testing_facility_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examOfferings/{tenantId}/testingFacility/{testing_facility_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"testing_facility_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examOfferings/{tenantId}/testingFacility/{testing_facility_id}","href":"exam-offerings/listofferingsbytestingfacilityid","openApiOperationId":"listOfferingsByTestingFacilityId","summary":"Returns a list of records with the specified testing_facility_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamOfferingsResponse"}},"schemaId":"components/schemas/ListExamOfferingsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examOfferings~1{tenantId}~1testingFacility~1{testing_facility_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExamOfferingsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamOfferingsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-offerings/listofferingsbytestingfacilityid"}],"panels":[]}]},"httpPath":"/examOfferings/{tenantId}/testingFacility/{testing_facility_id}"},{"label":"Returns a exam offering from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-offerings/deleteexamoffering","routeSlug":"/apis/certifications/certifications-v1/exam-offerings/deleteexamoffering","metadata":{"seo":{"title":"Returns a exam offering from the system by its ID.","description":"This method will delete a exam offering with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteExamOffering","name":"Returns a exam offering from the system by its ID.","isWebhook":false,"pointer":"/paths/~1examOfferings~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a exam offering from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a exam offering with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam offering to delete.","required":true}],"pointer":"/paths/~1examOfferings~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/examOfferings/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examOfferings/{tenantId}/{id}","href":"exam-offerings/deleteexamoffering","openApiOperationId":"deleteExamOffering","summary":"Returns a exam offering from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam offering was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam offering could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam offering could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete exam offering based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examOfferings~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-offerings/deleteexamoffering"}],"panels":[]}]},"httpPath":"/examOfferings/{tenantId}/{id}"},{"label":"Returns a exam offering from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-offerings/getexamoffering","routeSlug":"/apis/certifications/certifications-v1/exam-offerings/getexamoffering","metadata":{"seo":{"title":"Returns a exam offering from the system by its ID.","description":"This method will look up a exam offering by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExamOffering","name":"Returns a exam offering from the system by its ID.","isWebhook":false,"pointer":"/paths/~1examOfferings~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a exam offering from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a exam offering by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam offering to return.","required":true}],"pointer":"/paths/~1examOfferings~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1examOfferings~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examOfferings/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examOfferings/{tenantId}/{id}","href":"exam-offerings/getexamoffering","openApiOperationId":"getExamOffering","summary":"Returns a exam offering from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam offering was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamOffering"}},"schemaId":"components/schemas/ExamOffering","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam offering could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam offering based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examOfferings~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamOffering","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamOffering"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-offerings/getexamoffering"}],"panels":[]}]},"httpPath":"/examOfferings/{tenantId}/{id}"},{"label":"Partially updates a exam offering with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-offerings/patchexamoffering","routeSlug":"/apis/certifications/certifications-v1/exam-offerings/patchexamoffering","metadata":{"seo":{"title":"Partially updates a exam offering with the specified ID.","description":"This method will patch an existing exam offering with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchExamOffering","name":"Partially updates a exam offering with the specified ID.","isWebhook":false,"pointer":"/paths/~1examOfferings~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a exam offering with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing exam offering with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam offering to patch.","required":true}],"pointer":"/paths/~1examOfferings~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1examOfferings~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/examOfferings/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examOfferings/{tenantId}/{id}","href":"exam-offerings/patchexamoffering","openApiOperationId":"patchExamOffering","summary":"Partially updates a exam offering with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam offering was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamOffering"}},"schemaId":"components/schemas/ExamOffering","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam offering could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam offering could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam offering based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examOfferings~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamOffering","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamOffering"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-offerings/patchexamoffering"}],"panels":[]}]},"httpPath":"/examOfferings/{tenantId}/{id}"},{"label":"Updates a exam offering with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-offerings/updateexamoffering","routeSlug":"/apis/certifications/certifications-v1/exam-offerings/updateexamoffering","metadata":{"seo":{"title":"Updates a exam offering with the specified ID.","description":"This method will update an existing exam offering with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateExamOffering","name":"Updates a exam offering with the specified ID.","isWebhook":false,"pointer":"/paths/~1examOfferings~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a exam offering with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing exam offering with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam offering to update.","required":true}],"pointer":"/paths/~1examOfferings~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamOffering"}},"schemaId":"components/schemas/ExamOffering","pointer":"/paths/~1examOfferings~1{tenantId}~1{id}/put/requestBody","description":"The updated exam offering that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/examOfferings/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExamOffering"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examOfferings/{tenantId}/{id}","href":"exam-offerings/updateexamoffering","openApiOperationId":"updateExamOffering","summary":"Updates a exam offering with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExamOffering","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamOffering"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam offering was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamOffering"}},"schemaId":"components/schemas/ExamOffering","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The exam offering supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam offering could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam offering could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam offering based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examOfferings~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamOffering","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamOffering"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-offerings/updateexamoffering"}],"panels":[]}]},"httpPath":"/examOfferings/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Exam Offerings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exam Offerings","showPageActions":true},{"nodeType":"markdoc","content":"Exam Offerings"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/examOfferings/{tenantId}","summary":"Creates a new exam offering record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-offerings/createexamoffering","deprecated":false},{"title":"/examOfferings/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-offerings/executebatchoperations","deprecated":false},{"title":"/examOfferings/{tenantId}/courseOffering/{course_offering_id}","summary":"Returns a list of records with the specified course_offering_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-offerings/listofferingsbycourseofferingid","deprecated":false},{"title":"/examOfferings/{tenantId}/exam/{exam_id}","summary":"Returns a list of records with the specified exam_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-offerings/listofferingsbyexamid","deprecated":false},{"title":"/examOfferings/{tenantId}/portal/{contact_id}/describeForExam/{exam_id}","summary":"Returns a list of records with the specified exam_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-offerings/describeofferings","deprecated":false},{"title":"/examOfferings/{tenantId}/search","summary":"Searches for exam offerings using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-offerings/searchforexamofferings","deprecated":false},{"title":"/examOfferings/{tenantId}/testingFacility/{testing_facility_id}","summary":"Returns a list of records with the specified testing_facility_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-offerings/listofferingsbytestingfacilityid","deprecated":false},{"title":"/examOfferings/{tenantId}/{id}","summary":"Returns a exam offering from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/exam-offerings/deleteexamoffering","deprecated":false},{"title":"/examOfferings/{tenantId}/{id}","summary":"Returns a exam offering from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-offerings/getexamoffering","deprecated":false},{"title":"/examOfferings/{tenantId}/{id}","summary":"Partially updates a exam offering with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/exam-offerings/patchexamoffering","deprecated":false},{"title":"/examOfferings/{tenantId}/{id}","summary":"Updates a exam offering with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/exam-offerings/updateexamoffering","deprecated":false}]}]}]}]}},{"type":"group","label":"Exam Reg Processes","link":"/apis/certifications/certifications-v1/exam-reg-processes","routeSlug":"/apis/certifications/certifications-v1/exam-reg-processes","items":[{"label":"Gets all of the exam reg processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-reg-processes/listexamregprocesses","routeSlug":"/apis/certifications/certifications-v1/exam-reg-processes/listexamregprocesses","metadata":{"seo":{"title":"Gets all of the exam reg processes in the system.","description":"This method will scan all exam reg processes and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listExamRegProcesses","name":"Gets all of the exam reg processes in the system.","isWebhook":false,"pointer":"/paths/~1examRegProcesses~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the exam reg processes in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all exam reg processes and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1examRegProcesses~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1examRegProcesses~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examRegProcesses/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegProcesses/{tenantId}","href":"exam-reg-processes/listexamregprocesses","openApiOperationId":"listExamRegProcesses","summary":"Gets all of the exam reg processes in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam reg processeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_393"}},"schemaId":"schema_393","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegProcesses~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_393","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_393"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-reg-processes/listexamregprocesses"}],"panels":[]}]},"httpPath":"/examRegProcesses/{tenantId}"},{"label":"Creates a new exam reg process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-reg-processes/createexamregprocess","routeSlug":"/apis/certifications/certifications-v1/exam-reg-processes/createexamregprocess","metadata":{"seo":{"title":"Creates a new exam reg process record that does not already exist.","description":"This method will auto-generate an ID and create a new exam reg process. If an ID is specified for the exam reg process, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createExamRegProcess","name":"Creates a new exam reg process record that does not already exist.","isWebhook":false,"pointer":"/paths/~1examRegProcesses~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new exam reg process record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new exam reg process. If an ID is specified for the exam reg process, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1examRegProcesses~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamRegProcess"}},"schemaId":"components/schemas/ExamRegProcess","pointer":"/paths/~1examRegProcesses~1{tenantId}/post/requestBody","description":"The exam reg process that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examRegProcesses/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExamRegProcess"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examRegProcesses/{tenantId}","href":"exam-reg-processes/createexamregprocess","openApiOperationId":"createExamRegProcess","summary":"Creates a new exam reg process record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExamRegProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamRegProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam reg process was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegProcess"}},"schemaId":"components/schemas/ExamRegProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The exam reg process you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam reg process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add exam reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegProcesses~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamRegProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-reg-processes/createexamregprocess"}],"panels":[]}]},"httpPath":"/examRegProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-reg-processes/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/exam-reg-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1examRegProcesses~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1examRegProcesses~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1examRegProcesses~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examRegProcesses/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegProcesses/{tenantId}/batch","href":"exam-reg-processes/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam reg process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegProcesses~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-reg-processes/executebatchoperations"}],"panels":[]}]},"httpPath":"/examRegProcesses/{tenantId}/batch"},{"label":"Gets all of the processes a contact is eligible to use","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-reg-processes/geteligibleprocesses","routeSlug":"/apis/certifications/certifications-v1/exam-reg-processes/geteligibleprocesses","metadata":{"seo":{"title":"Gets all of the processes a contact is eligible to use","description":"Gets all of the processes a contact is eligible to use"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEligibleProcesses","name":"Gets all of the processes a contact is eligible to use","isWebhook":false,"pointer":"/paths/~1examRegProcesses~1{tenantId}~1eligible~1{contactId}~1{examId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the processes a contact is eligible to use","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The contact id","required":true},{"name":"examId","in":"path","schemaId":"schema_366","description":"The exam id","required":true}],"pointer":"/paths/~1examRegProcesses~1{tenantId}~1eligible~1{contactId}~1{examId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examRegProcesses/{tenantId}/eligible/{contactId}/{examId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"},{"name":"examId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegProcesses/{tenantId}/eligible/{contactId}/{examId}","href":"exam-reg-processes/geteligibleprocesses","openApiOperationId":"getEligibleProcesses","summary":"Gets all of the processes a contact is eligible to use"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Processes were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EligibleExamRegProcessesResult"}},"schemaId":"components/schemas/EligibleExamRegProcessesResult","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegProcesses~1{tenantId}~1eligible~1{contactId}~1{examId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EligibleExamRegProcessesResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EligibleExamRegProcessesResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-reg-processes/geteligibleprocesses"}],"panels":[]}]},"httpPath":"/examRegProcesses/{tenantId}/eligible/{contactId}/{examId}"},{"label":"Returns a exam reg process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-reg-processes/deleteexamregprocess","routeSlug":"/apis/certifications/certifications-v1/exam-reg-processes/deleteexamregprocess","metadata":{"seo":{"title":"Returns a exam reg process from the system by its ID.","description":"This method will delete a exam reg process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteExamRegProcess","name":"Returns a exam reg process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1examRegProcesses~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a exam reg process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a exam reg process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam reg process to delete.","required":true}],"pointer":"/paths/~1examRegProcesses~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/examRegProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examRegProcesses/{tenantId}/{id}","href":"exam-reg-processes/deleteexamregprocess","openApiOperationId":"deleteExamRegProcess","summary":"Returns a exam reg process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam reg process was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam reg process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam reg process could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete exam reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegProcesses~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-reg-processes/deleteexamregprocess"}],"panels":[]}]},"httpPath":"/examRegProcesses/{tenantId}/{id}"},{"label":"Returns a exam reg process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-reg-processes/getexamregprocess","routeSlug":"/apis/certifications/certifications-v1/exam-reg-processes/getexamregprocess","metadata":{"seo":{"title":"Returns a exam reg process from the system by its ID.","description":"This method will look up a exam reg process by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExamRegProcess","name":"Returns a exam reg process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1examRegProcesses~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a exam reg process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a exam reg process by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam reg process to return.","required":true}],"pointer":"/paths/~1examRegProcesses~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1examRegProcesses~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examRegProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegProcesses/{tenantId}/{id}","href":"exam-reg-processes/getexamregprocess","openApiOperationId":"getExamRegProcess","summary":"Returns a exam reg process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam reg process was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegProcess"}},"schemaId":"components/schemas/ExamRegProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam reg process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegProcesses~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamRegProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-reg-processes/getexamregprocess"}],"panels":[]}]},"httpPath":"/examRegProcesses/{tenantId}/{id}"},{"label":"Partially updates a exam reg process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-reg-processes/patchexamregprocess","routeSlug":"/apis/certifications/certifications-v1/exam-reg-processes/patchexamregprocess","metadata":{"seo":{"title":"Partially updates a exam reg process with the specified ID.","description":"This method will patch an existing exam reg process with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchExamRegProcess","name":"Partially updates a exam reg process with the specified ID.","isWebhook":false,"pointer":"/paths/~1examRegProcesses~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a exam reg process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing exam reg process with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam reg process to patch.","required":true}],"pointer":"/paths/~1examRegProcesses~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1examRegProcesses~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/examRegProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examRegProcesses/{tenantId}/{id}","href":"exam-reg-processes/patchexamregprocess","openApiOperationId":"patchExamRegProcess","summary":"Partially updates a exam reg process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam reg process was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegProcess"}},"schemaId":"components/schemas/ExamRegProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam reg process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam reg process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegProcesses~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamRegProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-reg-processes/patchexamregprocess"}],"panels":[]}]},"httpPath":"/examRegProcesses/{tenantId}/{id}"},{"label":"Updates a exam reg process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-reg-processes/updateexamregprocess","routeSlug":"/apis/certifications/certifications-v1/exam-reg-processes/updateexamregprocess","metadata":{"seo":{"title":"Updates a exam reg process with the specified ID.","description":"This method will update an existing exam reg process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateExamRegProcess","name":"Updates a exam reg process with the specified ID.","isWebhook":false,"pointer":"/paths/~1examRegProcesses~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a exam reg process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing exam reg process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam reg process to update.","required":true}],"pointer":"/paths/~1examRegProcesses~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamRegProcess"}},"schemaId":"components/schemas/ExamRegProcess","pointer":"/paths/~1examRegProcesses~1{tenantId}~1{id}/put/requestBody","description":"The updated exam reg process that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/examRegProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExamRegProcess"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examRegProcesses/{tenantId}/{id}","href":"exam-reg-processes/updateexamregprocess","openApiOperationId":"updateExamRegProcess","summary":"Updates a exam reg process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExamRegProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamRegProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam reg process was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegProcess"}},"schemaId":"components/schemas/ExamRegProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The exam reg process supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam reg process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam reg process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam reg process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegProcesses~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamRegProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-reg-processes/updateexamregprocess"}],"panels":[]}]},"httpPath":"/examRegProcesses/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Exam Reg Processes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exam Reg Processes","showPageActions":true},{"nodeType":"markdoc","content":"Exam Reg Processes"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/examRegProcesses/{tenantId}","summary":"Gets all of the exam reg processes in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-reg-processes/listexamregprocesses","deprecated":false},{"title":"/examRegProcesses/{tenantId}","summary":"Creates a new exam reg process record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-reg-processes/createexamregprocess","deprecated":false},{"title":"/examRegProcesses/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-reg-processes/executebatchoperations","deprecated":false},{"title":"/examRegProcesses/{tenantId}/eligible/{contactId}/{examId}","summary":"Gets all of the processes a contact is eligible to use","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-reg-processes/geteligibleprocesses","deprecated":false},{"title":"/examRegProcesses/{tenantId}/{id}","summary":"Returns a exam reg process from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/exam-reg-processes/deleteexamregprocess","deprecated":false},{"title":"/examRegProcesses/{tenantId}/{id}","summary":"Returns a exam reg process from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-reg-processes/getexamregprocess","deprecated":false},{"title":"/examRegProcesses/{tenantId}/{id}","summary":"Partially updates a exam reg process with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/exam-reg-processes/patchexamregprocess","deprecated":false},{"title":"/examRegProcesses/{tenantId}/{id}","summary":"Updates a exam reg process with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/exam-reg-processes/updateexamregprocess","deprecated":false}]}]}]}]}},{"type":"group","label":"Exam Registrations","link":"/apis/certifications/certifications-v1/exam-registrations","routeSlug":"/apis/certifications/certifications-v1/exam-registrations","items":[{"label":"Gets all of the exam registrations in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/listexamregistrations","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/listexamregistrations","metadata":{"seo":{"title":"Gets all of the exam registrations in the system.","description":"This method will scan all exam registrations and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listExamRegistrations","name":"Gets all of the exam registrations in the system.","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the exam registrations in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all exam registrations and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1examRegistrations~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examRegistrations/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegistrations/{tenantId}","href":"exam-registrations/listexamregistrations","openApiOperationId":"listExamRegistrations","summary":"Gets all of the exam registrations in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam registrationswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_394"}},"schemaId":"schema_394","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_394","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_394"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/listexamregistrations"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}"},{"label":"Creates a new exam registration record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/createexamregistration","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/createexamregistration","metadata":{"seo":{"title":"Creates a new exam registration record that does not already exist.","description":"This method will auto-generate an ID and create a new exam registration. If an ID is specified for the exam registration, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createExamRegistration","name":"Creates a new exam registration record that does not already exist.","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new exam registration record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new exam registration. If an ID is specified for the exam registration, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}},"schemaId":"components/schemas/ExamRegistration","pointer":"/paths/~1examRegistrations~1{tenantId}/post/requestBody","description":"The exam registration that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examRegistrations/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examRegistrations/{tenantId}","href":"exam-registrations/createexamregistration","openApiOperationId":"createExamRegistration","summary":"Creates a new exam registration record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExamRegistration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam registration was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}},"schemaId":"components/schemas/ExamRegistration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The exam registration you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam registration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add exam registration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamRegistration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/createexamregistration"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}"},{"label":"Returns a list of records with the specified application_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/listregistrationsbyapplicationid","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/listregistrationsbyapplicationid","metadata":{"seo":{"title":"Returns a list of records with the specified application_id","description":"Returns a list of records with the specified application_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRegistrationsByApplicationId","name":"Returns a list of records with the specified application_id","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}~1application~1{application_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified application_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified application_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"application_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The application_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1application~1{application_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1application~1{application_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examRegistrations/{tenantId}/application/{application_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegistrations/{tenantId}/application/{application_id}","href":"exam-registrations/listregistrationsbyapplicationid","openApiOperationId":"listRegistrationsByApplicationId","summary":"Returns a list of records with the specified application_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamRegistrationsResponse"}},"schemaId":"components/schemas/ListExamRegistrationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1application~1{application_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExamRegistrationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamRegistrationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/listregistrationsbyapplicationid"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}/application/{application_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1examRegistrations~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examRegistrations/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegistrations/{tenantId}/batch","href":"exam-registrations/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam registration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam registration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/executebatchoperations"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}/batch"},{"label":"Returns a list of records with the specified course_registration_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/listregistrationsbycourseregistrationid","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/listregistrationsbycourseregistrationid","metadata":{"seo":{"title":"Returns a list of records with the specified course_registration_id","description":"Returns a list of records with the specified course_registration_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRegistrationsByCourseRegistrationId","name":"Returns a list of records with the specified course_registration_id","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}~1courseRegistration~1{course_registration_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified course_registration_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified course_registration_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"course_registration_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The course_registration_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1courseRegistration~1{course_registration_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1courseRegistration~1{course_registration_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examRegistrations/{tenantId}/courseRegistration/{course_registration_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"course_registration_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegistrations/{tenantId}/courseRegistration/{course_registration_id}","href":"exam-registrations/listregistrationsbycourseregistrationid","openApiOperationId":"listRegistrationsByCourseRegistrationId","summary":"Returns a list of records with the specified course_registration_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamRegistrationsResponse"}},"schemaId":"components/schemas/ListExamRegistrationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1courseRegistration~1{course_registration_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExamRegistrationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamRegistrationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/listregistrationsbycourseregistrationid"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}/courseRegistration/{course_registration_id}"},{"label":"Returns a list of records with the specified exam_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/listregistrationsbyexamid","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/listregistrationsbyexamid","metadata":{"seo":{"title":"Returns a list of records with the specified exam_id","description":"Returns a list of records with the specified exam_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRegistrationsByExamId","name":"Returns a list of records with the specified exam_id","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}~1exam~1{exam_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified exam_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified exam_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"exam_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The exam_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1exam~1{exam_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1exam~1{exam_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examRegistrations/{tenantId}/exam/{exam_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"exam_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegistrations/{tenantId}/exam/{exam_id}","href":"exam-registrations/listregistrationsbyexamid","openApiOperationId":"listRegistrationsByExamId","summary":"Returns a list of records with the specified exam_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamRegistrationsResponse"}},"schemaId":"components/schemas/ListExamRegistrationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1exam~1{exam_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExamRegistrationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamRegistrationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/listregistrationsbyexamid"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}/exam/{exam_id}"},{"label":"Returns a list of records with the specified exam_offering_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/listregistrationsbyexamofferingid","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/listregistrationsbyexamofferingid","metadata":{"seo":{"title":"Returns a list of records with the specified exam_offering_id","description":"Returns a list of records with the specified exam_offering_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRegistrationsByExamOfferingId","name":"Returns a list of records with the specified exam_offering_id","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}~1examOffering~1{exam_offering_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified exam_offering_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified exam_offering_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"exam_offering_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The exam_offering_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1examOffering~1{exam_offering_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1examOffering~1{exam_offering_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examRegistrations/{tenantId}/examOffering/{exam_offering_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"exam_offering_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegistrations/{tenantId}/examOffering/{exam_offering_id}","href":"exam-registrations/listregistrationsbyexamofferingid","openApiOperationId":"listRegistrationsByExamOfferingId","summary":"Returns a list of records with the specified exam_offering_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamRegistrationsResponse"}},"schemaId":"components/schemas/ListExamRegistrationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1examOffering~1{exam_offering_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExamRegistrationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamRegistrationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/listregistrationsbyexamofferingid"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}/examOffering/{exam_offering_id}"},{"label":"Generates an order from a membership registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/generateorder","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/generateorder","metadata":{"seo":{"title":"Generates an order from a membership registration","description":"This method will examine a cert exam reg and generate an appropriate order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateOrder","name":"Generates an order from a membership registration","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}~1generateOrder/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates an order from a membership registration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will examine a cert exam reg and generate an appropriate order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1generateOrder/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}},"schemaId":"components/schemas/ExamRegistration","pointer":"/paths/~1examRegistrations~1{tenantId}~1generateOrder/post/requestBody","description":"The registration to generate an order"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examRegistrations/{tenantId}/generateOrder","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegistrations/{tenantId}/generateOrder","href":"exam-registrations/generateorder","openApiOperationId":"generateOrder","summary":"Generates an order from a membership registration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExamRegistration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1generateOrder/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/generateorder"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}/generateOrder"},{"label":"Generates an registration for a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/generateregistration","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/generateregistration","metadata":{"seo":{"title":"Generates an registration for a contact","description":"Generates an registration for a contact"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateRegistration","name":"Generates an registration for a contact","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}~1generateRegistration~1{processId}~1{contactId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates an registration for a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true},{"name":"processId","in":"path","schemaId":"schema_366","description":"The process id","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The contact contact","required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1generateRegistration~1{processId}~1{contactId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examRegistrations/{tenantId}/generateRegistration/{processId}/{contactId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"processId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegistrations/{tenantId}/generateRegistration/{processId}/{contactId}","href":"exam-registrations/generateregistration","openApiOperationId":"generateRegistration","summary":"Generates an registration for a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}},"schemaId":"components/schemas/ExamRegistration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1generateRegistration~1{processId}~1{contactId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamRegistration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/generateregistration"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}/generateRegistration/{processId}/{contactId}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/previewemail","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewEmail","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}~1previewEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the CRC notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the CRC notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1previewEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"schemaId":"components/schemas/PreviewEmailRequest","pointer":"/paths/~1examRegistrations~1{tenantId}~1previewEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examRegistrations/{tenantId}/previewEmail","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegistrations/{tenantId}/previewEmail","href":"exam-registrations/previewemail","openApiOperationId":"previewEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1previewEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/previewemail"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}/previewEmail"},{"label":"Searches for exam registrations using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/searchforexamregistrations","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/searchforexamregistrations","metadata":{"seo":{"title":"Searches for exam registrations using predefined parameters","description":"Searches for exam registrations using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForExamRegistrations","name":"Searches for exam registrations using predefined parameters","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for exam registrations using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for exam registrations using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_366","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamRegistrationSearchParameters"}},"schemaId":"components/schemas/ExamRegistrationSearchParameters","pointer":"/paths/~1examRegistrations~1{tenantId}~1search/post/requestBody","description":"The exam registration that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examRegistrations/{tenantId}/search","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExamRegistrationSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examRegistrations/{tenantId}/search","href":"exam-registrations/searchforexamregistrations","openApiOperationId":"searchForExamRegistrations","summary":"Searches for exam registrations using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExamRegistrationSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamRegistrationSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam registration search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedExamRegistrationSearchResults"}},"schemaId":"components/schemas/PagedExamRegistrationSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The exam registration you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam registration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add exam registration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedExamRegistrationSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedExamRegistrationSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/searchforexamregistrations"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}/search"},{"label":"Send an exam notice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/sendexamnotice","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/sendexamnotice","metadata":{"seo":{"title":"Send an exam notice","description":"This will send an exam notice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendExamNotice","name":"Send an exam notice","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}~1sendNotice~1{id}~1{noticeId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send an exam notice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This will send an exam notice"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The exam registration","required":true},{"name":"noticeId","in":"path","schemaId":"schema_366","description":"The exam notice","required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1sendNotice~1{id}~1{noticeId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examRegistrations/{tenantId}/sendNotice/{id}/{noticeId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"},{"name":"noticeId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegistrations/{tenantId}/sendNotice/{id}/{noticeId}","href":"exam-registrations/sendexamnotice","openApiOperationId":"sendExamNotice","summary":"Send an exam notice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1sendNotice~1{id}~1{noticeId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/sendexamnotice"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}/sendNotice/{id}/{noticeId}"},{"label":"Returns a list of records with the specified student_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/listregistrationsbystudentid","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/listregistrationsbystudentid","metadata":{"seo":{"title":"Returns a list of records with the specified student_id","description":"Returns a list of records with the specified student_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRegistrationsByStudentId","name":"Returns a list of records with the specified student_id","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}~1student~1{student_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified student_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified student_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"student_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The student_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1student~1{student_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1student~1{student_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examRegistrations/{tenantId}/student/{student_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"student_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegistrations/{tenantId}/student/{student_id}","href":"exam-registrations/listregistrationsbystudentid","openApiOperationId":"listRegistrationsByStudentId","summary":"Returns a list of records with the specified student_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamRegistrationsResponse"}},"schemaId":"components/schemas/ListExamRegistrationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1student~1{student_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExamRegistrationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamRegistrationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/listregistrationsbystudentid"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}/student/{student_id}"},{"label":"Returns a list of records with the specified student_exam_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/listregistrationsbystudentidandexamid","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/listregistrationsbystudentidandexamid","metadata":{"seo":{"title":"Returns a list of records with the specified student_exam_id","description":"Returns a list of records with the specified student_exam_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRegistrationsByStudentIdAndExamId","name":"Returns a list of records with the specified student_exam_id","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}~1studentExam~1{student_id}~1{exam_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified student_exam_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified student_exam_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"student_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The student_exam_id to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"exam_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The student_exam_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1studentExam~1{student_id}~1{exam_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1studentExam~1{student_id}~1{exam_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examRegistrations/{tenantId}/studentExam/{student_id}/{exam_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"student_id","in":"path","required":true,"schemaId":"schema_366"},{"name":"exam_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegistrations/{tenantId}/studentExam/{student_id}/{exam_id}","href":"exam-registrations/listregistrationsbystudentidandexamid","openApiOperationId":"listRegistrationsByStudentIdAndExamId","summary":"Returns a list of records with the specified student_exam_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamRegistrationsResponse"}},"schemaId":"components/schemas/ListExamRegistrationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1studentExam~1{student_id}~1{exam_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExamRegistrationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExamRegistrationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/listregistrationsbystudentidandexamid"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}/studentExam/{student_id}/{exam_id}"},{"label":"Returns a exam registration from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/deleteexamregistration","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/deleteexamregistration","metadata":{"seo":{"title":"Returns a exam registration from the system by its ID.","description":"This method will delete a exam registration with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteExamRegistration","name":"Returns a exam registration from the system by its ID.","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a exam registration from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a exam registration with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam registration to delete.","required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/examRegistrations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examRegistrations/{tenantId}/{id}","href":"exam-registrations/deleteexamregistration","openApiOperationId":"deleteExamRegistration","summary":"Returns a exam registration from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam registration was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam registration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam registration could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete exam registration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/deleteexamregistration"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}/{id}"},{"label":"Returns a exam registration from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/getexamregistration","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/getexamregistration","metadata":{"seo":{"title":"Returns a exam registration from the system by its ID.","description":"This method will look up a exam registration by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExamRegistration","name":"Returns a exam registration from the system by its ID.","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a exam registration from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a exam registration by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam registration to return.","required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examRegistrations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examRegistrations/{tenantId}/{id}","href":"exam-registrations/getexamregistration","openApiOperationId":"getExamRegistration","summary":"Returns a exam registration from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam registration was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}},"schemaId":"components/schemas/ExamRegistration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam registration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam registration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamRegistration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/getexamregistration"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}/{id}"},{"label":"Partially updates a exam registration with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/patchexamregistration","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/patchexamregistration","metadata":{"seo":{"title":"Partially updates a exam registration with the specified ID.","description":"This method will patch an existing exam registration with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchExamRegistration","name":"Partially updates a exam registration with the specified ID.","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a exam registration with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing exam registration with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam registration to patch.","required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1examRegistrations~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/examRegistrations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examRegistrations/{tenantId}/{id}","href":"exam-registrations/patchexamregistration","openApiOperationId":"patchExamRegistration","summary":"Partially updates a exam registration with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam registration was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}},"schemaId":"components/schemas/ExamRegistration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam registration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam registration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam registration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamRegistration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/patchexamregistration"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}/{id}"},{"label":"Updates a exam registration with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-registrations/updateexamregistration","routeSlug":"/apis/certifications/certifications-v1/exam-registrations/updateexamregistration","metadata":{"seo":{"title":"Updates a exam registration with the specified ID.","description":"This method will update an existing exam registration with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateExamRegistration","name":"Updates a exam registration with the specified ID.","isWebhook":false,"pointer":"/paths/~1examRegistrations~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a exam registration with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing exam registration with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam registration to update.","required":true}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}},"schemaId":"components/schemas/ExamRegistration","pointer":"/paths/~1examRegistrations~1{tenantId}~1{id}/put/requestBody","description":"The updated exam registration that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/examRegistrations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examRegistrations/{tenantId}/{id}","href":"exam-registrations/updateexamregistration","openApiOperationId":"updateExamRegistration","summary":"Updates a exam registration with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExamRegistration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam registration was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}},"schemaId":"components/schemas/ExamRegistration","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The exam registration supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam registration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam registration could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam registration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examRegistrations~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamRegistration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamRegistration"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-registrations/updateexamregistration"}],"panels":[]}]},"httpPath":"/examRegistrations/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Exam Registrations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exam Registrations","showPageActions":true},{"nodeType":"markdoc","content":"Exam Registrations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/examRegistrations/{tenantId}","summary":"Gets all of the exam registrations in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-registrations/listexamregistrations","deprecated":false},{"title":"/examRegistrations/{tenantId}","summary":"Creates a new exam registration record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-registrations/createexamregistration","deprecated":false},{"title":"/examRegistrations/{tenantId}/application/{application_id}","summary":"Returns a list of records with the specified application_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-registrations/listregistrationsbyapplicationid","deprecated":false},{"title":"/examRegistrations/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-registrations/executebatchoperations","deprecated":false},{"title":"/examRegistrations/{tenantId}/courseRegistration/{course_registration_id}","summary":"Returns a list of records with the specified course_registration_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-registrations/listregistrationsbycourseregistrationid","deprecated":false},{"title":"/examRegistrations/{tenantId}/exam/{exam_id}","summary":"Returns a list of records with the specified exam_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-registrations/listregistrationsbyexamid","deprecated":false},{"title":"/examRegistrations/{tenantId}/examOffering/{exam_offering_id}","summary":"Returns a list of records with the specified exam_offering_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-registrations/listregistrationsbyexamofferingid","deprecated":false},{"title":"/examRegistrations/{tenantId}/generateOrder","summary":"Generates an order from a membership registration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-registrations/generateorder","deprecated":false},{"title":"/examRegistrations/{tenantId}/generateRegistration/{processId}/{contactId}","summary":"Generates an registration for a contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-registrations/generateregistration","deprecated":false},{"title":"/examRegistrations/{tenantId}/previewEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-registrations/previewemail","deprecated":false},{"title":"/examRegistrations/{tenantId}/search","summary":"Searches for exam registrations using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-registrations/searchforexamregistrations","deprecated":false},{"title":"/examRegistrations/{tenantId}/sendNotice/{id}/{noticeId}","summary":"Send an exam notice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-registrations/sendexamnotice","deprecated":false},{"title":"/examRegistrations/{tenantId}/student/{student_id}","summary":"Returns a list of records with the specified student_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-registrations/listregistrationsbystudentid","deprecated":false},{"title":"/examRegistrations/{tenantId}/studentExam/{student_id}/{exam_id}","summary":"Returns a list of records with the specified student_exam_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-registrations/listregistrationsbystudentidandexamid","deprecated":false},{"title":"/examRegistrations/{tenantId}/{id}","summary":"Returns a exam registration from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/exam-registrations/deleteexamregistration","deprecated":false},{"title":"/examRegistrations/{tenantId}/{id}","summary":"Returns a exam registration from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-registrations/getexamregistration","deprecated":false},{"title":"/examRegistrations/{tenantId}/{id}","summary":"Partially updates a exam registration with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/exam-registrations/patchexamregistration","deprecated":false},{"title":"/examRegistrations/{tenantId}/{id}","summary":"Updates a exam registration with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/exam-registrations/updateexamregistration","deprecated":false}]}]}]}]}},{"type":"group","label":"Exam Sites","link":"/apis/certifications/certifications-v1/exam-sites","routeSlug":"/apis/certifications/certifications-v1/exam-sites","items":[{"label":"Creates a new exam site record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-sites/createexamsite","routeSlug":"/apis/certifications/certifications-v1/exam-sites/createexamsite","metadata":{"seo":{"title":"Creates a new exam site record that does not already exist.","description":"This method will auto-generate an ID and create a new exam site. If an ID is specified for the exam site, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createExamSite","name":"Creates a new exam site record that does not already exist.","isWebhook":false,"pointer":"/paths/~1examSites~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new exam site record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new exam site. If an ID is specified for the exam site, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1examSites~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamSite"}},"schemaId":"components/schemas/ExamSite","pointer":"/paths/~1examSites~1{tenantId}/post/requestBody","description":"The exam site that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/examSites/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExamSite"}},"responseCodes":["200","400","401","403","409","429","500"],"pointer":"/examSites/{tenantId}","href":"exam-sites/createexamsite","openApiOperationId":"createExamSite","summary":"Creates a new exam site record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExamSite","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamSite"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam site was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamSite"}},"schemaId":"components/schemas/ExamSite","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The exam site you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam site could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add exam site based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examSites~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamSite","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamSite"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-sites/createexamsite"}],"panels":[]}]},"httpPath":"/examSites/{tenantId}"},{"label":"Returns a exam site from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-sites/deleteexamsite","routeSlug":"/apis/certifications/certifications-v1/exam-sites/deleteexamsite","metadata":{"seo":{"title":"Returns a exam site from the system by its ID.","description":"This method will delete a exam site with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteExamSite","name":"Returns a exam site from the system by its ID.","isWebhook":false,"pointer":"/paths/~1examSites~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a exam site from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a exam site with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam site to delete.","required":true}],"pointer":"/paths/~1examSites~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/examSites/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examSites/{tenantId}/{id}","href":"exam-sites/deleteexamsite","openApiOperationId":"deleteExamSite","summary":"Returns a exam site from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam site was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam site could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam site could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete exam site based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examSites~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-sites/deleteexamsite"}],"panels":[]}]},"httpPath":"/examSites/{tenantId}/{id}"},{"label":"Returns a exam site from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-sites/getexamsite","routeSlug":"/apis/certifications/certifications-v1/exam-sites/getexamsite","metadata":{"seo":{"title":"Returns a exam site from the system by its ID.","description":"This method will look up a exam site by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExamSite","name":"Returns a exam site from the system by its ID.","isWebhook":false,"pointer":"/paths/~1examSites~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a exam site from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a exam site by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam site to return.","required":true}],"pointer":"/paths/~1examSites~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1examSites~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/examSites/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/examSites/{tenantId}/{id}","href":"exam-sites/getexamsite","openApiOperationId":"getExamSite","summary":"Returns a exam site from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam site was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamSite"}},"schemaId":"components/schemas/ExamSite","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam site could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam site based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examSites~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamSite","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamSite"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-sites/getexamsite"}],"panels":[]}]},"httpPath":"/examSites/{tenantId}/{id}"},{"label":"Partially updates a exam site with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-sites/patchexamsite","routeSlug":"/apis/certifications/certifications-v1/exam-sites/patchexamsite","metadata":{"seo":{"title":"Partially updates a exam site with the specified ID.","description":"This method will patch an existing exam site with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchExamSite","name":"Partially updates a exam site with the specified ID.","isWebhook":false,"pointer":"/paths/~1examSites~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a exam site with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing exam site with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam site to patch.","required":true}],"pointer":"/paths/~1examSites~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1examSites~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/examSites/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examSites/{tenantId}/{id}","href":"exam-sites/patchexamsite","openApiOperationId":"patchExamSite","summary":"Partially updates a exam site with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam site was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamSite"}},"schemaId":"components/schemas/ExamSite","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam site could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam site could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam site based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examSites~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamSite","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamSite"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-sites/patchexamsite"}],"panels":[]}]},"httpPath":"/examSites/{tenantId}/{id}"},{"label":"Updates a exam site with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exam-sites/updateexamsite","routeSlug":"/apis/certifications/certifications-v1/exam-sites/updateexamsite","metadata":{"seo":{"title":"Updates a exam site with the specified ID.","description":"This method will update an existing exam site with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateExamSite","name":"Updates a exam site with the specified ID.","isWebhook":false,"pointer":"/paths/~1examSites~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a exam site with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing exam site with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam site to update.","required":true}],"pointer":"/paths/~1examSites~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamSite"}},"schemaId":"components/schemas/ExamSite","pointer":"/paths/~1examSites~1{tenantId}~1{id}/put/requestBody","description":"The updated exam site that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/examSites/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExamSite"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/examSites/{tenantId}/{id}","href":"exam-sites/updateexamsite","openApiOperationId":"updateExamSite","summary":"Updates a exam site with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExamSite","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExamSite"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam site was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamSite"}},"schemaId":"components/schemas/ExamSite","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The exam site supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam site could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam site could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam site based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1examSites~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExamSite","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExamSite"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-sites/updateexamsite"}],"panels":[]}]},"httpPath":"/examSites/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Exam Sites"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exam Sites","showPageActions":true},{"nodeType":"markdoc","content":"Exam Sites"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/examSites/{tenantId}","summary":"Creates a new exam site record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exam-sites/createexamsite","deprecated":false},{"title":"/examSites/{tenantId}/{id}","summary":"Returns a exam site from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/exam-sites/deleteexamsite","deprecated":false},{"title":"/examSites/{tenantId}/{id}","summary":"Returns a exam site from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-sites/getexamsite","deprecated":false},{"title":"/examSites/{tenantId}/{id}","summary":"Partially updates a exam site with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/exam-sites/patchexamsite","deprecated":false},{"title":"/examSites/{tenantId}/{id}","summary":"Updates a exam site with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/exam-sites/updateexamsite","deprecated":false}]}]}]}]}},{"type":"group","label":"Exams","link":"/apis/certifications/certifications-v1/exams","routeSlug":"/apis/certifications/certifications-v1/exams","items":[{"label":"Gets all of the exams in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exams/listexams","routeSlug":"/apis/certifications/certifications-v1/exams/listexams","metadata":{"seo":{"title":"Gets all of the exams in the system.","description":"This method will scan all exams and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listExams","name":"Gets all of the exams in the system.","isWebhook":false,"pointer":"/paths/~1exams~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the exams in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all exams and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1exams~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1exams~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/exams/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/exams/{tenantId}","href":"exams/listexams","openApiOperationId":"listExams","summary":"Gets all of the exams in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The examswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_395"}},"schemaId":"schema_395","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1exams~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_395","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_395"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exams/listexams"}],"panels":[]}]},"httpPath":"/exams/{tenantId}"},{"label":"Creates a new exam record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exams/createexam","routeSlug":"/apis/certifications/certifications-v1/exams/createexam","metadata":{"seo":{"title":"Creates a new exam record that does not already exist.","description":"This method will auto-generate an ID and create a new exam. If an ID is specified for the exam, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createExam","name":"Creates a new exam record that does not already exist.","isWebhook":false,"pointer":"/paths/~1exams~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new exam record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new exam. If an ID is specified for the exam, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1exams~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Exam"}},"schemaId":"components/schemas/Exam","pointer":"/paths/~1exams~1{tenantId}/post/requestBody","description":"The exam that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/exams/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Exam"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/exams/{tenantId}","href":"exams/createexam","openApiOperationId":"createExam","summary":"Creates a new exam record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Exam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Exam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Exam"}},"schemaId":"components/schemas/Exam","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The exam you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add exam based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1exams~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Exam","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Exam"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exams/createexam"}],"panels":[]}]},"httpPath":"/exams/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exams/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/exams/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1exams~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1exams~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1exams~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/exams/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/exams/{tenantId}/batch","href":"exams/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1exams~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exams/executebatchoperations"}],"panels":[]}]},"httpPath":"/exams/{tenantId}/batch"},{"label":"Returns a exam from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exams/deleteexam","routeSlug":"/apis/certifications/certifications-v1/exams/deleteexam","metadata":{"seo":{"title":"Returns a exam from the system by its ID.","description":"This method will delete a exam with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteExam","name":"Returns a exam from the system by its ID.","isWebhook":false,"pointer":"/paths/~1exams~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a exam from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a exam with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam to delete.","required":true}],"pointer":"/paths/~1exams~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/exams/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/exams/{tenantId}/{id}","href":"exams/deleteexam","openApiOperationId":"deleteExam","summary":"Returns a exam from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete exam based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1exams~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exams/deleteexam"}],"panels":[]}]},"httpPath":"/exams/{tenantId}/{id}"},{"label":"Returns a exam from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exams/getexam","routeSlug":"/apis/certifications/certifications-v1/exams/getexam","metadata":{"seo":{"title":"Returns a exam from the system by its ID.","description":"This method will look up a exam by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExam","name":"Returns a exam from the system by its ID.","isWebhook":false,"pointer":"/paths/~1exams~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a exam from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a exam by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam to return.","required":true}],"pointer":"/paths/~1exams~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1exams~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/exams/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/exams/{tenantId}/{id}","href":"exams/getexam","openApiOperationId":"getExam","summary":"Returns a exam from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Exam"}},"schemaId":"components/schemas/Exam","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1exams~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Exam","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Exam"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exams/getexam"}],"panels":[]}]},"httpPath":"/exams/{tenantId}/{id}"},{"label":"Partially updates a exam with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exams/patchexam","routeSlug":"/apis/certifications/certifications-v1/exams/patchexam","metadata":{"seo":{"title":"Partially updates a exam with the specified ID.","description":"This method will patch an existing exam with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchExam","name":"Partially updates a exam with the specified ID.","isWebhook":false,"pointer":"/paths/~1exams~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a exam with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing exam with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam to patch.","required":true}],"pointer":"/paths/~1exams~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1exams~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/exams/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/exams/{tenantId}/{id}","href":"exams/patchexam","openApiOperationId":"patchExam","summary":"Partially updates a exam with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Exam"}},"schemaId":"components/schemas/Exam","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1exams~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Exam","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Exam"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exams/patchexam"}],"panels":[]}]},"httpPath":"/exams/{tenantId}/{id}"},{"label":"Updates a exam with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/exams/updateexam","routeSlug":"/apis/certifications/certifications-v1/exams/updateexam","metadata":{"seo":{"title":"Updates a exam with the specified ID.","description":"This method will update an existing exam with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateExam","name":"Updates a exam with the specified ID.","isWebhook":false,"pointer":"/paths/~1exams~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a exam with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing exam with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the exam to update.","required":true}],"pointer":"/paths/~1exams~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Exam"}},"schemaId":"components/schemas/Exam","pointer":"/paths/~1exams~1{tenantId}~1{id}/put/requestBody","description":"The updated exam that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/exams/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Exam"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/exams/{tenantId}/{id}","href":"exams/updateexam","openApiOperationId":"updateExam","summary":"Updates a exam with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Exam","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Exam"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exam was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Exam"}},"schemaId":"components/schemas/Exam","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The exam supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The exam could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The exam could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve exam based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1exams~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Exam","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Exam"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exams/updateexam"}],"panels":[]}]},"httpPath":"/exams/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Exams"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exams","showPageActions":true},{"nodeType":"markdoc","content":"Exams"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/exams/{tenantId}","summary":"Gets all of the exams in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exams/listexams","deprecated":false},{"title":"/exams/{tenantId}","summary":"Creates a new exam record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exams/createexam","deprecated":false},{"title":"/exams/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exams/executebatchoperations","deprecated":false},{"title":"/exams/{tenantId}/{id}","summary":"Returns a exam from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/exams/deleteexam","deprecated":false},{"title":"/exams/{tenantId}/{id}","summary":"Returns a exam from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exams/getexam","deprecated":false},{"title":"/exams/{tenantId}/{id}","summary":"Partially updates a exam with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/exams/patchexam","deprecated":false},{"title":"/exams/{tenantId}/{id}","summary":"Updates a exam with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/exams/updateexam","deprecated":false}]}]}]}]}},{"type":"group","label":"Expiration Rule Sets","link":"/apis/certifications/certifications-v1/expiration-rule-sets","routeSlug":"/apis/certifications/certifications-v1/expiration-rule-sets","items":[{"label":"Gets all of the expiration rule sets in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/expiration-rule-sets/listexpirationrulesets","routeSlug":"/apis/certifications/certifications-v1/expiration-rule-sets/listexpirationrulesets","metadata":{"seo":{"title":"Gets all of the expiration rule sets in the system.","description":"This method will scan all expiration rule sets and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listExpirationRuleSets","name":"Gets all of the expiration rule sets in the system.","isWebhook":false,"pointer":"/paths/~1expirationRuleSets~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the expiration rule sets in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all expiration rule sets and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1expirationRuleSets~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1expirationRuleSets~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/expirationRuleSets/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/expirationRuleSets/{tenantId}","href":"expiration-rule-sets/listexpirationrulesets","openApiOperationId":"listExpirationRuleSets","summary":"Gets all of the expiration rule sets in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The expiration rule setswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_396"}},"schemaId":"schema_396","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1expirationRuleSets~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_396","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_396"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/expiration-rule-sets/listexpirationrulesets"}],"panels":[]}]},"httpPath":"/expirationRuleSets/{tenantId}"},{"label":"Creates a new expiration rule set record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/expiration-rule-sets/createexpirationruleset","routeSlug":"/apis/certifications/certifications-v1/expiration-rule-sets/createexpirationruleset","metadata":{"seo":{"title":"Creates a new expiration rule set record that does not already exist.","description":"This method will auto-generate an ID and create a new expiration rule set. If an ID is specified for the expiration rule set, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createExpirationRuleSet","name":"Creates a new expiration rule set record that does not already exist.","isWebhook":false,"pointer":"/paths/~1expirationRuleSets~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new expiration rule set record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new expiration rule set. If an ID is specified for the expiration rule set, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1expirationRuleSets~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExpirationRuleSet"}},"schemaId":"components/schemas/ExpirationRuleSet","pointer":"/paths/~1expirationRuleSets~1{tenantId}/post/requestBody","description":"The expiration rule set that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/expirationRuleSets/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExpirationRuleSet"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/expirationRuleSets/{tenantId}","href":"expiration-rule-sets/createexpirationruleset","openApiOperationId":"createExpirationRuleSet","summary":"Creates a new expiration rule set record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExpirationRuleSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExpirationRuleSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The expiration rule set was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpirationRuleSet"}},"schemaId":"components/schemas/ExpirationRuleSet","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The expiration rule set you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The expiration rule set could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add expiration rule set based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1expirationRuleSets~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpirationRuleSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpirationRuleSet"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/expiration-rule-sets/createexpirationruleset"}],"panels":[]}]},"httpPath":"/expirationRuleSets/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/expiration-rule-sets/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/expiration-rule-sets/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1expirationRuleSets~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1expirationRuleSets~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1expirationRuleSets~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/expirationRuleSets/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/expirationRuleSets/{tenantId}/batch","href":"expiration-rule-sets/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The expiration rule set could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve expiration rule set based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1expirationRuleSets~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/expiration-rule-sets/executebatchoperations"}],"panels":[]}]},"httpPath":"/expirationRuleSets/{tenantId}/batch"},{"label":"Returns a expiration rule set from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/expiration-rule-sets/deleteexpirationruleset","routeSlug":"/apis/certifications/certifications-v1/expiration-rule-sets/deleteexpirationruleset","metadata":{"seo":{"title":"Returns a expiration rule set from the system by its ID.","description":"This method will delete a expiration rule set with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteExpirationRuleSet","name":"Returns a expiration rule set from the system by its ID.","isWebhook":false,"pointer":"/paths/~1expirationRuleSets~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a expiration rule set from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a expiration rule set with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the expiration rule set to delete.","required":true}],"pointer":"/paths/~1expirationRuleSets~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/expirationRuleSets/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/expirationRuleSets/{tenantId}/{id}","href":"expiration-rule-sets/deleteexpirationruleset","openApiOperationId":"deleteExpirationRuleSet","summary":"Returns a expiration rule set from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The expiration rule set was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The expiration rule set could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The expiration rule set could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete expiration rule set based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1expirationRuleSets~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/expiration-rule-sets/deleteexpirationruleset"}],"panels":[]}]},"httpPath":"/expirationRuleSets/{tenantId}/{id}"},{"label":"Returns a expiration rule set from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/expiration-rule-sets/getexpirationruleset","routeSlug":"/apis/certifications/certifications-v1/expiration-rule-sets/getexpirationruleset","metadata":{"seo":{"title":"Returns a expiration rule set from the system by its ID.","description":"This method will look up a expiration rule set by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExpirationRuleSet","name":"Returns a expiration rule set from the system by its ID.","isWebhook":false,"pointer":"/paths/~1expirationRuleSets~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a expiration rule set from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a expiration rule set by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the expiration rule set to return.","required":true}],"pointer":"/paths/~1expirationRuleSets~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1expirationRuleSets~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/expirationRuleSets/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/expirationRuleSets/{tenantId}/{id}","href":"expiration-rule-sets/getexpirationruleset","openApiOperationId":"getExpirationRuleSet","summary":"Returns a expiration rule set from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The expiration rule set was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpirationRuleSet"}},"schemaId":"components/schemas/ExpirationRuleSet","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The expiration rule set could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve expiration rule set based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1expirationRuleSets~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpirationRuleSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpirationRuleSet"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/expiration-rule-sets/getexpirationruleset"}],"panels":[]}]},"httpPath":"/expirationRuleSets/{tenantId}/{id}"},{"label":"Partially updates a expiration rule set with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/expiration-rule-sets/patchexpirationruleset","routeSlug":"/apis/certifications/certifications-v1/expiration-rule-sets/patchexpirationruleset","metadata":{"seo":{"title":"Partially updates a expiration rule set with the specified ID.","description":"This method will patch an existing expiration rule set with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchExpirationRuleSet","name":"Partially updates a expiration rule set with the specified ID.","isWebhook":false,"pointer":"/paths/~1expirationRuleSets~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a expiration rule set with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing expiration rule set with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the expiration rule set to patch.","required":true}],"pointer":"/paths/~1expirationRuleSets~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1expirationRuleSets~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/expirationRuleSets/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/expirationRuleSets/{tenantId}/{id}","href":"expiration-rule-sets/patchexpirationruleset","openApiOperationId":"patchExpirationRuleSet","summary":"Partially updates a expiration rule set with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The expiration rule set was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpirationRuleSet"}},"schemaId":"components/schemas/ExpirationRuleSet","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The expiration rule set could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The expiration rule set could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve expiration rule set based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1expirationRuleSets~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpirationRuleSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpirationRuleSet"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/expiration-rule-sets/patchexpirationruleset"}],"panels":[]}]},"httpPath":"/expirationRuleSets/{tenantId}/{id}"},{"label":"Updates a expiration rule set with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/expiration-rule-sets/updateexpirationruleset","routeSlug":"/apis/certifications/certifications-v1/expiration-rule-sets/updateexpirationruleset","metadata":{"seo":{"title":"Updates a expiration rule set with the specified ID.","description":"This method will update an existing expiration rule set with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateExpirationRuleSet","name":"Updates a expiration rule set with the specified ID.","isWebhook":false,"pointer":"/paths/~1expirationRuleSets~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a expiration rule set with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing expiration rule set with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the expiration rule set to update.","required":true}],"pointer":"/paths/~1expirationRuleSets~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExpirationRuleSet"}},"schemaId":"components/schemas/ExpirationRuleSet","pointer":"/paths/~1expirationRuleSets~1{tenantId}~1{id}/put/requestBody","description":"The updated expiration rule set that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/expirationRuleSets/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExpirationRuleSet"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/expirationRuleSets/{tenantId}/{id}","href":"expiration-rule-sets/updateexpirationruleset","openApiOperationId":"updateExpirationRuleSet","summary":"Updates a expiration rule set with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExpirationRuleSet","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExpirationRuleSet"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The expiration rule set was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpirationRuleSet"}},"schemaId":"components/schemas/ExpirationRuleSet","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The expiration rule set supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The expiration rule set could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The expiration rule set could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve expiration rule set based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1expirationRuleSets~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExpirationRuleSet","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExpirationRuleSet"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/expiration-rule-sets/updateexpirationruleset"}],"panels":[]}]},"httpPath":"/expirationRuleSets/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Expiration Rule Sets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Expiration Rule Sets","showPageActions":true},{"nodeType":"markdoc","content":"Expiration Rule Sets"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/expirationRuleSets/{tenantId}","summary":"Gets all of the expiration rule sets in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/expiration-rule-sets/listexpirationrulesets","deprecated":false},{"title":"/expirationRuleSets/{tenantId}","summary":"Creates a new expiration rule set record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/expiration-rule-sets/createexpirationruleset","deprecated":false},{"title":"/expirationRuleSets/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/expiration-rule-sets/executebatchoperations","deprecated":false},{"title":"/expirationRuleSets/{tenantId}/{id}","summary":"Returns a expiration rule set from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/expiration-rule-sets/deleteexpirationruleset","deprecated":false},{"title":"/expirationRuleSets/{tenantId}/{id}","summary":"Returns a expiration rule set from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/expiration-rule-sets/getexpirationruleset","deprecated":false},{"title":"/expirationRuleSets/{tenantId}/{id}","summary":"Partially updates a expiration rule set with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/expiration-rule-sets/patchexpirationruleset","deprecated":false},{"title":"/expirationRuleSets/{tenantId}/{id}","summary":"Updates a expiration rule set with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/expiration-rule-sets/updateexpirationruleset","deprecated":false}]}]}]}]}},{"type":"group","label":"Fees","link":"/apis/certifications/certifications-v1/fees","routeSlug":"/apis/certifications/certifications-v1/fees","items":[{"label":"Gets all of the fees in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/fees/listfees","routeSlug":"/apis/certifications/certifications-v1/fees/listfees","metadata":{"seo":{"title":"Gets all of the fees in the system.","description":"This method will scan all fees and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFees","name":"Gets all of the fees in the system.","isWebhook":false,"pointer":"/paths/~1fees~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the fees in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all fees and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1fees~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1fees~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fees/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/fees/{tenantId}","href":"fees/listfees","openApiOperationId":"listFees","summary":"Gets all of the fees in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The feeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_397"}},"schemaId":"schema_397","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1fees~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_397","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_397"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/listfees"}],"panels":[]}]},"httpPath":"/fees/{tenantId}"},{"label":"Creates a new fee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/fees/createfee","routeSlug":"/apis/certifications/certifications-v1/fees/createfee","metadata":{"seo":{"title":"Creates a new fee record that does not already exist.","description":"This method will auto-generate an ID and create a new fee. If an ID is specified for the fee, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFee","name":"Creates a new fee record that does not already exist.","isWebhook":false,"pointer":"/paths/~1fees~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new fee record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new fee. If an ID is specified for the fee, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1fees~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Fee"}},"schemaId":"components/schemas/Fee","pointer":"/paths/~1fees~1{tenantId}/post/requestBody","description":"The fee that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fees/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Fee"}},"responseCodes":["200","400","401","403","409","429","500"],"pointer":"/fees/{tenantId}","href":"fees/createfee","openApiOperationId":"createFee","summary":"Creates a new fee record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Fee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Fee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fee was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee"}},"schemaId":"components/schemas/Fee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The fee you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1fees~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Fee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/createfee"}],"panels":[]}]},"httpPath":"/fees/{tenantId}"},{"label":"Returns a fee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/fees/deletefee","routeSlug":"/apis/certifications/certifications-v1/fees/deletefee","metadata":{"seo":{"title":"Returns a fee from the system by its ID.","description":"This method will delete a fee with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFee","name":"Returns a fee from the system by its ID.","isWebhook":false,"pointer":"/paths/~1fees~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a fee from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a fee with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the fee to delete.","required":true}],"pointer":"/paths/~1fees~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/fees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/fees/{tenantId}/{id}","href":"fees/deletefee","openApiOperationId":"deleteFee","summary":"Returns a fee from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fee was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The fee could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1fees~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/deletefee"}],"panels":[]}]},"httpPath":"/fees/{tenantId}/{id}"},{"label":"Returns a fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/fees/getfee","routeSlug":"/apis/certifications/certifications-v1/fees/getfee","metadata":{"seo":{"title":"Returns a fee from the system by its ID.","description":"This method will look up a fee by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFee","name":"Returns a fee from the system by its ID.","isWebhook":false,"pointer":"/paths/~1fees~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a fee from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a fee by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the fee to return.","required":true}],"pointer":"/paths/~1fees~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1fees~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fees/{tenantId}/{id}","href":"fees/getfee","openApiOperationId":"getFee","summary":"Returns a fee from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fee was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee"}},"schemaId":"components/schemas/Fee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1fees~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Fee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/getfee"}],"panels":[]}]},"httpPath":"/fees/{tenantId}/{id}"},{"label":"Partially updates a fee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/fees/patchfee","routeSlug":"/apis/certifications/certifications-v1/fees/patchfee","metadata":{"seo":{"title":"Partially updates a fee with the specified ID.","description":"This method will patch an existing fee with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchFee","name":"Partially updates a fee with the specified ID.","isWebhook":false,"pointer":"/paths/~1fees~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a fee with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing fee with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the fee to patch.","required":true}],"pointer":"/paths/~1fees~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1fees~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/fees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/fees/{tenantId}/{id}","href":"fees/patchfee","openApiOperationId":"patchFee","summary":"Partially updates a fee with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fee was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee"}},"schemaId":"components/schemas/Fee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1fees~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Fee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/patchfee"}],"panels":[]}]},"httpPath":"/fees/{tenantId}/{id}"},{"label":"Updates a fee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/fees/updatefee","routeSlug":"/apis/certifications/certifications-v1/fees/updatefee","metadata":{"seo":{"title":"Updates a fee with the specified ID.","description":"This method will update an existing fee with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFee","name":"Updates a fee with the specified ID.","isWebhook":false,"pointer":"/paths/~1fees~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a fee with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing fee with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the fee to update.","required":true}],"pointer":"/paths/~1fees~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Fee"}},"schemaId":"components/schemas/Fee","pointer":"/paths/~1fees~1{tenantId}~1{id}/put/requestBody","description":"The updated fee that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/fees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Fee"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/fees/{tenantId}/{id}","href":"fees/updatefee","openApiOperationId":"updateFee","summary":"Updates a fee with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Fee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Fee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fee was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee"}},"schemaId":"components/schemas/Fee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The fee supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1fees~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Fee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/updatefee"}],"panels":[]}]},"httpPath":"/fees/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Fees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fees","showPageActions":true},{"nodeType":"markdoc","content":"Fees"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fees/{tenantId}","summary":"Gets all of the fees in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fees/listfees","deprecated":false},{"title":"/fees/{tenantId}","summary":"Creates a new fee record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fees/createfee","deprecated":false},{"title":"/fees/{tenantId}/{id}","summary":"Returns a fee from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/fees/deletefee","deprecated":false},{"title":"/fees/{tenantId}/{id}","summary":"Returns a fee from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fees/getfee","deprecated":false},{"title":"/fees/{tenantId}/{id}","summary":"Partially updates a fee with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/fees/patchfee","deprecated":false},{"title":"/fees/{tenantId}/{id}","summary":"Updates a fee with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/fees/updatefee","deprecated":false}]}]}]}]}},{"type":"group","label":"Instructors","link":"/apis/certifications/certifications-v1/instructors","routeSlug":"/apis/certifications/certifications-v1/instructors","items":[{"label":"Gets all of the instructors in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/instructors/listinstructors","routeSlug":"/apis/certifications/certifications-v1/instructors/listinstructors","metadata":{"seo":{"title":"Gets all of the instructors in the system.","description":"This method will scan all instructors and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInstructors","name":"Gets all of the instructors in the system.","isWebhook":false,"pointer":"/paths/~1instructors~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the instructors in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all instructors and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1instructors~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1instructors~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/instructors/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/instructors/{tenantId}","href":"instructors/listinstructors","openApiOperationId":"listInstructors","summary":"Gets all of the instructors in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The instructorswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}},"schemaId":"schema_398","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1instructors~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_398","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instructors/listinstructors"}],"panels":[]}]},"httpPath":"/instructors/{tenantId}"},{"label":"Creates a new instructor record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/instructors/createinstructor","routeSlug":"/apis/certifications/certifications-v1/instructors/createinstructor","metadata":{"seo":{"title":"Creates a new instructor record that does not already exist.","description":"This method will auto-generate an ID and create a new instructor. If an ID is specified for the instructor, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createInstructor","name":"Creates a new instructor record that does not already exist.","isWebhook":false,"pointer":"/paths/~1instructors~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new instructor record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new instructor. If an ID is specified for the instructor, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1instructors~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Instructor"}},"schemaId":"components/schemas/Instructor","pointer":"/paths/~1instructors~1{tenantId}/post/requestBody","description":"The instructor that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/instructors/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Instructor"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/instructors/{tenantId}","href":"instructors/createinstructor","openApiOperationId":"createInstructor","summary":"Creates a new instructor record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Instructor","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Instructor"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The instructor was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Instructor"}},"schemaId":"components/schemas/Instructor","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The instructor you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The instructor could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add instructor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1instructors~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Instructor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Instructor"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instructors/createinstructor"}],"panels":[]}]},"httpPath":"/instructors/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/instructors/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/instructors/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1instructors~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1instructors~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1instructors~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/instructors/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/instructors/{tenantId}/batch","href":"instructors/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The instructor could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve instructor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1instructors~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instructors/executebatchoperations"}],"panels":[]}]},"httpPath":"/instructors/{tenantId}/batch"},{"label":"Returns a instructor from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/instructors/getinstructorpublic","routeSlug":"/apis/certifications/certifications-v1/instructors/getinstructorpublic","metadata":{"seo":{"title":"Returns a instructor from the system by its ID.","description":"This method will look up a instructor by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInstructorPublic","name":"Returns a instructor from the system by its ID.","isWebhook":false,"pointer":"/paths/~1instructors~1{tenantId}~1public~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a instructor from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a instructor by the specified ID and return it back."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the instructor to return.","required":true}],"pointer":"/paths/~1instructors~1{tenantId}~1public~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1instructors~1{tenantId}~1public~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/instructors/{tenantId}/public/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/instructors/{tenantId}/public/{id}","href":"instructors/getinstructorpublic","openApiOperationId":"getInstructorPublic","summary":"Returns a instructor from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The instructor was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Instructor"}},"schemaId":"components/schemas/Instructor","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The instructor could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve instructor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1instructors~1{tenantId}~1public~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Instructor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Instructor"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instructors/getinstructorpublic"}],"panels":[]}]},"httpPath":"/instructors/{tenantId}/public/{id}"},{"label":"Returns a list of records with the specified training_provider_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/instructors/listinstructorsbytrainingproviderid","routeSlug":"/apis/certifications/certifications-v1/instructors/listinstructorsbytrainingproviderid","metadata":{"seo":{"title":"Returns a list of records with the specified training_provider_id","description":"Returns a list of records with the specified training_provider_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInstructorsByTrainingProviderId","name":"Returns a list of records with the specified training_provider_id","isWebhook":false,"pointer":"/paths/~1instructors~1{tenantId}~1trainingProvider~1{training_provider_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified training_provider_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified training_provider_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"training_provider_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The training_provider_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1instructors~1{tenantId}~1trainingProvider~1{training_provider_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1instructors~1{tenantId}~1trainingProvider~1{training_provider_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/instructors/{tenantId}/trainingProvider/{training_provider_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"training_provider_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/instructors/{tenantId}/trainingProvider/{training_provider_id}","href":"instructors/listinstructorsbytrainingproviderid","openApiOperationId":"listInstructorsByTrainingProviderId","summary":"Returns a list of records with the specified training_provider_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInstructorsResponse"}},"schemaId":"components/schemas/ListInstructorsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1instructors~1{tenantId}~1trainingProvider~1{training_provider_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListInstructorsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInstructorsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instructors/listinstructorsbytrainingproviderid"}],"panels":[]}]},"httpPath":"/instructors/{tenantId}/trainingProvider/{training_provider_id}"},{"label":"Returns a instructor from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/instructors/deleteinstructor","routeSlug":"/apis/certifications/certifications-v1/instructors/deleteinstructor","metadata":{"seo":{"title":"Returns a instructor from the system by its ID.","description":"This method will delete a instructor with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteInstructor","name":"Returns a instructor from the system by its ID.","isWebhook":false,"pointer":"/paths/~1instructors~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a instructor from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a instructor with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the instructor to delete.","required":true}],"pointer":"/paths/~1instructors~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/instructors/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/instructors/{tenantId}/{id}","href":"instructors/deleteinstructor","openApiOperationId":"deleteInstructor","summary":"Returns a instructor from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The instructor was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The instructor could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The instructor could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete instructor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1instructors~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instructors/deleteinstructor"}],"panels":[]}]},"httpPath":"/instructors/{tenantId}/{id}"},{"label":"Returns a instructor from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/instructors/getinstructor","routeSlug":"/apis/certifications/certifications-v1/instructors/getinstructor","metadata":{"seo":{"title":"Returns a instructor from the system by its ID.","description":"This method will look up a instructor by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInstructor","name":"Returns a instructor from the system by its ID.","isWebhook":false,"pointer":"/paths/~1instructors~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a instructor from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a instructor by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the instructor to return.","required":true}],"pointer":"/paths/~1instructors~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1instructors~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/instructors/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/instructors/{tenantId}/{id}","href":"instructors/getinstructor","openApiOperationId":"getInstructor","summary":"Returns a instructor from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The instructor was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Instructor"}},"schemaId":"components/schemas/Instructor","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The instructor could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve instructor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1instructors~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Instructor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Instructor"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instructors/getinstructor"}],"panels":[]}]},"httpPath":"/instructors/{tenantId}/{id}"},{"label":"Partially updates a instructor with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/instructors/patchinstructor","routeSlug":"/apis/certifications/certifications-v1/instructors/patchinstructor","metadata":{"seo":{"title":"Partially updates a instructor with the specified ID.","description":"This method will patch an existing instructor with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchInstructor","name":"Partially updates a instructor with the specified ID.","isWebhook":false,"pointer":"/paths/~1instructors~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a instructor with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing instructor with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the instructor to patch.","required":true}],"pointer":"/paths/~1instructors~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1instructors~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/instructors/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/instructors/{tenantId}/{id}","href":"instructors/patchinstructor","openApiOperationId":"patchInstructor","summary":"Partially updates a instructor with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The instructor was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Instructor"}},"schemaId":"components/schemas/Instructor","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The instructor could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The instructor could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve instructor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1instructors~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Instructor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Instructor"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instructors/patchinstructor"}],"panels":[]}]},"httpPath":"/instructors/{tenantId}/{id}"},{"label":"Updates a instructor with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/instructors/updateinstructor","routeSlug":"/apis/certifications/certifications-v1/instructors/updateinstructor","metadata":{"seo":{"title":"Updates a instructor with the specified ID.","description":"This method will update an existing instructor with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInstructor","name":"Updates a instructor with the specified ID.","isWebhook":false,"pointer":"/paths/~1instructors~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a instructor with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing instructor with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the instructor to update.","required":true}],"pointer":"/paths/~1instructors~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Instructor"}},"schemaId":"components/schemas/Instructor","pointer":"/paths/~1instructors~1{tenantId}~1{id}/put/requestBody","description":"The updated instructor that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/instructors/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Instructor"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/instructors/{tenantId}/{id}","href":"instructors/updateinstructor","openApiOperationId":"updateInstructor","summary":"Updates a instructor with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Instructor","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Instructor"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The instructor was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Instructor"}},"schemaId":"components/schemas/Instructor","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The instructor supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The instructor could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The instructor could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve instructor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1instructors~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Instructor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Instructor"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/instructors/updateinstructor"}],"panels":[]}]},"httpPath":"/instructors/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Instructors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Instructors","showPageActions":true},{"nodeType":"markdoc","content":"Instructors"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/instructors/{tenantId}","summary":"Gets all of the instructors in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/instructors/listinstructors","deprecated":false},{"title":"/instructors/{tenantId}","summary":"Creates a new instructor record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/instructors/createinstructor","deprecated":false},{"title":"/instructors/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/instructors/executebatchoperations","deprecated":false},{"title":"/instructors/{tenantId}/public/{id}","summary":"Returns a instructor from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/instructors/getinstructorpublic","deprecated":false},{"title":"/instructors/{tenantId}/trainingProvider/{training_provider_id}","summary":"Returns a list of records with the specified training_provider_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/instructors/listinstructorsbytrainingproviderid","deprecated":false},{"title":"/instructors/{tenantId}/{id}","summary":"Returns a instructor from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/instructors/deleteinstructor","deprecated":false},{"title":"/instructors/{tenantId}/{id}","summary":"Returns a instructor from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/instructors/getinstructor","deprecated":false},{"title":"/instructors/{tenantId}/{id}","summary":"Partially updates a instructor with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/instructors/patchinstructor","deprecated":false},{"title":"/instructors/{tenantId}/{id}","summary":"Updates a instructor with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/instructors/updateinstructor","deprecated":false}]}]}]}]}},{"type":"group","label":"License Types","link":"/apis/certifications/certifications-v1/license-types","routeSlug":"/apis/certifications/certifications-v1/license-types","items":[{"label":"Gets all of the license types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/license-types/listlicensetypes","routeSlug":"/apis/certifications/certifications-v1/license-types/listlicensetypes","metadata":{"seo":{"title":"Gets all of the license types in the system.","description":"This method will scan all license types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLicenseTypes","name":"Gets all of the license types in the system.","isWebhook":false,"pointer":"/paths/~1licenseTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the license types in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all license types and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1licenseTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1licenseTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/licenseTypes/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/licenseTypes/{tenantId}","href":"license-types/listlicensetypes","openApiOperationId":"listLicenseTypes","summary":"Gets all of the license types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The license typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399"}},"schemaId":"schema_399","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1licenseTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_399","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/license-types/listlicensetypes"}],"panels":[]}]},"httpPath":"/licenseTypes/{tenantId}"},{"label":"Creates a new license type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/license-types/createlicensetype","routeSlug":"/apis/certifications/certifications-v1/license-types/createlicensetype","metadata":{"seo":{"title":"Creates a new license type record that does not already exist.","description":"This method will auto-generate an ID and create a new license type. If an ID is specified for the license type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createLicenseType","name":"Creates a new license type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1licenseTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new license type record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new license type. If an ID is specified for the license type, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1licenseTypes~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LicenseType"}},"schemaId":"components/schemas/LicenseType","pointer":"/paths/~1licenseTypes~1{tenantId}/post/requestBody","description":"The license type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/licenseTypes/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LicenseType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/licenseTypes/{tenantId}","href":"license-types/createlicensetype","openApiOperationId":"createLicenseType","summary":"Creates a new license type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/LicenseType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LicenseType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The license type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LicenseType"}},"schemaId":"components/schemas/LicenseType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The license type you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The license type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add license type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1licenseTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LicenseType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LicenseType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/license-types/createlicensetype"}],"panels":[]}]},"httpPath":"/licenseTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/license-types/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/license-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1licenseTypes~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1licenseTypes~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1licenseTypes~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/licenseTypes/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/licenseTypes/{tenantId}/batch","href":"license-types/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The license type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve license type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1licenseTypes~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/license-types/executebatchoperations"}],"panels":[]}]},"httpPath":"/licenseTypes/{tenantId}/batch"},{"label":"Returns a license type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/license-types/deletelicensetype","routeSlug":"/apis/certifications/certifications-v1/license-types/deletelicensetype","metadata":{"seo":{"title":"Returns a license type from the system by its ID.","description":"This method will delete a license type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteLicenseType","name":"Returns a license type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1licenseTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a license type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a license type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the license type to delete.","required":true}],"pointer":"/paths/~1licenseTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/licenseTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/licenseTypes/{tenantId}/{id}","href":"license-types/deletelicensetype","openApiOperationId":"deleteLicenseType","summary":"Returns a license type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The license type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The license type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The license type could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete license type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1licenseTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/license-types/deletelicensetype"}],"panels":[]}]},"httpPath":"/licenseTypes/{tenantId}/{id}"},{"label":"Returns a license type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/license-types/getlicensetype","routeSlug":"/apis/certifications/certifications-v1/license-types/getlicensetype","metadata":{"seo":{"title":"Returns a license type from the system by its ID.","description":"This method will look up a license type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLicenseType","name":"Returns a license type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1licenseTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a license type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a license type by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the license type to return.","required":true}],"pointer":"/paths/~1licenseTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1licenseTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/licenseTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/licenseTypes/{tenantId}/{id}","href":"license-types/getlicensetype","openApiOperationId":"getLicenseType","summary":"Returns a license type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The license type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LicenseType"}},"schemaId":"components/schemas/LicenseType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The license type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve license type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1licenseTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LicenseType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LicenseType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/license-types/getlicensetype"}],"panels":[]}]},"httpPath":"/licenseTypes/{tenantId}/{id}"},{"label":"Partially updates a license type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/license-types/patchlicensetype","routeSlug":"/apis/certifications/certifications-v1/license-types/patchlicensetype","metadata":{"seo":{"title":"Partially updates a license type with the specified ID.","description":"This method will patch an existing license type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchLicenseType","name":"Partially updates a license type with the specified ID.","isWebhook":false,"pointer":"/paths/~1licenseTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a license type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing license type with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the license type to patch.","required":true}],"pointer":"/paths/~1licenseTypes~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1licenseTypes~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/licenseTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/licenseTypes/{tenantId}/{id}","href":"license-types/patchlicensetype","openApiOperationId":"patchLicenseType","summary":"Partially updates a license type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The license type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LicenseType"}},"schemaId":"components/schemas/LicenseType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The license type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The license type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve license type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1licenseTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LicenseType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LicenseType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/license-types/patchlicensetype"}],"panels":[]}]},"httpPath":"/licenseTypes/{tenantId}/{id}"},{"label":"Updates a license type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/license-types/updatelicensetype","routeSlug":"/apis/certifications/certifications-v1/license-types/updatelicensetype","metadata":{"seo":{"title":"Updates a license type with the specified ID.","description":"This method will update an existing license type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateLicenseType","name":"Updates a license type with the specified ID.","isWebhook":false,"pointer":"/paths/~1licenseTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a license type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing license type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the license type to update.","required":true}],"pointer":"/paths/~1licenseTypes~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LicenseType"}},"schemaId":"components/schemas/LicenseType","pointer":"/paths/~1licenseTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated license type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/licenseTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LicenseType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/licenseTypes/{tenantId}/{id}","href":"license-types/updatelicensetype","openApiOperationId":"updateLicenseType","summary":"Updates a license type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/LicenseType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LicenseType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The license type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LicenseType"}},"schemaId":"components/schemas/LicenseType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The license type supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The license type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The license type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve license type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1licenseTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LicenseType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LicenseType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/license-types/updatelicensetype"}],"panels":[]}]},"httpPath":"/licenseTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"License Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"License Types","showPageActions":true},{"nodeType":"markdoc","content":"License Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/licenseTypes/{tenantId}","summary":"Gets all of the license types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/license-types/listlicensetypes","deprecated":false},{"title":"/licenseTypes/{tenantId}","summary":"Creates a new license type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/license-types/createlicensetype","deprecated":false},{"title":"/licenseTypes/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/license-types/executebatchoperations","deprecated":false},{"title":"/licenseTypes/{tenantId}/{id}","summary":"Returns a license type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/license-types/deletelicensetype","deprecated":false},{"title":"/licenseTypes/{tenantId}/{id}","summary":"Returns a license type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/license-types/getlicensetype","deprecated":false},{"title":"/licenseTypes/{tenantId}/{id}","summary":"Partially updates a license type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/license-types/patchlicensetype","deprecated":false},{"title":"/licenseTypes/{tenantId}/{id}","summary":"Updates a license type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/license-types/updatelicensetype","deprecated":false}]}]}]}]}},{"type":"group","label":"Notices","link":"/apis/certifications/certifications-v1/notices","routeSlug":"/apis/certifications/certifications-v1/notices","items":[{"label":"Gets all of the notices in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/notices/listnotices","routeSlug":"/apis/certifications/certifications-v1/notices/listnotices","metadata":{"seo":{"title":"Gets all of the notices in the system.","description":"This method will scan all notices and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNotices","name":"Gets all of the notices in the system.","isWebhook":false,"pointer":"/paths/~1notices~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the notices in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all notices and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1notices~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1notices~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notices/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/notices/{tenantId}","href":"notices/listnotices","openApiOperationId":"listNotices","summary":"Gets all of the notices in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The noticeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1notices~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_400"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notices/listnotices"}],"panels":[]}]},"httpPath":"/notices/{tenantId}"},{"label":"Creates a new notice record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/notices/createnotice","routeSlug":"/apis/certifications/certifications-v1/notices/createnotice","metadata":{"seo":{"title":"Creates a new notice record that does not already exist.","description":"This method will auto-generate an ID and create a new notice. If an ID is specified for the notice, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createNotice","name":"Creates a new notice record that does not already exist.","isWebhook":false,"pointer":"/paths/~1notices~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new notice record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new notice. If an ID is specified for the notice, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1notices~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Notice"}},"schemaId":"components/schemas/Notice","pointer":"/paths/~1notices~1{tenantId}/post/requestBody","description":"The notice that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/notices/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Notice"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/notices/{tenantId}","href":"notices/createnotice","openApiOperationId":"createNotice","summary":"Creates a new notice record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Notice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Notice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The notice was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Notice"}},"schemaId":"components/schemas/Notice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The notice you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1notices~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Notice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Notice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notices/createnotice"}],"panels":[]}]},"httpPath":"/notices/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/notices/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/notices/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1notices~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1notices~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1notices~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/notices/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/notices/{tenantId}/batch","href":"notices/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1notices~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notices/executebatchoperations"}],"panels":[]}]},"httpPath":"/notices/{tenantId}/batch"},{"label":"Returns a notice from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/notices/deletenotice","routeSlug":"/apis/certifications/certifications-v1/notices/deletenotice","metadata":{"seo":{"title":"Returns a notice from the system by its ID.","description":"This method will delete a notice with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteNotice","name":"Returns a notice from the system by its ID.","isWebhook":false,"pointer":"/paths/~1notices~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a notice from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a notice with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the notice to delete.","required":true}],"pointer":"/paths/~1notices~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/notices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/notices/{tenantId}/{id}","href":"notices/deletenotice","openApiOperationId":"deleteNotice","summary":"Returns a notice from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The notice was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The notice could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1notices~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notices/deletenotice"}],"panels":[]}]},"httpPath":"/notices/{tenantId}/{id}"},{"label":"Returns a notice from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/notices/getnotice","routeSlug":"/apis/certifications/certifications-v1/notices/getnotice","metadata":{"seo":{"title":"Returns a notice from the system by its ID.","description":"This method will look up a notice by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNotice","name":"Returns a notice from the system by its ID.","isWebhook":false,"pointer":"/paths/~1notices~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a notice from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a notice by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the notice to return.","required":true}],"pointer":"/paths/~1notices~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1notices~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/notices/{tenantId}/{id}","href":"notices/getnotice","openApiOperationId":"getNotice","summary":"Returns a notice from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The notice was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Notice"}},"schemaId":"components/schemas/Notice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1notices~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Notice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Notice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notices/getnotice"}],"panels":[]}]},"httpPath":"/notices/{tenantId}/{id}"},{"label":"Partially updates a notice with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/notices/patchnotice","routeSlug":"/apis/certifications/certifications-v1/notices/patchnotice","metadata":{"seo":{"title":"Partially updates a notice with the specified ID.","description":"This method will patch an existing notice with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchNotice","name":"Partially updates a notice with the specified ID.","isWebhook":false,"pointer":"/paths/~1notices~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a notice with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing notice with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the notice to patch.","required":true}],"pointer":"/paths/~1notices~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1notices~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/notices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/notices/{tenantId}/{id}","href":"notices/patchnotice","openApiOperationId":"patchNotice","summary":"Partially updates a notice with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The notice was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Notice"}},"schemaId":"components/schemas/Notice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1notices~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Notice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Notice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notices/patchnotice"}],"panels":[]}]},"httpPath":"/notices/{tenantId}/{id}"},{"label":"Updates a notice with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/notices/updatenotice","routeSlug":"/apis/certifications/certifications-v1/notices/updatenotice","metadata":{"seo":{"title":"Updates a notice with the specified ID.","description":"This method will update an existing notice with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateNotice","name":"Updates a notice with the specified ID.","isWebhook":false,"pointer":"/paths/~1notices~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a notice with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing notice with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the notice to update.","required":true}],"pointer":"/paths/~1notices~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Notice"}},"schemaId":"components/schemas/Notice","pointer":"/paths/~1notices~1{tenantId}~1{id}/put/requestBody","description":"The updated notice that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/notices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Notice"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/notices/{tenantId}/{id}","href":"notices/updatenotice","openApiOperationId":"updateNotice","summary":"Updates a notice with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Notice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Notice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The notice was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Notice"}},"schemaId":"components/schemas/Notice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The notice supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1notices~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Notice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Notice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notices/updatenotice"}],"panels":[]}]},"httpPath":"/notices/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Notices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notices","showPageActions":true},{"nodeType":"markdoc","content":"Notices"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/notices/{tenantId}","summary":"Gets all of the notices in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notices/listnotices","deprecated":false},{"title":"/notices/{tenantId}","summary":"Creates a new notice record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notices/createnotice","deprecated":false},{"title":"/notices/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notices/executebatchoperations","deprecated":false},{"title":"/notices/{tenantId}/{id}","summary":"Returns a notice from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/notices/deletenotice","deprecated":false},{"title":"/notices/{tenantId}/{id}","summary":"Returns a notice from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notices/getnotice","deprecated":false},{"title":"/notices/{tenantId}/{id}","summary":"Partially updates a notice with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/notices/patchnotice","deprecated":false},{"title":"/notices/{tenantId}/{id}","summary":"Updates a notice with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/notices/updatenotice","deprecated":false}]}]}]}]}},{"type":"group","label":"Profiles","link":"/apis/certifications/certifications-v1/profiles","routeSlug":"/apis/certifications/certifications-v1/profiles","items":[{"label":"Creates a new profile record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/profiles/createprofile","routeSlug":"/apis/certifications/certifications-v1/profiles/createprofile","metadata":{"seo":{"title":"Creates a new profile record that does not already exist.","description":"This method will auto-generate an ID and create a new profile. If an ID is specified for the profile, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProfile","name":"Creates a new profile record that does not already exist.","isWebhook":false,"pointer":"/paths/~1profiles~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new profile record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new profile. If an ID is specified for the profile, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1profiles~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Profile"}},"schemaId":"components/schemas/Profile","pointer":"/paths/~1profiles~1{tenantId}/post/requestBody","description":"The profile that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Profile"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/profiles/{tenantId}","href":"profiles/createprofile","openApiOperationId":"createProfile","summary":"Creates a new profile record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Profile","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Profile"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The profile was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Profile"}},"schemaId":"components/schemas/Profile","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The profile you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The profile could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add profile based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1profiles~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Profile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Profile"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profiles/createprofile"}],"panels":[]}]},"httpPath":"/profiles/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/profiles/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/profiles/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1profiles~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1profiles~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1profiles~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/profiles/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/profiles/{tenantId}/batch","href":"profiles/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The profile could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve profile based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1profiles~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profiles/executebatchoperations"}],"panels":[]}]},"httpPath":"/profiles/{tenantId}/batch"},{"label":"Returns a list of records with the specified training_provider_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/profiles/listprofilesbytrainingproviderid","routeSlug":"/apis/certifications/certifications-v1/profiles/listprofilesbytrainingproviderid","metadata":{"seo":{"title":"Returns a list of records with the specified training_provider_id","description":"Returns a list of records with the specified training_provider_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProfilesByTrainingProviderId","name":"Returns a list of records with the specified training_provider_id","isWebhook":false,"pointer":"/paths/~1profiles~1{tenantId}~1trainingProvider~1{training_provider_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified training_provider_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified training_provider_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"training_provider_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The training_provider_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1profiles~1{tenantId}~1trainingProvider~1{training_provider_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1profiles~1{tenantId}~1trainingProvider~1{training_provider_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{tenantId}/trainingProvider/{training_provider_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"training_provider_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/profiles/{tenantId}/trainingProvider/{training_provider_id}","href":"profiles/listprofilesbytrainingproviderid","openApiOperationId":"listProfilesByTrainingProviderId","summary":"Returns a list of records with the specified training_provider_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListProfilesResponse"}},"schemaId":"components/schemas/ListProfilesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1profiles~1{tenantId}~1trainingProvider~1{training_provider_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListProfilesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListProfilesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profiles/listprofilesbytrainingproviderid"}],"panels":[]}]},"httpPath":"/profiles/{tenantId}/trainingProvider/{training_provider_id}"},{"label":"Returns a profile from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/profiles/deleteprofile","routeSlug":"/apis/certifications/certifications-v1/profiles/deleteprofile","metadata":{"seo":{"title":"Returns a profile from the system by its ID.","description":"This method will delete a profile with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProfile","name":"Returns a profile from the system by its ID.","isWebhook":false,"pointer":"/paths/~1profiles~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a profile from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a profile with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the profile to delete.","required":true}],"pointer":"/paths/~1profiles~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/profiles/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/profiles/{tenantId}/{id}","href":"profiles/deleteprofile","openApiOperationId":"deleteProfile","summary":"Returns a profile from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The profile was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The profile could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The profile could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete profile based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1profiles~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profiles/deleteprofile"}],"panels":[]}]},"httpPath":"/profiles/{tenantId}/{id}"},{"label":"Returns a profile from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/profiles/getprofile","routeSlug":"/apis/certifications/certifications-v1/profiles/getprofile","metadata":{"seo":{"title":"Returns a profile from the system by its ID.","description":"This method will look up a profile by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProfile","name":"Returns a profile from the system by its ID.","isWebhook":false,"pointer":"/paths/~1profiles~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a profile from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a profile by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the profile to return.","required":true}],"pointer":"/paths/~1profiles~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1profiles~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/profiles/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/profiles/{tenantId}/{id}","href":"profiles/getprofile","openApiOperationId":"getProfile","summary":"Returns a profile from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The profile was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Profile"}},"schemaId":"components/schemas/Profile","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The profile could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve profile based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1profiles~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Profile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Profile"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profiles/getprofile"}],"panels":[]}]},"httpPath":"/profiles/{tenantId}/{id}"},{"label":"Partially updates a profile with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/profiles/patchprofile","routeSlug":"/apis/certifications/certifications-v1/profiles/patchprofile","metadata":{"seo":{"title":"Partially updates a profile with the specified ID.","description":"This method will patch an existing profile with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchProfile","name":"Partially updates a profile with the specified ID.","isWebhook":false,"pointer":"/paths/~1profiles~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a profile with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing profile with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the profile to patch.","required":true}],"pointer":"/paths/~1profiles~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1profiles~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/profiles/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/profiles/{tenantId}/{id}","href":"profiles/patchprofile","openApiOperationId":"patchProfile","summary":"Partially updates a profile with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The profile was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Profile"}},"schemaId":"components/schemas/Profile","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The profile could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The profile could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve profile based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1profiles~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Profile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Profile"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profiles/patchprofile"}],"panels":[]}]},"httpPath":"/profiles/{tenantId}/{id}"},{"label":"Updates a profile with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/profiles/updateprofile","routeSlug":"/apis/certifications/certifications-v1/profiles/updateprofile","metadata":{"seo":{"title":"Updates a profile with the specified ID.","description":"This method will update an existing profile with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProfile","name":"Updates a profile with the specified ID.","isWebhook":false,"pointer":"/paths/~1profiles~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a profile with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing profile with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the profile to update.","required":true}],"pointer":"/paths/~1profiles~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Profile"}},"schemaId":"components/schemas/Profile","pointer":"/paths/~1profiles~1{tenantId}~1{id}/put/requestBody","description":"The updated profile that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/profiles/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Profile"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/profiles/{tenantId}/{id}","href":"profiles/updateprofile","openApiOperationId":"updateProfile","summary":"Updates a profile with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Profile","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Profile"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The profile was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Profile"}},"schemaId":"components/schemas/Profile","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The profile supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The profile could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The profile could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve profile based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1profiles~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Profile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Profile"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/profiles/updateprofile"}],"panels":[]}]},"httpPath":"/profiles/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Profiles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Profiles","showPageActions":true},{"nodeType":"markdoc","content":"Profiles"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/profiles/{tenantId}","summary":"Creates a new profile record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profiles/createprofile","deprecated":false},{"title":"/profiles/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/profiles/executebatchoperations","deprecated":false},{"title":"/profiles/{tenantId}/trainingProvider/{training_provider_id}","summary":"Returns a list of records with the specified training_provider_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profiles/listprofilesbytrainingproviderid","deprecated":false},{"title":"/profiles/{tenantId}/{id}","summary":"Returns a profile from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/profiles/deleteprofile","deprecated":false},{"title":"/profiles/{tenantId}/{id}","summary":"Returns a profile from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profiles/getprofile","deprecated":false},{"title":"/profiles/{tenantId}/{id}","summary":"Partially updates a profile with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/profiles/patchprofile","deprecated":false},{"title":"/profiles/{tenantId}/{id}","summary":"Updates a profile with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profiles/updateprofile","deprecated":false}]}]}]}]}},{"type":"group","label":"Program Groups","link":"/apis/certifications/certifications-v1/program-groups","routeSlug":"/apis/certifications/certifications-v1/program-groups","items":[{"label":"Gets all of the program groups in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/program-groups/listprogramgroups","routeSlug":"/apis/certifications/certifications-v1/program-groups/listprogramgroups","metadata":{"seo":{"title":"Gets all of the program groups in the system.","description":"This method will scan all program groups and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProgramGroups","name":"Gets all of the program groups in the system.","isWebhook":false,"pointer":"/paths/~1programGroups~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the program groups in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all program groups and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1programGroups~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1programGroups~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/programGroups/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/programGroups/{tenantId}","href":"program-groups/listprogramgroups","openApiOperationId":"listProgramGroups","summary":"Gets all of the program groups in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The program groupswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}},"schemaId":"schema_401","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1programGroups~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_401","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/program-groups/listprogramgroups"}],"panels":[]}]},"httpPath":"/programGroups/{tenantId}"},{"label":"Creates a new program group record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/program-groups/createprogramgroup","routeSlug":"/apis/certifications/certifications-v1/program-groups/createprogramgroup","metadata":{"seo":{"title":"Creates a new program group record that does not already exist.","description":"This method will auto-generate an ID and create a new program group. If an ID is specified for the program group, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProgramGroup","name":"Creates a new program group record that does not already exist.","isWebhook":false,"pointer":"/paths/~1programGroups~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new program group record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new program group. If an ID is specified for the program group, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1programGroups~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProgramGroup"}},"schemaId":"components/schemas/ProgramGroup","pointer":"/paths/~1programGroups~1{tenantId}/post/requestBody","description":"The program group that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/programGroups/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProgramGroup"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/programGroups/{tenantId}","href":"program-groups/createprogramgroup","openApiOperationId":"createProgramGroup","summary":"Creates a new program group record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProgramGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProgramGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The program group was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProgramGroup"}},"schemaId":"components/schemas/ProgramGroup","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The program group you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The program group could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add program group based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1programGroups~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProgramGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProgramGroup"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/program-groups/createprogramgroup"}],"panels":[]}]},"httpPath":"/programGroups/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/program-groups/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/program-groups/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1programGroups~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1programGroups~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1programGroups~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/programGroups/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/programGroups/{tenantId}/batch","href":"program-groups/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The program group could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve program group based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1programGroups~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/program-groups/executebatchoperations"}],"panels":[]}]},"httpPath":"/programGroups/{tenantId}/batch"},{"label":"Returns a program group from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/program-groups/deleteprogramgroup","routeSlug":"/apis/certifications/certifications-v1/program-groups/deleteprogramgroup","metadata":{"seo":{"title":"Returns a program group from the system by its ID.","description":"This method will delete a program group with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProgramGroup","name":"Returns a program group from the system by its ID.","isWebhook":false,"pointer":"/paths/~1programGroups~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a program group from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a program group with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the program group to delete.","required":true}],"pointer":"/paths/~1programGroups~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/programGroups/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/programGroups/{tenantId}/{id}","href":"program-groups/deleteprogramgroup","openApiOperationId":"deleteProgramGroup","summary":"Returns a program group from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The program group was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The program group could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The program group could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete program group based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1programGroups~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/program-groups/deleteprogramgroup"}],"panels":[]}]},"httpPath":"/programGroups/{tenantId}/{id}"},{"label":"Returns a program group from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/program-groups/getprogramgroup","routeSlug":"/apis/certifications/certifications-v1/program-groups/getprogramgroup","metadata":{"seo":{"title":"Returns a program group from the system by its ID.","description":"This method will look up a program group by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProgramGroup","name":"Returns a program group from the system by its ID.","isWebhook":false,"pointer":"/paths/~1programGroups~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a program group from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a program group by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the program group to return.","required":true}],"pointer":"/paths/~1programGroups~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1programGroups~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/programGroups/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/programGroups/{tenantId}/{id}","href":"program-groups/getprogramgroup","openApiOperationId":"getProgramGroup","summary":"Returns a program group from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The program group was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProgramGroup"}},"schemaId":"components/schemas/ProgramGroup","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The program group could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve program group based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1programGroups~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProgramGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProgramGroup"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/program-groups/getprogramgroup"}],"panels":[]}]},"httpPath":"/programGroups/{tenantId}/{id}"},{"label":"Partially updates a program group with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/program-groups/patchprogramgroup","routeSlug":"/apis/certifications/certifications-v1/program-groups/patchprogramgroup","metadata":{"seo":{"title":"Partially updates a program group with the specified ID.","description":"This method will patch an existing program group with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchProgramGroup","name":"Partially updates a program group with the specified ID.","isWebhook":false,"pointer":"/paths/~1programGroups~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a program group with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing program group with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the program group to patch.","required":true}],"pointer":"/paths/~1programGroups~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1programGroups~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/programGroups/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/programGroups/{tenantId}/{id}","href":"program-groups/patchprogramgroup","openApiOperationId":"patchProgramGroup","summary":"Partially updates a program group with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The program group was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProgramGroup"}},"schemaId":"components/schemas/ProgramGroup","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The program group could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The program group could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve program group based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1programGroups~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProgramGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProgramGroup"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/program-groups/patchprogramgroup"}],"panels":[]}]},"httpPath":"/programGroups/{tenantId}/{id}"},{"label":"Updates a program group with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/program-groups/updateprogramgroup","routeSlug":"/apis/certifications/certifications-v1/program-groups/updateprogramgroup","metadata":{"seo":{"title":"Updates a program group with the specified ID.","description":"This method will update an existing program group with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProgramGroup","name":"Updates a program group with the specified ID.","isWebhook":false,"pointer":"/paths/~1programGroups~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a program group with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing program group with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the program group to update.","required":true}],"pointer":"/paths/~1programGroups~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProgramGroup"}},"schemaId":"components/schemas/ProgramGroup","pointer":"/paths/~1programGroups~1{tenantId}~1{id}/put/requestBody","description":"The updated program group that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/programGroups/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProgramGroup"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/programGroups/{tenantId}/{id}","href":"program-groups/updateprogramgroup","openApiOperationId":"updateProgramGroup","summary":"Updates a program group with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProgramGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProgramGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The program group was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProgramGroup"}},"schemaId":"components/schemas/ProgramGroup","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The program group supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The program group could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The program group could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve program group based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1programGroups~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProgramGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProgramGroup"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/program-groups/updateprogramgroup"}],"panels":[]}]},"httpPath":"/programGroups/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Program Groups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Program Groups","showPageActions":true},{"nodeType":"markdoc","content":"Program Groups"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/programGroups/{tenantId}","summary":"Gets all of the program groups in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/program-groups/listprogramgroups","deprecated":false},{"title":"/programGroups/{tenantId}","summary":"Creates a new program group record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/program-groups/createprogramgroup","deprecated":false},{"title":"/programGroups/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/program-groups/executebatchoperations","deprecated":false},{"title":"/programGroups/{tenantId}/{id}","summary":"Returns a program group from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/program-groups/deleteprogramgroup","deprecated":false},{"title":"/programGroups/{tenantId}/{id}","summary":"Returns a program group from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/program-groups/getprogramgroup","deprecated":false},{"title":"/programGroups/{tenantId}/{id}","summary":"Partially updates a program group with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/program-groups/patchprogramgroup","deprecated":false},{"title":"/programGroups/{tenantId}/{id}","summary":"Updates a program group with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/program-groups/updateprogramgroup","deprecated":false}]}]}]}]}},{"type":"group","label":"Programs","link":"/apis/certifications/certifications-v1/programs","routeSlug":"/apis/certifications/certifications-v1/programs","items":[{"label":"Gets all of the programs in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/programs/listprograms","routeSlug":"/apis/certifications/certifications-v1/programs/listprograms","metadata":{"seo":{"title":"Gets all of the programs in the system.","description":"This method will scan all programs and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPrograms","name":"Gets all of the programs in the system.","isWebhook":false,"pointer":"/paths/~1programs~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the programs in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all programs and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1programs~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1programs~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/programs/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/programs/{tenantId}","href":"programs/listprograms","openApiOperationId":"listPrograms","summary":"Gets all of the programs in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The programswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_402"}},"schemaId":"schema_402","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1programs~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_402","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_402"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/programs/listprograms"}],"panels":[]}]},"httpPath":"/programs/{tenantId}"},{"label":"Creates a new program record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/programs/createprogram","routeSlug":"/apis/certifications/certifications-v1/programs/createprogram","metadata":{"seo":{"title":"Creates a new program record that does not already exist.","description":"This method will auto-generate an ID and create a new program. If an ID is specified for the program, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProgram","name":"Creates a new program record that does not already exist.","isWebhook":false,"pointer":"/paths/~1programs~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new program record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new program. If an ID is specified for the program, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1programs~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Program"}},"schemaId":"components/schemas/Program","pointer":"/paths/~1programs~1{tenantId}/post/requestBody","description":"The program that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/programs/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Program"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/programs/{tenantId}","href":"programs/createprogram","openApiOperationId":"createProgram","summary":"Creates a new program record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Program","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Program"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The program was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Program"}},"schemaId":"components/schemas/Program","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The program you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The program could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add program based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1programs~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Program","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Program"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/programs/createprogram"}],"panels":[]}]},"httpPath":"/programs/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/programs/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/programs/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1programs~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1programs~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1programs~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/programs/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/programs/{tenantId}/batch","href":"programs/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The program could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve program based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1programs~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/programs/executebatchoperations"}],"panels":[]}]},"httpPath":"/programs/{tenantId}/batch"},{"label":"Gets all of the programs in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/programs/listallprogramspublic","routeSlug":"/apis/certifications/certifications-v1/programs/listallprogramspublic","metadata":{"seo":{"title":"Gets all of the programs in the system.","description":"This method will scan all programs and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAllProgramsPublic","name":"Gets all of the programs in the system.","isWebhook":false,"pointer":"/paths/~1programs~1{tenantId}~1public/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the programs in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all programs and and return them to the caller."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1programs~1{tenantId}~1public/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1programs~1{tenantId}~1public/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/programs/{tenantId}/public","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/programs/{tenantId}/public","href":"programs/listallprogramspublic","openApiOperationId":"listAllProgramsPublic","summary":"Gets all of the programs in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The programswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_402"}},"schemaId":"schema_402","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1programs~1{tenantId}~1public/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_402","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_402"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/programs/listallprogramspublic"}],"panels":[]}]},"httpPath":"/programs/{tenantId}/public"},{"label":"Returns a program from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/programs/deleteprogram","routeSlug":"/apis/certifications/certifications-v1/programs/deleteprogram","metadata":{"seo":{"title":"Returns a program from the system by its ID.","description":"This method will delete a program with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProgram","name":"Returns a program from the system by its ID.","isWebhook":false,"pointer":"/paths/~1programs~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a program from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a program with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the program to delete.","required":true}],"pointer":"/paths/~1programs~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/programs/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/programs/{tenantId}/{id}","href":"programs/deleteprogram","openApiOperationId":"deleteProgram","summary":"Returns a program from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The program was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The program could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The program could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete program based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1programs~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/programs/deleteprogram"}],"panels":[]}]},"httpPath":"/programs/{tenantId}/{id}"},{"label":"Returns a program from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/programs/getprogram","routeSlug":"/apis/certifications/certifications-v1/programs/getprogram","metadata":{"seo":{"title":"Returns a program from the system by its ID.","description":"This method will look up a program by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProgram","name":"Returns a program from the system by its ID.","isWebhook":false,"pointer":"/paths/~1programs~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a program from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a program by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the program to return.","required":true}],"pointer":"/paths/~1programs~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1programs~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/programs/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/programs/{tenantId}/{id}","href":"programs/getprogram","openApiOperationId":"getProgram","summary":"Returns a program from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The program was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Program"}},"schemaId":"components/schemas/Program","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The program could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve program based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1programs~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Program","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Program"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/programs/getprogram"}],"panels":[]}]},"httpPath":"/programs/{tenantId}/{id}"},{"label":"Partially updates a program with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/programs/patchprogram","routeSlug":"/apis/certifications/certifications-v1/programs/patchprogram","metadata":{"seo":{"title":"Partially updates a program with the specified ID.","description":"This method will patch an existing program with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchProgram","name":"Partially updates a program with the specified ID.","isWebhook":false,"pointer":"/paths/~1programs~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a program with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing program with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the program to patch.","required":true}],"pointer":"/paths/~1programs~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1programs~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/programs/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/programs/{tenantId}/{id}","href":"programs/patchprogram","openApiOperationId":"patchProgram","summary":"Partially updates a program with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The program was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Program"}},"schemaId":"components/schemas/Program","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The program could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The program could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve program based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1programs~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Program","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Program"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/programs/patchprogram"}],"panels":[]}]},"httpPath":"/programs/{tenantId}/{id}"},{"label":"Updates a program with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/programs/updateprogram","routeSlug":"/apis/certifications/certifications-v1/programs/updateprogram","metadata":{"seo":{"title":"Updates a program with the specified ID.","description":"This method will update an existing program with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProgram","name":"Updates a program with the specified ID.","isWebhook":false,"pointer":"/paths/~1programs~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a program with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing program with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the program to update.","required":true}],"pointer":"/paths/~1programs~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Program"}},"schemaId":"components/schemas/Program","pointer":"/paths/~1programs~1{tenantId}~1{id}/put/requestBody","description":"The updated program that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/programs/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Program"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/programs/{tenantId}/{id}","href":"programs/updateprogram","openApiOperationId":"updateProgram","summary":"Updates a program with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Program","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Program"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The program was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Program"}},"schemaId":"components/schemas/Program","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The program supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The program could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The program could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve program based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1programs~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Program","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Program"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/programs/updateprogram"}],"panels":[]}]},"httpPath":"/programs/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Programs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Programs","showPageActions":true},{"nodeType":"markdoc","content":"Programs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/programs/{tenantId}","summary":"Gets all of the programs in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/programs/listprograms","deprecated":false},{"title":"/programs/{tenantId}","summary":"Creates a new program record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/programs/createprogram","deprecated":false},{"title":"/programs/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/programs/executebatchoperations","deprecated":false},{"title":"/programs/{tenantId}/public","summary":"Gets all of the programs in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/programs/listallprogramspublic","deprecated":false},{"title":"/programs/{tenantId}/{id}","summary":"Returns a program from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/programs/deleteprogram","deprecated":false},{"title":"/programs/{tenantId}/{id}","summary":"Returns a program from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/programs/getprogram","deprecated":false},{"title":"/programs/{tenantId}/{id}","summary":"Partially updates a program with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/programs/patchprogram","deprecated":false},{"title":"/programs/{tenantId}/{id}","summary":"Updates a program with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/programs/updateprogram","deprecated":false}]}]}]}]}},{"type":"group","label":"Project Types","link":"/apis/certifications/certifications-v1/project-types","routeSlug":"/apis/certifications/certifications-v1/project-types","items":[{"label":"Gets all of the project types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/project-types/listprojecttypes","routeSlug":"/apis/certifications/certifications-v1/project-types/listprojecttypes","metadata":{"seo":{"title":"Gets all of the project types in the system.","description":"This method will scan all project types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProjectTypes","name":"Gets all of the project types in the system.","isWebhook":false,"pointer":"/paths/~1projectTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the project types in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all project types and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1projectTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1projectTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projectTypes/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/projectTypes/{tenantId}","href":"project-types/listprojecttypes","openApiOperationId":"listProjectTypes","summary":"Gets all of the project types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The project typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403"}},"schemaId":"schema_403","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1projectTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-types/listprojecttypes"}],"panels":[]}]},"httpPath":"/projectTypes/{tenantId}"},{"label":"Creates a new project type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/project-types/createprojecttype","routeSlug":"/apis/certifications/certifications-v1/project-types/createprojecttype","metadata":{"seo":{"title":"Creates a new project type record that does not already exist.","description":"This method will auto-generate an ID and create a new project type. If an ID is specified for the project type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProjectType","name":"Creates a new project type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1projectTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new project type record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new project type. If an ID is specified for the project type, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1projectTypes~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProjectType"}},"schemaId":"components/schemas/ProjectType","pointer":"/paths/~1projectTypes~1{tenantId}/post/requestBody","description":"The project type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/projectTypes/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProjectType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/projectTypes/{tenantId}","href":"project-types/createprojecttype","openApiOperationId":"createProjectType","summary":"Creates a new project type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProjectType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProjectType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The project type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectType"}},"schemaId":"components/schemas/ProjectType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The project type you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The project type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add project type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1projectTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-types/createprojecttype"}],"panels":[]}]},"httpPath":"/projectTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/project-types/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/project-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1projectTypes~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1projectTypes~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1projectTypes~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/projectTypes/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/projectTypes/{tenantId}/batch","href":"project-types/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The project type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve project type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1projectTypes~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-types/executebatchoperations"}],"panels":[]}]},"httpPath":"/projectTypes/{tenantId}/batch"},{"label":"Returns a project type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/project-types/deleteprojecttype","routeSlug":"/apis/certifications/certifications-v1/project-types/deleteprojecttype","metadata":{"seo":{"title":"Returns a project type from the system by its ID.","description":"This method will delete a project type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProjectType","name":"Returns a project type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1projectTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a project type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a project type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the project type to delete.","required":true}],"pointer":"/paths/~1projectTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/projectTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/projectTypes/{tenantId}/{id}","href":"project-types/deleteprojecttype","openApiOperationId":"deleteProjectType","summary":"Returns a project type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The project type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The project type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The project type could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete project type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1projectTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-types/deleteprojecttype"}],"panels":[]}]},"httpPath":"/projectTypes/{tenantId}/{id}"},{"label":"Returns a project type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/project-types/getprojecttype","routeSlug":"/apis/certifications/certifications-v1/project-types/getprojecttype","metadata":{"seo":{"title":"Returns a project type from the system by its ID.","description":"This method will look up a project type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProjectType","name":"Returns a project type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1projectTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a project type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a project type by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the project type to return.","required":true}],"pointer":"/paths/~1projectTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1projectTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/projectTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/projectTypes/{tenantId}/{id}","href":"project-types/getprojecttype","openApiOperationId":"getProjectType","summary":"Returns a project type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The project type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectType"}},"schemaId":"components/schemas/ProjectType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The project type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve project type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1projectTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-types/getprojecttype"}],"panels":[]}]},"httpPath":"/projectTypes/{tenantId}/{id}"},{"label":"Partially updates a project type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/project-types/patchprojecttype","routeSlug":"/apis/certifications/certifications-v1/project-types/patchprojecttype","metadata":{"seo":{"title":"Partially updates a project type with the specified ID.","description":"This method will patch an existing project type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchProjectType","name":"Partially updates a project type with the specified ID.","isWebhook":false,"pointer":"/paths/~1projectTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a project type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing project type with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the project type to patch.","required":true}],"pointer":"/paths/~1projectTypes~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1projectTypes~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/projectTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/projectTypes/{tenantId}/{id}","href":"project-types/patchprojecttype","openApiOperationId":"patchProjectType","summary":"Partially updates a project type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The project type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectType"}},"schemaId":"components/schemas/ProjectType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The project type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The project type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve project type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1projectTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-types/patchprojecttype"}],"panels":[]}]},"httpPath":"/projectTypes/{tenantId}/{id}"},{"label":"Updates a project type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/project-types/updateprojecttype","routeSlug":"/apis/certifications/certifications-v1/project-types/updateprojecttype","metadata":{"seo":{"title":"Updates a project type with the specified ID.","description":"This method will update an existing project type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProjectType","name":"Updates a project type with the specified ID.","isWebhook":false,"pointer":"/paths/~1projectTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a project type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing project type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the project type to update.","required":true}],"pointer":"/paths/~1projectTypes~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProjectType"}},"schemaId":"components/schemas/ProjectType","pointer":"/paths/~1projectTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated project type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/projectTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProjectType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/projectTypes/{tenantId}/{id}","href":"project-types/updateprojecttype","openApiOperationId":"updateProjectType","summary":"Updates a project type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProjectType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProjectType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The project type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectType"}},"schemaId":"components/schemas/ProjectType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The project type supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The project type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The project type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve project type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1projectTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProjectType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/project-types/updateprojecttype"}],"panels":[]}]},"httpPath":"/projectTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Project Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Project Types","showPageActions":true},{"nodeType":"markdoc","content":"Project Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/projectTypes/{tenantId}","summary":"Gets all of the project types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-types/listprojecttypes","deprecated":false},{"title":"/projectTypes/{tenantId}","summary":"Creates a new project type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-types/createprojecttype","deprecated":false},{"title":"/projectTypes/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/project-types/executebatchoperations","deprecated":false},{"title":"/projectTypes/{tenantId}/{id}","summary":"Returns a project type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/project-types/deleteprojecttype","deprecated":false},{"title":"/projectTypes/{tenantId}/{id}","summary":"Returns a project type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/project-types/getprojecttype","deprecated":false},{"title":"/projectTypes/{tenantId}/{id}","summary":"Partially updates a project type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/project-types/patchprojecttype","deprecated":false},{"title":"/projectTypes/{tenantId}/{id}","summary":"Updates a project type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/project-types/updateprojecttype","deprecated":false}]}]}]}]}},{"type":"group","label":"Query Definitions","link":"/apis/certifications/certifications-v1/query-definitions","routeSlug":"/apis/certifications/certifications-v1/query-definitions","items":[{"label":"Returns a list of records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/query-definitions/getquerydefinitions","routeSlug":"/apis/certifications/certifications-v1/query-definitions/getquerydefinitions","metadata":{"seo":{"title":"Returns a list of records","description":"Returns a list of records"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQueryDefinitions","name":"Returns a list of records","isWebhook":false,"pointer":"/paths/~1queryDefinitions~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of records"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true}],"pointer":"/paths/~1queryDefinitions~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/queryDefinitions/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/queryDefinitions/{tenantId}","href":"query-definitions/getquerydefinitions","openApiOperationId":"getQueryDefinitions","summary":"Returns a list of records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStandardQueryDefinitionsResponse"}},"schemaId":"components/schemas/ListStandardQueryDefinitionsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1queryDefinitions~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListStandardQueryDefinitionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStandardQueryDefinitionsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/query-definitions/getquerydefinitions"}],"panels":[]}]},"httpPath":"/queryDefinitions/{tenantId}"}],"content":{"contentType":"group","meta":{"name":"Query Definitions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Definitions","showPageActions":true},{"nodeType":"markdoc","content":"Query Definitions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/queryDefinitions/{tenantId}","summary":"Returns a list of records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/query-definitions/getquerydefinitions","deprecated":false}]}]}]}]}},{"type":"group","label":"Recurring Billing Runs","link":"/apis/certifications/certifications-v1/recurring-billing-runs","routeSlug":"/apis/certifications/certifications-v1/recurring-billing-runs","items":[{"label":"Gets all of the recurring billing runs in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/recurring-billing-runs/listrecurringbillingruns","routeSlug":"/apis/certifications/certifications-v1/recurring-billing-runs/listrecurringbillingruns","metadata":{"seo":{"title":"Gets all of the recurring billing runs in the system.","description":"This method will scan all recurring billing runs and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRecurringBillingRuns","name":"Gets all of the recurring billing runs in the system.","isWebhook":false,"pointer":"/paths/~1recurringBillingRuns~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the recurring billing runs in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all recurring billing runs and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/recurringBillingRuns/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringBillingRuns/{tenantId}","href":"recurring-billing-runs/listrecurringbillingruns","openApiOperationId":"listRecurringBillingRuns","summary":"Gets all of the recurring billing runs in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring billing runswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_404"}},"schemaId":"schema_404","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_404","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_404"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-billing-runs/listrecurringbillingruns"}],"panels":[]}]},"httpPath":"/recurringBillingRuns/{tenantId}"},{"label":"Creates a new recurring billing run record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/recurring-billing-runs/createrecurringbillingrun","routeSlug":"/apis/certifications/certifications-v1/recurring-billing-runs/createrecurringbillingrun","metadata":{"seo":{"title":"Creates a new recurring billing run record that does not already exist.","description":"This method will auto-generate an ID and create a new recurring billing run. If an ID is specified for the recurring billing run, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRecurringBillingRun","name":"Creates a new recurring billing run record that does not already exist.","isWebhook":false,"pointer":"/paths/~1recurringBillingRuns~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new recurring billing run record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new recurring billing run. If an ID is specified for the recurring billing run, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"schemaId":"components/schemas/RecurringBillingRun","pointer":"/paths/~1recurringBillingRuns~1{tenantId}/post/requestBody","description":"The recurring billing run that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/recurringBillingRuns/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringBillingRuns/{tenantId}","href":"recurring-billing-runs/createrecurringbillingrun","openApiOperationId":"createRecurringBillingRun","summary":"Creates a new recurring billing run record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RecurringBillingRun","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring billing run was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"schemaId":"components/schemas/RecurringBillingRun","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The recurring billing run you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The recurring billing run could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add recurring billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecurringBillingRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-billing-runs/createrecurringbillingrun"}],"panels":[]}]},"httpPath":"/recurringBillingRuns/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/recurring-billing-runs/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/recurring-billing-runs/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/recurringBillingRuns/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringBillingRuns/{tenantId}/batch","href":"recurring-billing-runs/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The recurring billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve recurring billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-billing-runs/executebatchoperations"}],"panels":[]}]},"httpPath":"/recurringBillingRuns/{tenantId}/batch"},{"label":"Returns a list of records with the specified template_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/recurring-billing-runs/listrunsbytemplateid","routeSlug":"/apis/certifications/certifications-v1/recurring-billing-runs/listrunsbytemplateid","metadata":{"seo":{"title":"Returns a list of records with the specified template_id","description":"Returns a list of records with the specified template_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRunsByTemplateId","name":"Returns a list of records with the specified template_id","isWebhook":false,"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1template~1{template_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified template_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified template_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"template_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The template_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1template~1{template_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1template~1{template_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/recurringBillingRuns/{tenantId}/template/{template_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"template_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringBillingRuns/{tenantId}/template/{template_id}","href":"recurring-billing-runs/listrunsbytemplateid","openApiOperationId":"listRunsByTemplateId","summary":"Returns a list of records with the specified template_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRecurringBillingRunsResponse"}},"schemaId":"components/schemas/ListRecurringBillingRunsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1template~1{template_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRecurringBillingRunsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRecurringBillingRunsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-billing-runs/listrunsbytemplateid"}],"panels":[]}]},"httpPath":"/recurringBillingRuns/{tenantId}/template/{template_id}"},{"label":"Returns a recurring billing run from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/recurring-billing-runs/deleterecurringbillingrun","routeSlug":"/apis/certifications/certifications-v1/recurring-billing-runs/deleterecurringbillingrun","metadata":{"seo":{"title":"Returns a recurring billing run from the system by its ID.","description":"This method will delete a recurring billing run with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRecurringBillingRun","name":"Returns a recurring billing run from the system by its ID.","isWebhook":false,"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a recurring billing run from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a recurring billing run with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the recurring billing run to delete.","required":true}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/recurringBillingRuns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringBillingRuns/{tenantId}/{id}","href":"recurring-billing-runs/deleterecurringbillingrun","openApiOperationId":"deleteRecurringBillingRun","summary":"Returns a recurring billing run from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring billing run was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The recurring billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The recurring billing run could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete recurring billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-billing-runs/deleterecurringbillingrun"}],"panels":[]}]},"httpPath":"/recurringBillingRuns/{tenantId}/{id}"},{"label":"Returns a recurring billing run from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/recurring-billing-runs/getrecurringbillingrun","routeSlug":"/apis/certifications/certifications-v1/recurring-billing-runs/getrecurringbillingrun","metadata":{"seo":{"title":"Returns a recurring billing run from the system by its ID.","description":"This method will look up a recurring billing run by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRecurringBillingRun","name":"Returns a recurring billing run from the system by its ID.","isWebhook":false,"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a recurring billing run from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a recurring billing run by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the recurring billing run to return.","required":true}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/recurringBillingRuns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringBillingRuns/{tenantId}/{id}","href":"recurring-billing-runs/getrecurringbillingrun","openApiOperationId":"getRecurringBillingRun","summary":"Returns a recurring billing run from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring billing run was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"schemaId":"components/schemas/RecurringBillingRun","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The recurring billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve recurring billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecurringBillingRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-billing-runs/getrecurringbillingrun"}],"panels":[]}]},"httpPath":"/recurringBillingRuns/{tenantId}/{id}"},{"label":"Partially updates a recurring billing run with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/recurring-billing-runs/patchrecurringbillingrun","routeSlug":"/apis/certifications/certifications-v1/recurring-billing-runs/patchrecurringbillingrun","metadata":{"seo":{"title":"Partially updates a recurring billing run with the specified ID.","description":"This method will patch an existing recurring billing run with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchRecurringBillingRun","name":"Partially updates a recurring billing run with the specified ID.","isWebhook":false,"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a recurring billing run with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing recurring billing run with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the recurring billing run to patch.","required":true}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/recurringBillingRuns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringBillingRuns/{tenantId}/{id}","href":"recurring-billing-runs/patchrecurringbillingrun","openApiOperationId":"patchRecurringBillingRun","summary":"Partially updates a recurring billing run with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring billing run was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"schemaId":"components/schemas/RecurringBillingRun","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The recurring billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The recurring billing run could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve recurring billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecurringBillingRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-billing-runs/patchrecurringbillingrun"}],"panels":[]}]},"httpPath":"/recurringBillingRuns/{tenantId}/{id}"},{"label":"Updates a recurring billing run with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/recurring-billing-runs/updaterecurringbillingrun","routeSlug":"/apis/certifications/certifications-v1/recurring-billing-runs/updaterecurringbillingrun","metadata":{"seo":{"title":"Updates a recurring billing run with the specified ID.","description":"This method will update an existing recurring billing run with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRecurringBillingRun","name":"Updates a recurring billing run with the specified ID.","isWebhook":false,"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a recurring billing run with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing recurring billing run with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the recurring billing run to update.","required":true}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"schemaId":"components/schemas/RecurringBillingRun","pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/put/requestBody","description":"The updated recurring billing run that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/recurringBillingRuns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringBillingRuns/{tenantId}/{id}","href":"recurring-billing-runs/updaterecurringbillingrun","openApiOperationId":"updateRecurringBillingRun","summary":"Updates a recurring billing run with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RecurringBillingRun","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring billing run was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"schemaId":"components/schemas/RecurringBillingRun","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The recurring billing run supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The recurring billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The recurring billing run could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve recurring billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecurringBillingRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-billing-runs/updaterecurringbillingrun"}],"panels":[]}]},"httpPath":"/recurringBillingRuns/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Recurring Billing Runs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recurring Billing Runs","showPageActions":true},{"nodeType":"markdoc","content":"Recurring Billing Runs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/recurringBillingRuns/{tenantId}","summary":"Gets all of the recurring billing runs in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recurring-billing-runs/listrecurringbillingruns","deprecated":false},{"title":"/recurringBillingRuns/{tenantId}","summary":"Creates a new recurring billing run record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/recurring-billing-runs/createrecurringbillingrun","deprecated":false},{"title":"/recurringBillingRuns/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/recurring-billing-runs/executebatchoperations","deprecated":false},{"title":"/recurringBillingRuns/{tenantId}/template/{template_id}","summary":"Returns a list of records with the specified template_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recurring-billing-runs/listrunsbytemplateid","deprecated":false},{"title":"/recurringBillingRuns/{tenantId}/{id}","summary":"Returns a recurring billing run from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/recurring-billing-runs/deleterecurringbillingrun","deprecated":false},{"title":"/recurringBillingRuns/{tenantId}/{id}","summary":"Returns a recurring billing run from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recurring-billing-runs/getrecurringbillingrun","deprecated":false},{"title":"/recurringBillingRuns/{tenantId}/{id}","summary":"Partially updates a recurring billing run with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/recurring-billing-runs/patchrecurringbillingrun","deprecated":false},{"title":"/recurringBillingRuns/{tenantId}/{id}","summary":"Updates a recurring billing run with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/recurring-billing-runs/updaterecurringbillingrun","deprecated":false}]}]}]}]}},{"type":"group","label":"Settings","link":"/apis/certifications/certifications-v1/settings","routeSlug":"/apis/certifications/certifications-v1/settings","items":[{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/settings/deletesetting","routeSlug":"/apis/certifications/certifications-v1/settings/deletesetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will delete a setting with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSetting","name":"Returns a setting from the system by its ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a setting from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a setting with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/deletesetting","openApiOperationId":"deleteSetting","summary":"Returns a setting from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The setting could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1settings~1{tenantId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/deletesetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/settings/getsetting","routeSlug":"/apis/certifications/certifications-v1/settings/getsetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will look up a setting by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSetting","name":"Returns a setting from the system by its ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a setting from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a setting by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1settings~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/settings/{tenantId}","href":"settings/getsetting","openApiOperationId":"getSetting","summary":"Returns a setting from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1settings~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/getsetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Partially updates a setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/settings/patchsetting","routeSlug":"/apis/certifications/certifications-v1/settings/patchsetting","metadata":{"seo":{"title":"Partially updates a setting with the specified ID.","description":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSetting","name":"Partially updates a setting with the specified ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a setting with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1settings~1{tenantId}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/patchsetting","openApiOperationId":"patchSetting","summary":"Partially updates a setting with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1settings~1{tenantId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/patchsetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Creates a new setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/settings/createsetting","routeSlug":"/apis/certifications/certifications-v1/settings/createsetting","metadata":{"seo":{"title":"Creates a new setting record that does not already exist.","description":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSetting","name":"Creates a new setting record that does not already exist.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new setting record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","pointer":"/paths/~1settings~1{tenantId}/post/requestBody","description":"The setting that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Setting"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/createsetting","openApiOperationId":"createSetting","summary":"Creates a new setting record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The setting you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1settings~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/createsetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Updates a setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/settings/updatesetting","routeSlug":"/apis/certifications/certifications-v1/settings/updatesetting","metadata":{"seo":{"title":"Updates a setting with the specified ID.","description":"This method will update an existing setting with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSetting","name":"Updates a setting with the specified ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a setting with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing setting with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","pointer":"/paths/~1settings~1{tenantId}/put/requestBody","description":"The updated setting that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Setting"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/updatesetting","openApiOperationId":"updateSetting","summary":"Updates a setting with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The setting supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1settings~1{tenantId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/updatesetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"}],"content":{"contentType":"group","meta":{"name":"Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settings","showPageActions":true},{"nodeType":"markdoc","content":"Settings"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settings/{tenantId}","summary":"Returns a setting from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/settings/deletesetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Returns a setting from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settings/getsetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Partially updates a setting with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/settings/patchsetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Creates a new setting record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/settings/createsetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Updates a setting with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/settings/updatesetting","deprecated":false}]}]}]}]}},{"type":"group","label":"Statistics","link":"/apis/certifications/certifications-v1/statistics","routeSlug":"/apis/certifications/certifications-v1/statistics","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/statistics/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/statistics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1statistics~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1statistics~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1statistics~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/statistics/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statistics/{tenantId}/batch","href":"statistics/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The statistic could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve statistic based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1statistics~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/executebatchoperations"}],"panels":[]}]},"httpPath":"/statistics/{tenantId}/batch"},{"label":"Returns a statistic from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/statistics/getstatistic","routeSlug":"/apis/certifications/certifications-v1/statistics/getstatistic","metadata":{"seo":{"title":"Returns a statistic from the system by its ID.","description":"This method will look up a statistic by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStatistic","name":"Returns a statistic from the system by its ID.","isWebhook":false,"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a statistic from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a statistic by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the statistic to return.","required":true}],"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"parameters","in":"query","schemaId":"schema_366","description":"Parameters to the query"},{"name":"recalculate","in":"query","schemaId":"schema_383","description":"If true, the latest statistic will be calculated and the cache will be updated"}],"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/statistics/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"parameters","in":"query","required":false,"schemaId":"schema_366"},{"name":"recalculate","in":"query","required":false,"schemaId":"schema_383"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statistics/{tenantId}/{id}","href":"statistics/getstatistic","openApiOperationId":"getStatistic","summary":"Returns a statistic from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The statistic was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statistic"}},"schemaId":"components/schemas/Statistic","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The statistic could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve statistic based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Statistic","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statistic"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/getstatistic"}],"panels":[]}]},"httpPath":"/statistics/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Statistics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Statistics","showPageActions":true},{"nodeType":"markdoc","content":"Statistics"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/statistics/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/statistics/executebatchoperations","deprecated":false},{"title":"/statistics/{tenantId}/{id}","summary":"Returns a statistic from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statistics/getstatistic","deprecated":false}]}]}]}]}},{"type":"group","label":"Status Reasons","link":"/apis/certifications/certifications-v1/status-reasons","routeSlug":"/apis/certifications/certifications-v1/status-reasons","items":[{"label":"Gets all of the status reasons in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/status-reasons/liststatusreasons","routeSlug":"/apis/certifications/certifications-v1/status-reasons/liststatusreasons","metadata":{"seo":{"title":"Gets all of the status reasons in the system.","description":"This method will scan all status reasons and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listStatusReasons","name":"Gets all of the status reasons in the system.","isWebhook":false,"pointer":"/paths/~1statusReasons~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the status reasons in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all status reasons and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1statusReasons~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1statusReasons~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/statusReasons/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statusReasons/{tenantId}","href":"status-reasons/liststatusreasons","openApiOperationId":"listStatusReasons","summary":"Gets all of the status reasons in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The status reasonswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}},"schemaId":"schema_405","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1statusReasons~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_405","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_405"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status-reasons/liststatusreasons"}],"panels":[]}]},"httpPath":"/statusReasons/{tenantId}"},{"label":"Creates a new status reason record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/status-reasons/createstatusreason","routeSlug":"/apis/certifications/certifications-v1/status-reasons/createstatusreason","metadata":{"seo":{"title":"Creates a new status reason record that does not already exist.","description":"This method will auto-generate an ID and create a new status reason. If an ID is specified for the status reason, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createStatusReason","name":"Creates a new status reason record that does not already exist.","isWebhook":false,"pointer":"/paths/~1statusReasons~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new status reason record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new status reason. If an ID is specified for the status reason, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1statusReasons~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusReason"}},"schemaId":"components/schemas/StatusReason","pointer":"/paths/~1statusReasons~1{tenantId}/post/requestBody","description":"The status reason that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/statusReasons/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StatusReason"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/statusReasons/{tenantId}","href":"status-reasons/createstatusreason","openApiOperationId":"createStatusReason","summary":"Creates a new status reason record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/StatusReason","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusReason"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The status reason was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatusReason"}},"schemaId":"components/schemas/StatusReason","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The status reason you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The status reason could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add status reason based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1statusReasons~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatusReason","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatusReason"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status-reasons/createstatusreason"}],"panels":[]}]},"httpPath":"/statusReasons/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/status-reasons/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/status-reasons/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1statusReasons~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1statusReasons~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1statusReasons~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/statusReasons/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statusReasons/{tenantId}/batch","href":"status-reasons/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The status reason could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve status reason based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1statusReasons~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status-reasons/executebatchoperations"}],"panels":[]}]},"httpPath":"/statusReasons/{tenantId}/batch"},{"label":"Returns a status reason from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/status-reasons/deletestatusreason","routeSlug":"/apis/certifications/certifications-v1/status-reasons/deletestatusreason","metadata":{"seo":{"title":"Returns a status reason from the system by its ID.","description":"This method will delete a status reason with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteStatusReason","name":"Returns a status reason from the system by its ID.","isWebhook":false,"pointer":"/paths/~1statusReasons~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a status reason from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a status reason with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the status reason to delete.","required":true}],"pointer":"/paths/~1statusReasons~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/statusReasons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/statusReasons/{tenantId}/{id}","href":"status-reasons/deletestatusreason","openApiOperationId":"deleteStatusReason","summary":"Returns a status reason from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The status reason was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The status reason could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The status reason could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete status reason based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1statusReasons~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status-reasons/deletestatusreason"}],"panels":[]}]},"httpPath":"/statusReasons/{tenantId}/{id}"},{"label":"Returns a status reason from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/status-reasons/getstatusreason","routeSlug":"/apis/certifications/certifications-v1/status-reasons/getstatusreason","metadata":{"seo":{"title":"Returns a status reason from the system by its ID.","description":"This method will look up a status reason by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStatusReason","name":"Returns a status reason from the system by its ID.","isWebhook":false,"pointer":"/paths/~1statusReasons~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a status reason from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a status reason by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the status reason to return.","required":true}],"pointer":"/paths/~1statusReasons~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1statusReasons~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/statusReasons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statusReasons/{tenantId}/{id}","href":"status-reasons/getstatusreason","openApiOperationId":"getStatusReason","summary":"Returns a status reason from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The status reason was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatusReason"}},"schemaId":"components/schemas/StatusReason","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The status reason could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve status reason based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1statusReasons~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatusReason","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatusReason"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status-reasons/getstatusreason"}],"panels":[]}]},"httpPath":"/statusReasons/{tenantId}/{id}"},{"label":"Partially updates a status reason with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/status-reasons/patchstatusreason","routeSlug":"/apis/certifications/certifications-v1/status-reasons/patchstatusreason","metadata":{"seo":{"title":"Partially updates a status reason with the specified ID.","description":"This method will patch an existing status reason with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchStatusReason","name":"Partially updates a status reason with the specified ID.","isWebhook":false,"pointer":"/paths/~1statusReasons~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a status reason with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing status reason with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the status reason to patch.","required":true}],"pointer":"/paths/~1statusReasons~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1statusReasons~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/statusReasons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/statusReasons/{tenantId}/{id}","href":"status-reasons/patchstatusreason","openApiOperationId":"patchStatusReason","summary":"Partially updates a status reason with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The status reason was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatusReason"}},"schemaId":"components/schemas/StatusReason","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The status reason could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The status reason could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve status reason based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1statusReasons~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatusReason","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatusReason"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status-reasons/patchstatusreason"}],"panels":[]}]},"httpPath":"/statusReasons/{tenantId}/{id}"},{"label":"Updates a status reason with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/status-reasons/updatestatusreason","routeSlug":"/apis/certifications/certifications-v1/status-reasons/updatestatusreason","metadata":{"seo":{"title":"Updates a status reason with the specified ID.","description":"This method will update an existing status reason with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateStatusReason","name":"Updates a status reason with the specified ID.","isWebhook":false,"pointer":"/paths/~1statusReasons~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a status reason with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing status reason with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the status reason to update.","required":true}],"pointer":"/paths/~1statusReasons~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusReason"}},"schemaId":"components/schemas/StatusReason","pointer":"/paths/~1statusReasons~1{tenantId}~1{id}/put/requestBody","description":"The updated status reason that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/statusReasons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StatusReason"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/statusReasons/{tenantId}/{id}","href":"status-reasons/updatestatusreason","openApiOperationId":"updateStatusReason","summary":"Updates a status reason with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/StatusReason","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusReason"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The status reason was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatusReason"}},"schemaId":"components/schemas/StatusReason","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The status reason supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The status reason could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The status reason could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve status reason based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1statusReasons~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatusReason","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatusReason"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status-reasons/updatestatusreason"}],"panels":[]}]},"httpPath":"/statusReasons/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Status Reasons"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Status Reasons","showPageActions":true},{"nodeType":"markdoc","content":"Status Reasons"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/statusReasons/{tenantId}","summary":"Gets all of the status reasons in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status-reasons/liststatusreasons","deprecated":false},{"title":"/statusReasons/{tenantId}","summary":"Creates a new status reason record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/status-reasons/createstatusreason","deprecated":false},{"title":"/statusReasons/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/status-reasons/executebatchoperations","deprecated":false},{"title":"/statusReasons/{tenantId}/{id}","summary":"Returns a status reason from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/status-reasons/deletestatusreason","deprecated":false},{"title":"/statusReasons/{tenantId}/{id}","summary":"Returns a status reason from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status-reasons/getstatusreason","deprecated":false},{"title":"/statusReasons/{tenantId}/{id}","summary":"Partially updates a status reason with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/status-reasons/patchstatusreason","deprecated":false},{"title":"/statusReasons/{tenantId}/{id}","summary":"Updates a status reason with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/status-reasons/updatestatusreason","deprecated":false}]}]}]}]}},{"type":"group","label":"Testing Facilities","link":"/apis/certifications/certifications-v1/testing-facilities","routeSlug":"/apis/certifications/certifications-v1/testing-facilities","items":[{"label":"Gets all of the testing facilities in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/testing-facilities/listtestingfacilities","routeSlug":"/apis/certifications/certifications-v1/testing-facilities/listtestingfacilities","metadata":{"seo":{"title":"Gets all of the testing facilities in the system.","description":"This method will scan all testing facilities and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTestingFacilities","name":"Gets all of the testing facilities in the system.","isWebhook":false,"pointer":"/paths/~1testingFacilities~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the testing facilities in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all testing facilities and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1testingFacilities~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1testingFacilities~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/testingFacilities/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/testingFacilities/{tenantId}","href":"testing-facilities/listtestingfacilities","openApiOperationId":"listTestingFacilities","summary":"Gets all of the testing facilities in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The testing facilitieswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_406"}},"schemaId":"schema_406","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1testingFacilities~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_406","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_406"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/testing-facilities/listtestingfacilities"}],"panels":[]}]},"httpPath":"/testingFacilities/{tenantId}"},{"label":"Creates a new testing facility record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/testing-facilities/createtestingfacility","routeSlug":"/apis/certifications/certifications-v1/testing-facilities/createtestingfacility","metadata":{"seo":{"title":"Creates a new testing facility record that does not already exist.","description":"This method will auto-generate an ID and create a new testing facility. If an ID is specified for the testing facility, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTestingFacility","name":"Creates a new testing facility record that does not already exist.","isWebhook":false,"pointer":"/paths/~1testingFacilities~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new testing facility record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new testing facility. If an ID is specified for the testing facility, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1testingFacilities~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TestingFacility"}},"schemaId":"components/schemas/TestingFacility","pointer":"/paths/~1testingFacilities~1{tenantId}/post/requestBody","description":"The testing facility that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/testingFacilities/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TestingFacility"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/testingFacilities/{tenantId}","href":"testing-facilities/createtestingfacility","openApiOperationId":"createTestingFacility","summary":"Creates a new testing facility record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/TestingFacility","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TestingFacility"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The testing facility was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestingFacility"}},"schemaId":"components/schemas/TestingFacility","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The testing facility you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The testing facility could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add testing facility based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1testingFacilities~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TestingFacility","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestingFacility"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/testing-facilities/createtestingfacility"}],"panels":[]}]},"httpPath":"/testingFacilities/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/testing-facilities/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/testing-facilities/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1testingFacilities~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1testingFacilities~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1testingFacilities~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/testingFacilities/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/testingFacilities/{tenantId}/batch","href":"testing-facilities/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The testing facility could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve testing facility based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1testingFacilities~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/testing-facilities/executebatchoperations"}],"panels":[]}]},"httpPath":"/testingFacilities/{tenantId}/batch"},{"label":"Returns a testing facility from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/testing-facilities/deletetestingfacility","routeSlug":"/apis/certifications/certifications-v1/testing-facilities/deletetestingfacility","metadata":{"seo":{"title":"Returns a testing facility from the system by its ID.","description":"This method will delete a testing facility with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTestingFacility","name":"Returns a testing facility from the system by its ID.","isWebhook":false,"pointer":"/paths/~1testingFacilities~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a testing facility from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a testing facility with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the testing facility to delete.","required":true}],"pointer":"/paths/~1testingFacilities~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/testingFacilities/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/testingFacilities/{tenantId}/{id}","href":"testing-facilities/deletetestingfacility","openApiOperationId":"deleteTestingFacility","summary":"Returns a testing facility from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The testing facility was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The testing facility could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The testing facility could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete testing facility based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1testingFacilities~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/testing-facilities/deletetestingfacility"}],"panels":[]}]},"httpPath":"/testingFacilities/{tenantId}/{id}"},{"label":"Returns a testing facility from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/testing-facilities/gettestingfacility","routeSlug":"/apis/certifications/certifications-v1/testing-facilities/gettestingfacility","metadata":{"seo":{"title":"Returns a testing facility from the system by its ID.","description":"This method will look up a testing facility by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTestingFacility","name":"Returns a testing facility from the system by its ID.","isWebhook":false,"pointer":"/paths/~1testingFacilities~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a testing facility from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a testing facility by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the testing facility to return.","required":true}],"pointer":"/paths/~1testingFacilities~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1testingFacilities~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/testingFacilities/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/testingFacilities/{tenantId}/{id}","href":"testing-facilities/gettestingfacility","openApiOperationId":"getTestingFacility","summary":"Returns a testing facility from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The testing facility was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestingFacility"}},"schemaId":"components/schemas/TestingFacility","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The testing facility could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve testing facility based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1testingFacilities~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TestingFacility","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestingFacility"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/testing-facilities/gettestingfacility"}],"panels":[]}]},"httpPath":"/testingFacilities/{tenantId}/{id}"},{"label":"Partially updates a testing facility with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/testing-facilities/patchtestingfacility","routeSlug":"/apis/certifications/certifications-v1/testing-facilities/patchtestingfacility","metadata":{"seo":{"title":"Partially updates a testing facility with the specified ID.","description":"This method will patch an existing testing facility with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchTestingFacility","name":"Partially updates a testing facility with the specified ID.","isWebhook":false,"pointer":"/paths/~1testingFacilities~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a testing facility with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing testing facility with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the testing facility to patch.","required":true}],"pointer":"/paths/~1testingFacilities~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1testingFacilities~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/testingFacilities/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/testingFacilities/{tenantId}/{id}","href":"testing-facilities/patchtestingfacility","openApiOperationId":"patchTestingFacility","summary":"Partially updates a testing facility with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The testing facility was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestingFacility"}},"schemaId":"components/schemas/TestingFacility","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The testing facility could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The testing facility could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve testing facility based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1testingFacilities~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TestingFacility","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestingFacility"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/testing-facilities/patchtestingfacility"}],"panels":[]}]},"httpPath":"/testingFacilities/{tenantId}/{id}"},{"label":"Updates a testing facility with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/testing-facilities/updatetestingfacility","routeSlug":"/apis/certifications/certifications-v1/testing-facilities/updatetestingfacility","metadata":{"seo":{"title":"Updates a testing facility with the specified ID.","description":"This method will update an existing testing facility with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTestingFacility","name":"Updates a testing facility with the specified ID.","isWebhook":false,"pointer":"/paths/~1testingFacilities~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a testing facility with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing testing facility with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the testing facility to update.","required":true}],"pointer":"/paths/~1testingFacilities~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TestingFacility"}},"schemaId":"components/schemas/TestingFacility","pointer":"/paths/~1testingFacilities~1{tenantId}~1{id}/put/requestBody","description":"The updated testing facility that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/testingFacilities/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TestingFacility"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/testingFacilities/{tenantId}/{id}","href":"testing-facilities/updatetestingfacility","openApiOperationId":"updateTestingFacility","summary":"Updates a testing facility with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/TestingFacility","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TestingFacility"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The testing facility was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestingFacility"}},"schemaId":"components/schemas/TestingFacility","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The testing facility supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The testing facility could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The testing facility could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve testing facility based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1testingFacilities~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TestingFacility","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestingFacility"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/testing-facilities/updatetestingfacility"}],"panels":[]}]},"httpPath":"/testingFacilities/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Testing Facilities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Testing Facilities","showPageActions":true},{"nodeType":"markdoc","content":"Testing Facilities"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/testingFacilities/{tenantId}","summary":"Gets all of the testing facilities in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/testing-facilities/listtestingfacilities","deprecated":false},{"title":"/testingFacilities/{tenantId}","summary":"Creates a new testing facility record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/testing-facilities/createtestingfacility","deprecated":false},{"title":"/testingFacilities/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/testing-facilities/executebatchoperations","deprecated":false},{"title":"/testingFacilities/{tenantId}/{id}","summary":"Returns a testing facility from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/testing-facilities/deletetestingfacility","deprecated":false},{"title":"/testingFacilities/{tenantId}/{id}","summary":"Returns a testing facility from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/testing-facilities/gettestingfacility","deprecated":false},{"title":"/testingFacilities/{tenantId}/{id}","summary":"Partially updates a testing facility with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/testing-facilities/patchtestingfacility","deprecated":false},{"title":"/testingFacilities/{tenantId}/{id}","summary":"Updates a testing facility with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/testing-facilities/updatetestingfacility","deprecated":false}]}]}]}]}},{"type":"group","label":"Training Locations","link":"/apis/certifications/certifications-v1/training-locations","routeSlug":"/apis/certifications/certifications-v1/training-locations","items":[{"label":"Gets all of the training locations in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-locations/listtraininglocations","routeSlug":"/apis/certifications/certifications-v1/training-locations/listtraininglocations","metadata":{"seo":{"title":"Gets all of the training locations in the system.","description":"This method will scan all training locations and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTrainingLocations","name":"Gets all of the training locations in the system.","isWebhook":false,"pointer":"/paths/~1trainingLocations~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the training locations in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all training locations and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1trainingLocations~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1trainingLocations~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingLocations/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingLocations/{tenantId}","href":"training-locations/listtraininglocations","openApiOperationId":"listTrainingLocations","summary":"Gets all of the training locations in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training locationswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}},"schemaId":"schema_407","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingLocations~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_407","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-locations/listtraininglocations"}],"panels":[]}]},"httpPath":"/trainingLocations/{tenantId}"},{"label":"Creates a new training location record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-locations/createtraininglocation","routeSlug":"/apis/certifications/certifications-v1/training-locations/createtraininglocation","metadata":{"seo":{"title":"Creates a new training location record that does not already exist.","description":"This method will auto-generate an ID and create a new training location. If an ID is specified for the training location, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTrainingLocation","name":"Creates a new training location record that does not already exist.","isWebhook":false,"pointer":"/paths/~1trainingLocations~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new training location record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new training location. If an ID is specified for the training location, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1trainingLocations~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TrainingLocation"}},"schemaId":"components/schemas/TrainingLocation","pointer":"/paths/~1trainingLocations~1{tenantId}/post/requestBody","description":"The training location that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingLocations/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TrainingLocation"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/trainingLocations/{tenantId}","href":"training-locations/createtraininglocation","openApiOperationId":"createTrainingLocation","summary":"Creates a new training location record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/TrainingLocation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TrainingLocation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training location was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingLocation"}},"schemaId":"components/schemas/TrainingLocation","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The training location you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The training location could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add training location based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingLocations~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TrainingLocation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingLocation"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-locations/createtraininglocation"}],"panels":[]}]},"httpPath":"/trainingLocations/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-locations/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/training-locations/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1trainingLocations~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1trainingLocations~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1trainingLocations~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingLocations/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingLocations/{tenantId}/batch","href":"training-locations/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The training location could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve training location based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingLocations~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-locations/executebatchoperations"}],"panels":[]}]},"httpPath":"/trainingLocations/{tenantId}/batch"},{"label":"Returns a list of records with the specified training_provider_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-locations/listlocationsbytrainingproviderid","routeSlug":"/apis/certifications/certifications-v1/training-locations/listlocationsbytrainingproviderid","metadata":{"seo":{"title":"Returns a list of records with the specified training_provider_id","description":"Returns a list of records with the specified training_provider_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLocationsByTrainingProviderId","name":"Returns a list of records with the specified training_provider_id","isWebhook":false,"pointer":"/paths/~1trainingLocations~1{tenantId}~1trainingProvider~1{training_provider_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified training_provider_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified training_provider_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"training_provider_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The training_provider_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1trainingLocations~1{tenantId}~1trainingProvider~1{training_provider_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1trainingLocations~1{tenantId}~1trainingProvider~1{training_provider_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingLocations/{tenantId}/trainingProvider/{training_provider_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"training_provider_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingLocations/{tenantId}/trainingProvider/{training_provider_id}","href":"training-locations/listlocationsbytrainingproviderid","openApiOperationId":"listLocationsByTrainingProviderId","summary":"Returns a list of records with the specified training_provider_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTrainingLocationsResponse"}},"schemaId":"components/schemas/ListTrainingLocationsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingLocations~1{tenantId}~1trainingProvider~1{training_provider_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListTrainingLocationsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTrainingLocationsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-locations/listlocationsbytrainingproviderid"}],"panels":[]}]},"httpPath":"/trainingLocations/{tenantId}/trainingProvider/{training_provider_id}"},{"label":"Returns a training location from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-locations/deletetraininglocation","routeSlug":"/apis/certifications/certifications-v1/training-locations/deletetraininglocation","metadata":{"seo":{"title":"Returns a training location from the system by its ID.","description":"This method will delete a training location with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTrainingLocation","name":"Returns a training location from the system by its ID.","isWebhook":false,"pointer":"/paths/~1trainingLocations~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a training location from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a training location with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the training location to delete.","required":true}],"pointer":"/paths/~1trainingLocations~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/trainingLocations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/trainingLocations/{tenantId}/{id}","href":"training-locations/deletetraininglocation","openApiOperationId":"deleteTrainingLocation","summary":"Returns a training location from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training location was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The training location could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The training location could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete training location based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingLocations~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-locations/deletetraininglocation"}],"panels":[]}]},"httpPath":"/trainingLocations/{tenantId}/{id}"},{"label":"Returns a training location from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-locations/gettraininglocation","routeSlug":"/apis/certifications/certifications-v1/training-locations/gettraininglocation","metadata":{"seo":{"title":"Returns a training location from the system by its ID.","description":"This method will look up a training location by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTrainingLocation","name":"Returns a training location from the system by its ID.","isWebhook":false,"pointer":"/paths/~1trainingLocations~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a training location from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a training location by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the training location to return.","required":true}],"pointer":"/paths/~1trainingLocations~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1trainingLocations~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingLocations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingLocations/{tenantId}/{id}","href":"training-locations/gettraininglocation","openApiOperationId":"getTrainingLocation","summary":"Returns a training location from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training location was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingLocation"}},"schemaId":"components/schemas/TrainingLocation","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The training location could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve training location based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingLocations~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TrainingLocation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingLocation"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-locations/gettraininglocation"}],"panels":[]}]},"httpPath":"/trainingLocations/{tenantId}/{id}"},{"label":"Partially updates a training location with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-locations/patchtraininglocation","routeSlug":"/apis/certifications/certifications-v1/training-locations/patchtraininglocation","metadata":{"seo":{"title":"Partially updates a training location with the specified ID.","description":"This method will patch an existing training location with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchTrainingLocation","name":"Partially updates a training location with the specified ID.","isWebhook":false,"pointer":"/paths/~1trainingLocations~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a training location with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing training location with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the training location to patch.","required":true}],"pointer":"/paths/~1trainingLocations~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1trainingLocations~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/trainingLocations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/trainingLocations/{tenantId}/{id}","href":"training-locations/patchtraininglocation","openApiOperationId":"patchTrainingLocation","summary":"Partially updates a training location with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training location was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingLocation"}},"schemaId":"components/schemas/TrainingLocation","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The training location could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The training location could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve training location based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingLocations~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TrainingLocation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingLocation"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-locations/patchtraininglocation"}],"panels":[]}]},"httpPath":"/trainingLocations/{tenantId}/{id}"},{"label":"Updates a training location with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-locations/updatetraininglocation","routeSlug":"/apis/certifications/certifications-v1/training-locations/updatetraininglocation","metadata":{"seo":{"title":"Updates a training location with the specified ID.","description":"This method will update an existing training location with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTrainingLocation","name":"Updates a training location with the specified ID.","isWebhook":false,"pointer":"/paths/~1trainingLocations~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a training location with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing training location with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the training location to update.","required":true}],"pointer":"/paths/~1trainingLocations~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TrainingLocation"}},"schemaId":"components/schemas/TrainingLocation","pointer":"/paths/~1trainingLocations~1{tenantId}~1{id}/put/requestBody","description":"The updated training location that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/trainingLocations/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TrainingLocation"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/trainingLocations/{tenantId}/{id}","href":"training-locations/updatetraininglocation","openApiOperationId":"updateTrainingLocation","summary":"Updates a training location with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/TrainingLocation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TrainingLocation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training location was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingLocation"}},"schemaId":"components/schemas/TrainingLocation","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The training location supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The training location could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The training location could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve training location based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingLocations~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TrainingLocation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingLocation"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-locations/updatetraininglocation"}],"panels":[]}]},"httpPath":"/trainingLocations/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Training Locations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Training Locations","showPageActions":true},{"nodeType":"markdoc","content":"Training Locations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/trainingLocations/{tenantId}","summary":"Gets all of the training locations in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-locations/listtraininglocations","deprecated":false},{"title":"/trainingLocations/{tenantId}","summary":"Creates a new training location record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-locations/createtraininglocation","deprecated":false},{"title":"/trainingLocations/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-locations/executebatchoperations","deprecated":false},{"title":"/trainingLocations/{tenantId}/trainingProvider/{training_provider_id}","summary":"Returns a list of records with the specified training_provider_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-locations/listlocationsbytrainingproviderid","deprecated":false},{"title":"/trainingLocations/{tenantId}/{id}","summary":"Returns a training location from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/training-locations/deletetraininglocation","deprecated":false},{"title":"/trainingLocations/{tenantId}/{id}","summary":"Returns a training location from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-locations/gettraininglocation","deprecated":false},{"title":"/trainingLocations/{tenantId}/{id}","summary":"Partially updates a training location with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/training-locations/patchtraininglocation","deprecated":false},{"title":"/trainingLocations/{tenantId}/{id}","summary":"Updates a training location with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/training-locations/updatetraininglocation","deprecated":false}]}]}]}]}},{"type":"group","label":"Training Prov Programs","link":"/apis/certifications/certifications-v1/training-prov-programs","routeSlug":"/apis/certifications/certifications-v1/training-prov-programs","items":[{"label":"Creates a new training prov program record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-prov-programs/createtrainingprovprogram","routeSlug":"/apis/certifications/certifications-v1/training-prov-programs/createtrainingprovprogram","metadata":{"seo":{"title":"Creates a new training prov program record that does not already exist.","description":"This method will auto-generate an ID and create a new training prov program. If an ID is specified for the training prov program, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTrainingProvProgram","name":"Creates a new training prov program record that does not already exist.","isWebhook":false,"pointer":"/paths/~1trainingProvPrograms~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new training prov program record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new training prov program. If an ID is specified for the training prov program, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TrainingProvProgram"}},"schemaId":"components/schemas/TrainingProvProgram","pointer":"/paths/~1trainingProvPrograms~1{tenantId}/post/requestBody","description":"The training prov program that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingProvPrograms/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TrainingProvProgram"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/trainingProvPrograms/{tenantId}","href":"training-prov-programs/createtrainingprovprogram","openApiOperationId":"createTrainingProvProgram","summary":"Creates a new training prov program record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/TrainingProvProgram","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TrainingProvProgram"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training prov program was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingProvProgram"}},"schemaId":"components/schemas/TrainingProvProgram","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The training prov program you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The training prov program could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add training prov program based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TrainingProvProgram","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingProvProgram"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-prov-programs/createtrainingprovprogram"}],"panels":[]}]},"httpPath":"/trainingProvPrograms/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-prov-programs/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/training-prov-programs/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingProvPrograms/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProvPrograms/{tenantId}/batch","href":"training-prov-programs/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The training prov program could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve training prov program based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-prov-programs/executebatchoperations"}],"panels":[]}]},"httpPath":"/trainingProvPrograms/{tenantId}/batch"},{"label":"Returns a list of records with the specified program_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-prov-programs/listprogramsbyprogramid","routeSlug":"/apis/certifications/certifications-v1/training-prov-programs/listprogramsbyprogramid","metadata":{"seo":{"title":"Returns a list of records with the specified program_id","description":"Returns a list of records with the specified program_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProgramsByProgramId","name":"Returns a list of records with the specified program_id","isWebhook":false,"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1program~1{program_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified program_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified program_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"program_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The program_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1program~1{program_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1program~1{program_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProvPrograms/{tenantId}/program/{program_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"program_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProvPrograms/{tenantId}/program/{program_id}","href":"training-prov-programs/listprogramsbyprogramid","openApiOperationId":"listProgramsByProgramId","summary":"Returns a list of records with the specified program_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTrainingProvProgramsResponse"}},"schemaId":"components/schemas/ListTrainingProvProgramsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1program~1{program_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListTrainingProvProgramsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTrainingProvProgramsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-prov-programs/listprogramsbyprogramid"}],"panels":[]}]},"httpPath":"/trainingProvPrograms/{tenantId}/program/{program_id}"},{"label":"Returns a list of records with the specified training_provider_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-prov-programs/listprogramsbytrainingproviderid","routeSlug":"/apis/certifications/certifications-v1/training-prov-programs/listprogramsbytrainingproviderid","metadata":{"seo":{"title":"Returns a list of records with the specified training_provider_id","description":"Returns a list of records with the specified training_provider_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProgramsByTrainingProviderId","name":"Returns a list of records with the specified training_provider_id","isWebhook":false,"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1trainingProvider~1{training_provider_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified training_provider_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified training_provider_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"training_provider_id","in":"path","schemaId":"schema_366","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The training_provider_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1trainingProvider~1{training_provider_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1trainingProvider~1{training_provider_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProvPrograms/{tenantId}/trainingProvider/{training_provider_id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"training_provider_id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProvPrograms/{tenantId}/trainingProvider/{training_provider_id}","href":"training-prov-programs/listprogramsbytrainingproviderid","openApiOperationId":"listProgramsByTrainingProviderId","summary":"Returns a list of records with the specified training_provider_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTrainingProvProgramsResponse"}},"schemaId":"components/schemas/ListTrainingProvProgramsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1trainingProvider~1{training_provider_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListTrainingProvProgramsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTrainingProvProgramsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-prov-programs/listprogramsbytrainingproviderid"}],"panels":[]}]},"httpPath":"/trainingProvPrograms/{tenantId}/trainingProvider/{training_provider_id}"},{"label":"Returns a training prov program from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-prov-programs/deletetrainingprovprogram","routeSlug":"/apis/certifications/certifications-v1/training-prov-programs/deletetrainingprovprogram","metadata":{"seo":{"title":"Returns a training prov program from the system by its ID.","description":"This method will delete a training prov program with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTrainingProvProgram","name":"Returns a training prov program from the system by its ID.","isWebhook":false,"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a training prov program from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a training prov program with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the training prov program to delete.","required":true}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/trainingProvPrograms/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/trainingProvPrograms/{tenantId}/{id}","href":"training-prov-programs/deletetrainingprovprogram","openApiOperationId":"deleteTrainingProvProgram","summary":"Returns a training prov program from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training prov program was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The training prov program could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The training prov program could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete training prov program based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-prov-programs/deletetrainingprovprogram"}],"panels":[]}]},"httpPath":"/trainingProvPrograms/{tenantId}/{id}"},{"label":"Returns a training prov program from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-prov-programs/gettrainingprovprogram","routeSlug":"/apis/certifications/certifications-v1/training-prov-programs/gettrainingprovprogram","metadata":{"seo":{"title":"Returns a training prov program from the system by its ID.","description":"This method will look up a training prov program by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTrainingProvProgram","name":"Returns a training prov program from the system by its ID.","isWebhook":false,"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a training prov program from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a training prov program by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the training prov program to return.","required":true}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProvPrograms/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProvPrograms/{tenantId}/{id}","href":"training-prov-programs/gettrainingprovprogram","openApiOperationId":"getTrainingProvProgram","summary":"Returns a training prov program from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training prov program was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingProvProgram"}},"schemaId":"components/schemas/TrainingProvProgram","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The training prov program could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve training prov program based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TrainingProvProgram","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingProvProgram"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-prov-programs/gettrainingprovprogram"}],"panels":[]}]},"httpPath":"/trainingProvPrograms/{tenantId}/{id}"},{"label":"Partially updates a training prov program with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-prov-programs/patchtrainingprovprogram","routeSlug":"/apis/certifications/certifications-v1/training-prov-programs/patchtrainingprovprogram","metadata":{"seo":{"title":"Partially updates a training prov program with the specified ID.","description":"This method will patch an existing training prov program with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchTrainingProvProgram","name":"Partially updates a training prov program with the specified ID.","isWebhook":false,"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a training prov program with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing training prov program with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the training prov program to patch.","required":true}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/trainingProvPrograms/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/trainingProvPrograms/{tenantId}/{id}","href":"training-prov-programs/patchtrainingprovprogram","openApiOperationId":"patchTrainingProvProgram","summary":"Partially updates a training prov program with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training prov program was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingProvProgram"}},"schemaId":"components/schemas/TrainingProvProgram","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The training prov program could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The training prov program could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve training prov program based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TrainingProvProgram","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingProvProgram"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-prov-programs/patchtrainingprovprogram"}],"panels":[]}]},"httpPath":"/trainingProvPrograms/{tenantId}/{id}"},{"label":"Updates a training prov program with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-prov-programs/updatetrainingprovprogram","routeSlug":"/apis/certifications/certifications-v1/training-prov-programs/updatetrainingprovprogram","metadata":{"seo":{"title":"Updates a training prov program with the specified ID.","description":"This method will update an existing training prov program with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTrainingProvProgram","name":"Updates a training prov program with the specified ID.","isWebhook":false,"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a training prov program with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing training prov program with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the training prov program to update.","required":true}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TrainingProvProgram"}},"schemaId":"components/schemas/TrainingProvProgram","pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1{id}/put/requestBody","description":"The updated training prov program that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/trainingProvPrograms/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TrainingProvProgram"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/trainingProvPrograms/{tenantId}/{id}","href":"training-prov-programs/updatetrainingprovprogram","openApiOperationId":"updateTrainingProvProgram","summary":"Updates a training prov program with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/TrainingProvProgram","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TrainingProvProgram"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training prov program was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingProvProgram"}},"schemaId":"components/schemas/TrainingProvProgram","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The training prov program supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The training prov program could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The training prov program could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve training prov program based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProvPrograms~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TrainingProvProgram","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingProvProgram"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-prov-programs/updatetrainingprovprogram"}],"panels":[]}]},"httpPath":"/trainingProvPrograms/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Training Prov Programs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Training Prov Programs","showPageActions":true},{"nodeType":"markdoc","content":"Training Prov Programs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/trainingProvPrograms/{tenantId}","summary":"Creates a new training prov program record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-prov-programs/createtrainingprovprogram","deprecated":false},{"title":"/trainingProvPrograms/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-prov-programs/executebatchoperations","deprecated":false},{"title":"/trainingProvPrograms/{tenantId}/program/{program_id}","summary":"Returns a list of records with the specified program_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-prov-programs/listprogramsbyprogramid","deprecated":false},{"title":"/trainingProvPrograms/{tenantId}/trainingProvider/{training_provider_id}","summary":"Returns a list of records with the specified training_provider_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-prov-programs/listprogramsbytrainingproviderid","deprecated":false},{"title":"/trainingProvPrograms/{tenantId}/{id}","summary":"Returns a training prov program from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/training-prov-programs/deletetrainingprovprogram","deprecated":false},{"title":"/trainingProvPrograms/{tenantId}/{id}","summary":"Returns a training prov program from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-prov-programs/gettrainingprovprogram","deprecated":false},{"title":"/trainingProvPrograms/{tenantId}/{id}","summary":"Partially updates a training prov program with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/training-prov-programs/patchtrainingprovprogram","deprecated":false},{"title":"/trainingProvPrograms/{tenantId}/{id}","summary":"Updates a training prov program with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/training-prov-programs/updatetrainingprovprogram","deprecated":false}]}]}]}]}},{"type":"group","label":"Training Providers","link":"/apis/certifications/certifications-v1/training-providers","routeSlug":"/apis/certifications/certifications-v1/training-providers","items":[{"label":"Gets all of the training providers in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/listtrainingproviders","routeSlug":"/apis/certifications/certifications-v1/training-providers/listtrainingproviders","metadata":{"seo":{"title":"Gets all of the training providers in the system.","description":"This method will scan all training providers and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTrainingProviders","name":"Gets all of the training providers in the system.","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the training providers in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all training providers and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_366","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1trainingProviders~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}","href":"training-providers/listtrainingproviders","openApiOperationId":"listTrainingProviders","summary":"Gets all of the training providers in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training providerswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}},"schemaId":"schema_408","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_408","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/listtrainingproviders"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}"},{"label":"Creates a new training provider record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/createtrainingprovider","routeSlug":"/apis/certifications/certifications-v1/training-providers/createtrainingprovider","metadata":{"seo":{"title":"Creates a new training provider record that does not already exist.","description":"This method will auto-generate an ID and create a new training provider. If an ID is specified for the training provider, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTrainingProvider","name":"Creates a new training provider record that does not already exist.","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new training provider record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new training provider. If an ID is specified for the training provider, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TrainingProvider"}},"schemaId":"components/schemas/TrainingProvider","pointer":"/paths/~1trainingProviders~1{tenantId}/post/requestBody","description":"The training provider that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingProviders/{tenantId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TrainingProvider"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/trainingProviders/{tenantId}","href":"training-providers/createtrainingprovider","openApiOperationId":"createTrainingProvider","summary":"Creates a new training provider record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/TrainingProvider","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TrainingProvider"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training provider was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingProvider"}},"schemaId":"components/schemas/TrainingProvider","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The training provider you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The training provider could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to add training provider based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TrainingProvider","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingProvider"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/createtrainingprovider"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/executebatchoperations","routeSlug":"/apis/certifications/certifications-v1/training-providers/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1trainingProviders~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingProviders/{tenantId}/batch","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/batch","href":"training-providers/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The training provider could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve training provider based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/executebatchoperations"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/batch"},{"label":"List Activities By Contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/listactivitiesbycontact","routeSlug":"/apis/certifications/certifications-v1/training-providers/listactivitiesbycontact","metadata":{"seo":{"title":"List Activities By Contact","description":"List the certification activites for the given contact"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listActivitiesByContact","name":"List Activities By Contact","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1activities~1{trainingProviderId}~1{contactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Activities By Contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List the certification activites for the given contact"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The contact id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1activities~1{trainingProviderId}~1{contactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/portal/activities/{trainingProviderId}/{contactId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/activities/{trainingProviderId}/{contactId}","href":"training-providers/listactivitiesbycontact","openApiOperationId":"listActivitiesByContact","summary":"List Activities By Contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"invoice/json","mediaTypes":["invoice/json"],"mediaTypeContent":{"invoice/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1activities~1{trainingProviderId}~1{contactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["invoice/json"],"mediaTypeContent":{"invoice/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/listactivitiesbycontact"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/activities/{trainingProviderId}/{contactId}"},{"label":"Create Activity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/createactivity","routeSlug":"/apis/certifications/certifications-v1/training-providers/createactivity","metadata":{"seo":{"title":"Create Activity","description":"Allows for portal users to create a certification activity"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createActivity","name":"Create Activity","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1activity~1{trainingProviderId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Activity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for portal users to create a certification activity"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1activity~1{trainingProviderId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1activity~1{trainingProviderId}/post/requestBody","description":"The contact"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingProviders/{tenantId}/portal/activity/{trainingProviderId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_380"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/activity/{trainingProviderId}","href":"training-providers/createactivity","openApiOperationId":"createActivity","summary":"Create Activity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were created successfully","mediaType":"invoice/json","mediaTypes":["invoice/json"],"mediaTypeContent":{"invoice/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1activity~1{trainingProviderId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["invoice/json"],"mediaTypeContent":{"invoice/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/createactivity"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/activity/{trainingProviderId}"},{"label":"Update an activity","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/updateactivity","routeSlug":"/apis/certifications/certifications-v1/training-providers/updateactivity","metadata":{"seo":{"title":"Update an activity","description":"Allows for a portal user to update an activity"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateActivity","name":"Update an activity","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1activity~1{trainingProviderId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an activity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for a portal user to update an activity"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1activity~1{trainingProviderId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1activity~1{trainingProviderId}/put/requestBody","description":"The activity to be updated"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/trainingProviders/{tenantId}/portal/activity/{trainingProviderId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_380"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/activity/{trainingProviderId}","href":"training-providers/updateactivity","openApiOperationId":"updateActivity","summary":"Update an activity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1activity~1{trainingProviderId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/updateactivity"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/activity/{trainingProviderId}"},{"label":"Create a new certification application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/createtrainingprovidercertificationapplication","routeSlug":"/apis/certifications/certifications-v1/training-providers/createtrainingprovidercertificationapplication","metadata":{"seo":{"title":"Create a new certification application","description":"Allows for a portal user to create a certification application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTrainingProviderCertificationApplication","name":"Create a new certification application","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1application~1{trainingProviderId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new certification application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for a portal user to create a certification application"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1application~1{trainingProviderId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1application~1{trainingProviderId}/post/requestBody","description":"The contact"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingProviders/{tenantId}/portal/application/{trainingProviderId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_380"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/application/{trainingProviderId}","href":"training-providers/createtrainingprovidercertificationapplication","openApiOperationId":"createTrainingProviderCertificationApplication","summary":"Create a new certification application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1application~1{trainingProviderId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/createtrainingprovidercertificationapplication"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/application/{trainingProviderId}"},{"label":"Get a certification application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/gettrainingproviderapplication","routeSlug":"/apis/certifications/certifications-v1/training-providers/gettrainingproviderapplication","metadata":{"seo":{"title":"Get a certification application","description":"Allows for a portal user to get a certification application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTrainingProviderApplication","name":"Get a certification application","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1application~1{trainingProviderId}~1{applicationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a certification application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for a portal user to get a certification application"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"applicationId","in":"path","schemaId":"schema_366","description":"The certification application id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1application~1{trainingProviderId}~1{applicationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/portal/application/{trainingProviderId}/{applicationId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"applicationId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/application/{trainingProviderId}/{applicationId}","href":"training-providers/gettrainingproviderapplication","openApiOperationId":"getTrainingProviderApplication","summary":"Get a certification application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1application~1{trainingProviderId}~1{applicationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/gettrainingproviderapplication"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/application/{trainingProviderId}/{applicationId}"},{"label":"Get a certification application","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/updatetrainingproviderapplication","routeSlug":"/apis/certifications/certifications-v1/training-providers/updatetrainingproviderapplication","metadata":{"seo":{"title":"Get a certification application","description":"Allows for a portal user to update a certification application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTrainingProviderApplication","name":"Get a certification application","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1application~1{trainingProviderId}~1{applicationId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a certification application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for a portal user to update a certification application"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"applicationId","in":"path","schemaId":"schema_366","description":"The certification application id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1application~1{trainingProviderId}~1{applicationId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1application~1{trainingProviderId}~1{applicationId}/put/requestBody","description":"The certification application id"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/trainingProviders/{tenantId}/portal/application/{trainingProviderId}/{applicationId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"applicationId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_380"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/application/{trainingProviderId}/{applicationId}","href":"training-providers/updatetrainingproviderapplication","openApiOperationId":"updateTrainingProviderApplication","summary":"Get a certification application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1application~1{trainingProviderId}~1{applicationId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/updatetrainingproviderapplication"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/application/{trainingProviderId}/{applicationId}"},{"label":"Create a new application order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/generatetrainingproviderapplicationorder","routeSlug":"/apis/certifications/certifications-v1/training-providers/generatetrainingproviderapplicationorder","metadata":{"seo":{"title":"Create a new application order","description":"Allows for a portal user to create an order for someone elses certification application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateTrainingProviderApplicationOrder","name":"Create a new application order","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1applicationOrder~1{trainingProviderId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new application order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for a portal user to create an order for someone elses certification application"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1applicationOrder~1{trainingProviderId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1applicationOrder~1{trainingProviderId}/post/requestBody","description":"The contact"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingProviders/{tenantId}/portal/applicationOrder/{trainingProviderId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_380"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/applicationOrder/{trainingProviderId}","href":"training-providers/generatetrainingproviderapplicationorder","openApiOperationId":"generateTrainingProviderApplicationOrder","summary":"Create a new application order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1applicationOrder~1{trainingProviderId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/generatetrainingproviderapplicationorder"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/applicationOrder/{trainingProviderId}"},{"label":"List applications by contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/listapplicationsbycontact","routeSlug":"/apis/certifications/certifications-v1/training-providers/listapplicationsbycontact","metadata":{"seo":{"title":"List applications by contact","description":"Shows a list of applications by contact"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listApplicationsByContact","name":"List applications by contact","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1applications~1{trainingProviderId}~1{contactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List applications by contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Shows a list of applications by contact"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The contact","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1applications~1{trainingProviderId}~1{contactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/portal/applications/{trainingProviderId}/{contactId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/applications/{trainingProviderId}/{contactId}","href":"training-providers/listapplicationsbycontact","openApiOperationId":"listApplicationsByContact","summary":"List applications by contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1applications~1{trainingProviderId}~1{contactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/listapplicationsbycontact"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/applications/{trainingProviderId}/{contactId}"},{"label":"Get a Certification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/gettrainingprovidercertification","routeSlug":"/apis/certifications/certifications-v1/training-providers/gettrainingprovidercertification","metadata":{"seo":{"title":"Get a Certification","description":"Get a certification"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTrainingProviderCertification","name":"Get a Certification","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1certification~1{trainingProviderId}~1{certificationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Certification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a certification"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"certificationId","in":"path","schemaId":"schema_366","description":"The certification id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1certification~1{trainingProviderId}~1{certificationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/portal/certification/{trainingProviderId}/{certificationId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"certificationId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/certification/{trainingProviderId}/{certificationId}","href":"training-providers/gettrainingprovidercertification","openApiOperationId":"getTrainingProviderCertification","summary":"Get a Certification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"certification/json","mediaTypes":["certification/json"],"mediaTypeContent":{"certification/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1certification~1{trainingProviderId}~1{certificationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["certification/json"],"mediaTypeContent":{"certification/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/gettrainingprovidercertification"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/certification/{trainingProviderId}/{certificationId}"},{"label":"List certifications by contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/listcertificationsbycontact","routeSlug":"/apis/certifications/certifications-v1/training-providers/listcertificationsbycontact","metadata":{"seo":{"title":"List certifications by contact","description":"Shows a list of certifications by contact"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCertificationsByContact","name":"List certifications by contact","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1certifications~1{trainingProviderId}~1{contactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List certifications by contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Shows a list of certifications by contact"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The contact","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1certifications~1{trainingProviderId}~1{contactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/portal/certifications/{trainingProviderId}/{contactId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/certifications/{trainingProviderId}/{contactId}","href":"training-providers/listcertificationsbycontact","openApiOperationId":"listCertificationsByContact","summary":"List certifications by contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"certification/json","mediaTypes":["certification/json"],"mediaTypeContent":{"certification/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1certifications~1{trainingProviderId}~1{contactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["certification/json"],"mediaTypeContent":{"certification/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/listcertificationsbycontact"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/certifications/{trainingProviderId}/{contactId}"},{"label":"Create a new Contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/createtrainingprovidercontact","routeSlug":"/apis/certifications/certifications-v1/training-providers/createtrainingprovidercontact","metadata":{"seo":{"title":"Create a new Contact","description":"Allows for a portal user to create a new contact"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTrainingProviderContact","name":"Create a new Contact","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1contact~1{trainingProviderId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for a portal user to create a new contact"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1contact~1{trainingProviderId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1contact~1{trainingProviderId}/post/requestBody","description":"The contact"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingProviders/{tenantId}/portal/contact/{trainingProviderId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_380"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/contact/{trainingProviderId}","href":"training-providers/createtrainingprovidercontact","openApiOperationId":"createTrainingProviderContact","summary":"Create a new Contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1contact~1{trainingProviderId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/createtrainingprovidercontact"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/contact/{trainingProviderId}"},{"label":"Get a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/gettrainingprovidercontact","routeSlug":"/apis/certifications/certifications-v1/training-providers/gettrainingprovidercontact","metadata":{"seo":{"title":"Get a contact","description":"Allows for a portal user to get a new contact"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTrainingProviderContact","name":"Get a contact","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1contact~1{trainingProviderId}~1{contactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for a portal user to get a new contact"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1contact~1{trainingProviderId}~1{contactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/portal/contact/{trainingProviderId}/{contactId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/contact/{trainingProviderId}/{contactId}","href":"training-providers/gettrainingprovidercontact","openApiOperationId":"getTrainingProviderContact","summary":"Get a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1contact~1{trainingProviderId}~1{contactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/gettrainingprovidercontact"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/contact/{trainingProviderId}/{contactId}"},{"label":"Update a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/updatetrainingprovidercontact","routeSlug":"/apis/certifications/certifications-v1/training-providers/updatetrainingprovidercontact","metadata":{"seo":{"title":"Update a contact","description":"Allows for a portal user to update a new contact"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTrainingProviderContact","name":"Update a contact","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1contact~1{trainingProviderId}~1{contactId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for a portal user to update a new contact"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1contact~1{trainingProviderId}~1{contactId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1contact~1{trainingProviderId}~1{contactId}/put/requestBody","description":"The contact"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/trainingProviders/{tenantId}/portal/contact/{trainingProviderId}/{contactId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_380"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/contact/{trainingProviderId}/{contactId}","href":"training-providers/updatetrainingprovidercontact","openApiOperationId":"updateTrainingProviderContact","summary":"Update a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1contact~1{trainingProviderId}~1{contactId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/updatetrainingprovidercontact"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/contact/{trainingProviderId}/{contactId}"},{"label":"Search for contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/searchfortrainingprovidercontacts","routeSlug":"/apis/certifications/certifications-v1/training-providers/searchfortrainingprovidercontacts","metadata":{"seo":{"title":"Search for contacts","description":"Allows for a portal user to search for contacts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForTrainingProviderContacts","name":"Search for contacts","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1contactSearch~1{trainingProviderId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search for contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for a portal user to search for contacts"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1contactSearch~1{trainingProviderId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1contactSearch~1{trainingProviderId}/post/requestBody","description":"The contact"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingProviders/{tenantId}/portal/contactSearch/{trainingProviderId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_380"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/contactSearch/{trainingProviderId}","href":"training-providers/searchfortrainingprovidercontacts","openApiOperationId":"searchForTrainingProviderContacts","summary":"Search for contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1contactSearch~1{trainingProviderId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/searchfortrainingprovidercontacts"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/contactSearch/{trainingProviderId}"},{"label":"Create a new Course Registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/createtrainingprovidercourseregistration","routeSlug":"/apis/certifications/certifications-v1/training-providers/createtrainingprovidercourseregistration","metadata":{"seo":{"title":"Create a new Course Registration","description":"Allows for a portal user to create a course registration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTrainingProviderCourseRegistration","name":"Create a new Course Registration","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1courseRegistration~1{trainingProviderId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Course Registration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for a portal user to create a course registration"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1courseRegistration~1{trainingProviderId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1courseRegistration~1{trainingProviderId}/post/requestBody","description":"The contact"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingProviders/{tenantId}/portal/courseRegistration/{trainingProviderId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_380"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/courseRegistration/{trainingProviderId}","href":"training-providers/createtrainingprovidercourseregistration","openApiOperationId":"createTrainingProviderCourseRegistration","summary":"Create a new Course Registration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1courseRegistration~1{trainingProviderId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/createtrainingprovidercourseregistration"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/courseRegistration/{trainingProviderId}"},{"label":"Get a Course Registration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/gettrainingprovidercourseregistration","routeSlug":"/apis/certifications/certifications-v1/training-providers/gettrainingprovidercourseregistration","metadata":{"seo":{"title":"Get a Course Registration","description":"Allows for a portal user to get a course registration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTrainingProviderCourseRegistration","name":"Get a Course Registration","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1courseRegistration~1{trainingProviderId}~1{courseRegistrationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Course Registration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for a portal user to get a course registration"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"courseRegistrationId","in":"path","schemaId":"schema_366","description":"The course registration id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1courseRegistration~1{trainingProviderId}~1{courseRegistrationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/portal/courseRegistration/{trainingProviderId}/{courseRegistrationId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"courseRegistrationId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/courseRegistration/{trainingProviderId}/{courseRegistrationId}","href":"training-providers/gettrainingprovidercourseregistration","openApiOperationId":"getTrainingProviderCourseRegistration","summary":"Get a Course Registration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1courseRegistration~1{trainingProviderId}~1{courseRegistrationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/gettrainingprovidercourseregistration"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/courseRegistration/{trainingProviderId}/{courseRegistrationId}"},{"label":"Create a new Course Registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/generatetrainingprovidercourseregistrationorder","routeSlug":"/apis/certifications/certifications-v1/training-providers/generatetrainingprovidercourseregistrationorder","metadata":{"seo":{"title":"Create a new Course Registration","description":"Allows for a portal user to create a course registration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateTrainingProviderCourseRegistrationOrder","name":"Create a new Course Registration","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1courseRegistrationOrder~1{trainingProviderId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Course Registration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for a portal user to create a course registration"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1courseRegistrationOrder~1{trainingProviderId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1courseRegistrationOrder~1{trainingProviderId}/post/requestBody","description":"The contact"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingProviders/{tenantId}/portal/courseRegistrationOrder/{trainingProviderId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_380"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/courseRegistrationOrder/{trainingProviderId}","href":"training-providers/generatetrainingprovidercourseregistrationorder","openApiOperationId":"generateTrainingProviderCourseRegistrationOrder","summary":"Create a new Course Registration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1courseRegistrationOrder~1{trainingProviderId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/generatetrainingprovidercourseregistrationorder"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/courseRegistrationOrder/{trainingProviderId}"},{"label":"List course registrations by contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/listcourseregistrationsbycontact","routeSlug":"/apis/certifications/certifications-v1/training-providers/listcourseregistrationsbycontact","metadata":{"seo":{"title":"List course registrations by contact","description":"Shows a list of course registration by contact"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCourseRegistrationsByContact","name":"List course registrations by contact","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1courseRegistrations~1{trainingProviderId}~1{contactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List course registrations by contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Shows a list of course registration by contact"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The contact","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1courseRegistrations~1{trainingProviderId}~1{contactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/portal/courseRegistrations/{trainingProviderId}/{contactId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/courseRegistrations/{trainingProviderId}/{contactId}","href":"training-providers/listcourseregistrationsbycontact","openApiOperationId":"listCourseRegistrationsByContact","summary":"List course registrations by contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1courseRegistrations~1{trainingProviderId}~1{contactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/listcourseregistrationsbycontact"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/courseRegistrations/{trainingProviderId}/{contactId}"},{"label":"Get eligible activity reg processes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/geteligibleactivityprocesses","routeSlug":"/apis/certifications/certifications-v1/training-providers/geteligibleactivityprocesses","metadata":{"seo":{"title":"Get eligible activity reg processes","description":"Get the eligible activity reg process"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEligibleActivityProcesses","name":"Get eligible activity reg processes","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1eligibleActivityRegProcess~1{trainingProviderId}~1{contactId}~1{activityTypeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get eligible activity reg processes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the eligible activity reg process"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The contact id","required":true},{"name":"activityTypeId","in":"path","schemaId":"schema_366","description":"The activity type","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1eligibleActivityRegProcess~1{trainingProviderId}~1{contactId}~1{activityTypeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/portal/eligibleActivityRegProcess/{trainingProviderId}/{contactId}/{activityTypeId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"},{"name":"activityTypeId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/eligibleActivityRegProcess/{trainingProviderId}/{contactId}/{activityTypeId}","href":"training-providers/geteligibleactivityprocesses","openApiOperationId":"getEligibleActivityProcesses","summary":"Get eligible activity reg processes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"invoice/json","mediaTypes":["invoice/json"],"mediaTypeContent":{"invoice/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1eligibleActivityRegProcess~1{trainingProviderId}~1{contactId}~1{activityTypeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["invoice/json"],"mediaTypeContent":{"invoice/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/geteligibleactivityprocesses"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/eligibleActivityRegProcess/{trainingProviderId}/{contactId}/{activityTypeId}"},{"label":"Get eligible application processes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/geteligibleapplicationprocesses","routeSlug":"/apis/certifications/certifications-v1/training-providers/geteligibleapplicationprocesses","metadata":{"seo":{"title":"Get eligible application processes","description":"Get the eligible appliation process"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEligibleApplicationProcesses","name":"Get eligible application processes","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1eligibleApplicationProcess~1{trainingProviderId}~1{programId}~1{customerType}~1{contactOrOrganizationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get eligible application processes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the eligible appliation process"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"programId","in":"path","schemaId":"schema_366","description":"The program id","required":true},{"name":"customerType","in":"path","schemaId":"schema_366","description":"The customer type","required":true},{"name":"contactOrOrganizationId","in":"path","schemaId":"schema_366","description":"The contact or organization id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1eligibleApplicationProcess~1{trainingProviderId}~1{programId}~1{customerType}~1{contactOrOrganizationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/portal/eligibleApplicationProcess/{trainingProviderId}/{programId}/{customerType}/{contactOrOrganizationId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"programId","in":"path","required":true,"schemaId":"schema_366"},{"name":"customerType","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactOrOrganizationId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/eligibleApplicationProcess/{trainingProviderId}/{programId}/{customerType}/{contactOrOrganizationId}","href":"training-providers/geteligibleapplicationprocesses","openApiOperationId":"getEligibleApplicationProcesses","summary":"Get eligible application processes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"invoice/json","mediaTypes":["invoice/json"],"mediaTypeContent":{"invoice/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1eligibleApplicationProcess~1{trainingProviderId}~1{programId}~1{customerType}~1{contactOrOrganizationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["invoice/json"],"mediaTypeContent":{"invoice/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/geteligibleapplicationprocesses"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/eligibleApplicationProcess/{trainingProviderId}/{programId}/{customerType}/{contactOrOrganizationId}"},{"label":"Get eligible course registration process","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/geteligiblecourseregprocesses","routeSlug":"/apis/certifications/certifications-v1/training-providers/geteligiblecourseregprocesses","metadata":{"seo":{"title":"Get eligible course registration process","description":"Get the eligible course registration process"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEligibleCourseRegProcesses","name":"Get eligible course registration process","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1eligibleCourseRegProcess~1{trainingProviderId}~1{contactId}~1{courseId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get eligible course registration process","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the eligible course registration process"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The contact id","required":true},{"name":"courseId","in":"path","schemaId":"schema_366","description":"The reg course id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1eligibleCourseRegProcess~1{trainingProviderId}~1{contactId}~1{courseId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/portal/eligibleCourseRegProcess/{trainingProviderId}/{contactId}/{courseId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"},{"name":"courseId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/eligibleCourseRegProcess/{trainingProviderId}/{contactId}/{courseId}","href":"training-providers/geteligiblecourseregprocesses","openApiOperationId":"getEligibleCourseRegProcesses","summary":"Get eligible course registration process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"invoice/json","mediaTypes":["invoice/json"],"mediaTypeContent":{"invoice/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1eligibleCourseRegProcess~1{trainingProviderId}~1{contactId}~1{courseId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["invoice/json"],"mediaTypeContent":{"invoice/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/geteligiblecourseregprocesses"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/eligibleCourseRegProcess/{trainingProviderId}/{contactId}/{courseId}"},{"label":"Get eligible exam registration processes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/geteligibleexamregprocesses","routeSlug":"/apis/certifications/certifications-v1/training-providers/geteligibleexamregprocesses","metadata":{"seo":{"title":"Get eligible exam registration processes","description":"Get the eligible exam registration process"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEligibleExamRegProcesses","name":"Get eligible exam registration processes","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1eligibleExamRegProcess~1{trainingProviderId}~1{contactId}~1{examId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get eligible exam registration processes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the eligible exam registration process"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The contact id","required":true},{"name":"examId","in":"path","schemaId":"schema_366","description":"The exam id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1eligibleExamRegProcess~1{trainingProviderId}~1{contactId}~1{examId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/portal/eligibleExamRegProcess/{trainingProviderId}/{contactId}/{examId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"},{"name":"examId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/eligibleExamRegProcess/{trainingProviderId}/{contactId}/{examId}","href":"training-providers/geteligibleexamregprocesses","openApiOperationId":"getEligibleExamRegProcesses","summary":"Get eligible exam registration processes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"invoice/json","mediaTypes":["invoice/json"],"mediaTypeContent":{"invoice/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1eligibleExamRegProcess~1{trainingProviderId}~1{contactId}~1{examId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["invoice/json"],"mediaTypeContent":{"invoice/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/geteligibleexamregprocesses"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/eligibleExamRegProcess/{trainingProviderId}/{contactId}/{examId}"},{"label":"Create a new Exam Registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/createtrainingproviderexamregistration","routeSlug":"/apis/certifications/certifications-v1/training-providers/createtrainingproviderexamregistration","metadata":{"seo":{"title":"Create a new Exam Registration","description":"Allows for a portal user to create a exam registration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTrainingProviderExamRegistration","name":"Create a new Exam Registration","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1examRegistration~1{trainingProviderId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Exam Registration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for a portal user to create a exam registration"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1examRegistration~1{trainingProviderId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1examRegistration~1{trainingProviderId}/post/requestBody","description":"The contact"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingProviders/{tenantId}/portal/examRegistration/{trainingProviderId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_380"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/examRegistration/{trainingProviderId}","href":"training-providers/createtrainingproviderexamregistration","openApiOperationId":"createTrainingProviderExamRegistration","summary":"Create a new Exam Registration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1examRegistration~1{trainingProviderId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/createtrainingproviderexamregistration"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/examRegistration/{trainingProviderId}"},{"label":"Get an Exam Registration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/gettrainingproviderexamregistration","routeSlug":"/apis/certifications/certifications-v1/training-providers/gettrainingproviderexamregistration","metadata":{"seo":{"title":"Get an Exam Registration","description":"Allows for a portal user to get an exam registration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTrainingProviderExamRegistration","name":"Get an Exam Registration","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1examRegistration~1{trainingProviderId}~1{examRegistrationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an Exam Registration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for a portal user to get an exam registration"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"examRegistrationId","in":"path","schemaId":"schema_366","description":"The exam registration id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1examRegistration~1{trainingProviderId}~1{examRegistrationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/portal/examRegistration/{trainingProviderId}/{examRegistrationId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"examRegistrationId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/examRegistration/{trainingProviderId}/{examRegistrationId}","href":"training-providers/gettrainingproviderexamregistration","openApiOperationId":"getTrainingProviderExamRegistration","summary":"Get an Exam Registration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1examRegistration~1{trainingProviderId}~1{examRegistrationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/gettrainingproviderexamregistration"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/examRegistration/{trainingProviderId}/{examRegistrationId}"},{"label":"Create a new Exam Registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/generatetrainingproviderexamregistrationorder","routeSlug":"/apis/certifications/certifications-v1/training-providers/generatetrainingproviderexamregistrationorder","metadata":{"seo":{"title":"Create a new Exam Registration","description":"Allows for a portal user to create a exam registration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateTrainingProviderExamRegistrationOrder","name":"Create a new Exam Registration","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1examRegistrationOrder~1{trainingProviderId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Exam Registration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for a portal user to create a exam registration"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1examRegistrationOrder~1{trainingProviderId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1examRegistrationOrder~1{trainingProviderId}/post/requestBody","description":"The contact"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingProviders/{tenantId}/portal/examRegistrationOrder/{trainingProviderId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_380"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/examRegistrationOrder/{trainingProviderId}","href":"training-providers/generatetrainingproviderexamregistrationorder","openApiOperationId":"generateTrainingProviderExamRegistrationOrder","summary":"Create a new Exam Registration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1examRegistrationOrder~1{trainingProviderId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/generatetrainingproviderexamregistrationorder"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/examRegistrationOrder/{trainingProviderId}"},{"label":"List exam registrations by contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/listexamregistrationsbycontact","routeSlug":"/apis/certifications/certifications-v1/training-providers/listexamregistrationsbycontact","metadata":{"seo":{"title":"List exam registrations by contact","description":"Shows a list of exam registration by contact"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listExamRegistrationsByContact","name":"List exam registrations by contact","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1examRegistrations~1{trainingProviderId}~1{contactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List exam registrations by contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Shows a list of exam registration by contact"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The contact","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1examRegistrations~1{trainingProviderId}~1{contactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/portal/examRegistrations/{trainingProviderId}/{contactId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/examRegistrations/{trainingProviderId}/{contactId}","href":"training-providers/listexamregistrationsbycontact","openApiOperationId":"listExamRegistrationsByContact","summary":"List exam registrations by contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1examRegistrations~1{trainingProviderId}~1{contactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/listexamregistrationsbycontact"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/examRegistrations/{trainingProviderId}/{contactId}"},{"label":"Generate a new certification application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/generatetrainingprovidercertificationapplication","routeSlug":"/apis/certifications/certifications-v1/training-providers/generatetrainingprovidercertificationapplication","metadata":{"seo":{"title":"Generate a new certification application","description":"Allows for a portal user to generate a certification application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateTrainingProviderCertificationApplication","name":"Generate a new certification application","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1generateApplication~1{trainingProviderId}~1{processId}~1{contactId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a new certification application","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for a portal user to generate a certification application"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"processId","in":"path","schemaId":"schema_366","description":"The contact","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The contact","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1generateApplication~1{trainingProviderId}~1{processId}~1{contactId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingProviders/{tenantId}/portal/generateApplication/{trainingProviderId}/{processId}/{contactId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"processId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/generateApplication/{trainingProviderId}/{processId}/{contactId}","href":"training-providers/generatetrainingprovidercertificationapplication","openApiOperationId":"generateTrainingProviderCertificationApplication","summary":"Generate a new certification application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1generateApplication~1{trainingProviderId}~1{processId}~1{contactId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/generatetrainingprovidercertificationapplication"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/generateApplication/{trainingProviderId}/{processId}/{contactId}"},{"label":"List invoices by contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/listinvoicesbycontact","routeSlug":"/apis/certifications/certifications-v1/training-providers/listinvoicesbycontact","metadata":{"seo":{"title":"List invoices by contact","description":"Shows a list of invoices by contact"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInvoicesByContact","name":"List invoices by contact","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1invoices~1{trainingProviderId}~1{contactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List invoices by contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Shows a list of invoices by contact"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"contactId","in":"path","schemaId":"schema_366","description":"The contact","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1invoices~1{trainingProviderId}~1{contactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/portal/invoices/{trainingProviderId}/{contactId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/invoices/{trainingProviderId}/{contactId}","href":"training-providers/listinvoicesbycontact","openApiOperationId":"listInvoicesByContact","summary":"List invoices by contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"invoice/json","mediaTypes":["invoice/json"],"mediaTypeContent":{"invoice/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1invoices~1{trainingProviderId}~1{contactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["invoice/json"],"mediaTypeContent":{"invoice/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/listinvoicesbycontact"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/invoices/{trainingProviderId}/{contactId}"},{"label":"Process Activity","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/processactivity","routeSlug":"/apis/certifications/certifications-v1/training-providers/processactivity","metadata":{"seo":{"title":"Process Activity","description":"Allows for portal users to process a certification activity"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processActivity","name":"Process Activity","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1processActivity~1{trainingProviderId}~1{activityId}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Process Activity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for portal users to process a certification activity"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true},{"name":"activityId","in":"path","schemaId":"schema_366","description":"The activity id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1processActivity~1{trainingProviderId}~1{activityId}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/trainingProviders/{tenantId}/portal/processActivity/{trainingProviderId}/{activityId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"activityId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/processActivity/{trainingProviderId}/{activityId}","href":"training-providers/processactivity","openApiOperationId":"processActivity","summary":"Process Activity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were created successfully","mediaType":"invoice/json","mediaTypes":["invoice/json"],"mediaTypeContent":{"invoice/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1processActivity~1{trainingProviderId}~1{activityId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["invoice/json"],"mediaTypeContent":{"invoice/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/processactivity"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/processActivity/{trainingProviderId}/{activityId}"},{"label":"Describe Training Provider Queries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/describetrainingproviderqueries","routeSlug":"/apis/certifications/certifications-v1/training-providers/describetrainingproviderqueries","metadata":{"seo":{"title":"Describe Training Provider Queries","description":"Returns a list of queries training providers are able to run"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"describeTrainingProviderQueries","name":"Describe Training Provider Queries","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1queries~1{trainingProviderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Describe Training Provider Queries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of queries training providers are able to run"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The tenant","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The training provider id","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1queries~1{trainingProviderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/portal/queries/{trainingProviderId}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/portal/queries/{trainingProviderId}","href":"training-providers/describetrainingproviderqueries","openApiOperationId":"describeTrainingProviderQueries","summary":"Describe Training Provider Queries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DescribeSavedQueriesResponse"}},"schemaId":"components/schemas/DescribeSavedQueriesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1portal~1queries~1{trainingProviderId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DescribeSavedQueriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DescribeSavedQueriesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/describetrainingproviderqueries"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/portal/queries/{trainingProviderId}"},{"label":"Runs a saved query on behalf of a training provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/runtrainingproviderquery","routeSlug":"/apis/certifications/certifications-v1/training-providers/runtrainingproviderquery","metadata":{"seo":{"title":"Runs a saved query on behalf of a training provider","description":"Runs a saved query on behalf of a training provider"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"runTrainingProviderQuery","name":"Runs a saved query on behalf of a training provider","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1query~1{trainingProviderId}~1{savedQueryId}~1{outputFormat}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Runs a saved query on behalf of a training provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"Parameters to the query","required":true},{"name":"trainingProviderId","in":"path","schemaId":"schema_366","description":"The trainning provider","required":true},{"name":"savedQueryId","in":"path","schemaId":"schema_366","description":"The saved query ID","required":true},{"name":"outputFormat","in":"path","schemaId":"schema_366","description":"The output format of the query","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1query~1{trainingProviderId}~1{savedQueryId}~1{outputFormat}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","pointer":"/paths/~1trainingProviders~1{tenantId}~1query~1{trainingProviderId}~1{savedQueryId}~1{outputFormat}/post/requestBody","description":"Optional query criteria"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/trainingProviders/{tenantId}/query/{trainingProviderId}/{savedQueryId}/{outputFormat}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"trainingProviderId","in":"path","required":true,"schemaId":"schema_366"},{"name":"savedQueryId","in":"path","required":true,"schemaId":"schema_366"},{"name":"outputFormat","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_380"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/trainingProviders/{tenantId}/query/{trainingProviderId}/{savedQueryId}/{outputFormat}","href":"training-providers/runtrainingproviderquery","openApiOperationId":"runTrainingProviderQuery","summary":"Runs a saved query on behalf of a training provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_380"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The contact was merged successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The contact supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The contact could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The contact could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to merge contact based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1query~1{trainingProviderId}~1{savedQueryId}~1{outputFormat}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/runtrainingproviderquery"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/query/{trainingProviderId}/{savedQueryId}/{outputFormat}"},{"label":"Returns a training provider from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/deletetrainingprovider","routeSlug":"/apis/certifications/certifications-v1/training-providers/deletetrainingprovider","metadata":{"seo":{"title":"Returns a training provider from the system by its ID.","description":"This method will delete a training provider with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTrainingProvider","name":"Returns a training provider from the system by its ID.","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a training provider from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a training provider with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the training provider to delete.","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/trainingProviders/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/trainingProviders/{tenantId}/{id}","href":"training-providers/deletetrainingprovider","openApiOperationId":"deleteTrainingProvider","summary":"Returns a training provider from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training provider was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The training provider could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The training provider could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to delete training provider based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/deletetrainingprovider"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/{id}"},{"label":"Returns a training provider from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/gettrainingprovider","routeSlug":"/apis/certifications/certifications-v1/training-providers/gettrainingprovider","metadata":{"seo":{"title":"Returns a training provider from the system by its ID.","description":"This method will look up a training provider by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTrainingProvider","name":"Returns a training provider from the system by its ID.","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a training provider from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a training provider by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the training provider to return.","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_366","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_366","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/trainingProviders/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_366"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_366"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/trainingProviders/{tenantId}/{id}","href":"training-providers/gettrainingprovider","openApiOperationId":"getTrainingProvider","summary":"Returns a training provider from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training provider was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingProvider"}},"schemaId":"components/schemas/TrainingProvider","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The training provider could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve training provider based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TrainingProvider","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingProvider"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/gettrainingprovider"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/{id}"},{"label":"Partially updates a training provider with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/patchtrainingprovider","routeSlug":"/apis/certifications/certifications-v1/training-providers/patchtrainingprovider","metadata":{"seo":{"title":"Partially updates a training provider with the specified ID.","description":"This method will patch an existing training provider with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchTrainingProvider","name":"Partially updates a training provider with the specified ID.","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a training provider with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing training provider with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the training provider to patch.","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369","pointer":"/paths/~1trainingProviders~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/trainingProviders/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_369"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/trainingProviders/{tenantId}/{id}","href":"training-providers/patchtrainingprovider","openApiOperationId":"patchTrainingProvider","summary":"Partially updates a training provider with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_369"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training provider was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingProvider"}},"schemaId":"components/schemas/TrainingProvider","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The training provider could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The training provider could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve training provider based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TrainingProvider","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingProvider"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/patchtrainingprovider"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/{id}"},{"label":"Updates a training provider with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/certifications/certifications-v1/training-providers/updatetrainingprovider","routeSlug":"/apis/certifications/certifications-v1/training-providers/updatetrainingprovider","metadata":{"seo":{"title":"Updates a training provider with the specified ID.","description":"This method will update an existing training provider with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTrainingProvider","name":"Updates a training provider with the specified ID.","isWebhook":false,"pointer":"/paths/~1trainingProviders~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a training provider with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing training provider with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_366","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_366","description":"The ID of the training provider to update.","required":true}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TrainingProvider"}},"schemaId":"components/schemas/TrainingProvider","pointer":"/paths/~1trainingProviders~1{tenantId}~1{id}/put/requestBody","description":"The updated training provider that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/trainingProviders/{tenantId}/{id}","servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_366"},{"name":"id","in":"path","required":true,"schemaId":"schema_366"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TrainingProvider"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/trainingProviders/{tenantId}/{id}","href":"training-providers/updatetrainingprovider","openApiOperationId":"updateTrainingProvider","summary":"Updates a training provider with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/certifications/certifications-v1","description":"Mock server","isMockServer":true},{"url":"https://certifications.api.rhythmsoftware.com"}],"schemaId":"components/schemas/TrainingProvider","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TrainingProvider"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The training provider was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingProvider"}},"schemaId":"components/schemas/TrainingProvider","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"400","description":"The training provider supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"404","description":"The training provider could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"409","description":"The training provider could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"429","description":"Limit exceeded... unable to retrieve training provider based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_368"}],"pointer":"/paths/~1trainingProviders~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TrainingProvider","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TrainingProvider"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/training-providers/updatetrainingprovider"}],"panels":[]}]},"httpPath":"/trainingProviders/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Training Providers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Training Providers","showPageActions":true},{"nodeType":"markdoc","content":"Training Providers"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/trainingProviders/{tenantId}","summary":"Gets all of the training providers in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/listtrainingproviders","deprecated":false},{"title":"/trainingProviders/{tenantId}","summary":"Creates a new training provider record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-providers/createtrainingprovider","deprecated":false},{"title":"/trainingProviders/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-providers/executebatchoperations","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/activities/{trainingProviderId}/{contactId}","summary":"List Activities By Contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/listactivitiesbycontact","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/activity/{trainingProviderId}","summary":"Create Activity","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-providers/createactivity","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/activity/{trainingProviderId}","summary":"Update an activity","prefix":{"name":"put","color":"put"},"badges":[],"link":"/training-providers/updateactivity","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/application/{trainingProviderId}","summary":"Create a new certification application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-providers/createtrainingprovidercertificationapplication","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/application/{trainingProviderId}/{applicationId}","summary":"Get a certification application","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/gettrainingproviderapplication","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/application/{trainingProviderId}/{applicationId}","summary":"Get a certification application","prefix":{"name":"put","color":"put"},"badges":[],"link":"/training-providers/updatetrainingproviderapplication","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/applicationOrder/{trainingProviderId}","summary":"Create a new application order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-providers/generatetrainingproviderapplicationorder","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/applications/{trainingProviderId}/{contactId}","summary":"List applications by contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/listapplicationsbycontact","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/certification/{trainingProviderId}/{certificationId}","summary":"Get a Certification","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/gettrainingprovidercertification","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/certifications/{trainingProviderId}/{contactId}","summary":"List certifications by contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/listcertificationsbycontact","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/contact/{trainingProviderId}","summary":"Create a new Contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-providers/createtrainingprovidercontact","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/contact/{trainingProviderId}/{contactId}","summary":"Get a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/gettrainingprovidercontact","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/contact/{trainingProviderId}/{contactId}","summary":"Update a contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/training-providers/updatetrainingprovidercontact","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/contactSearch/{trainingProviderId}","summary":"Search for contacts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-providers/searchfortrainingprovidercontacts","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/courseRegistration/{trainingProviderId}","summary":"Create a new Course Registration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-providers/createtrainingprovidercourseregistration","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/courseRegistration/{trainingProviderId}/{courseRegistrationId}","summary":"Get a Course Registration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/gettrainingprovidercourseregistration","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/courseRegistrationOrder/{trainingProviderId}","summary":"Create a new Course Registration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-providers/generatetrainingprovidercourseregistrationorder","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/courseRegistrations/{trainingProviderId}/{contactId}","summary":"List course registrations by contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/listcourseregistrationsbycontact","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/eligibleActivityRegProcess/{trainingProviderId}/{contactId}/{activityTypeId}","summary":"Get eligible activity reg processes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/geteligibleactivityprocesses","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/eligibleApplicationProcess/{trainingProviderId}/{programId}/{customerType}/{contactOrOrganizationId}","summary":"Get eligible application processes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/geteligibleapplicationprocesses","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/eligibleCourseRegProcess/{trainingProviderId}/{contactId}/{courseId}","summary":"Get eligible course registration process","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/geteligiblecourseregprocesses","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/eligibleExamRegProcess/{trainingProviderId}/{contactId}/{examId}","summary":"Get eligible exam registration processes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/geteligibleexamregprocesses","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/examRegistration/{trainingProviderId}","summary":"Create a new Exam Registration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-providers/createtrainingproviderexamregistration","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/examRegistration/{trainingProviderId}/{examRegistrationId}","summary":"Get an Exam Registration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/gettrainingproviderexamregistration","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/examRegistrationOrder/{trainingProviderId}","summary":"Create a new Exam Registration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-providers/generatetrainingproviderexamregistrationorder","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/examRegistrations/{trainingProviderId}/{contactId}","summary":"List exam registrations by contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/listexamregistrationsbycontact","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/generateApplication/{trainingProviderId}/{processId}/{contactId}","summary":"Generate a new certification application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-providers/generatetrainingprovidercertificationapplication","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/invoices/{trainingProviderId}/{contactId}","summary":"List invoices by contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/listinvoicesbycontact","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/processActivity/{trainingProviderId}/{activityId}","summary":"Process Activity","prefix":{"name":"put","color":"put"},"badges":[],"link":"/training-providers/processactivity","deprecated":false},{"title":"/trainingProviders/{tenantId}/portal/queries/{trainingProviderId}","summary":"Describe Training Provider Queries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/describetrainingproviderqueries","deprecated":false},{"title":"/trainingProviders/{tenantId}/query/{trainingProviderId}/{savedQueryId}/{outputFormat}","summary":"Runs a saved query on behalf of a training provider","prefix":{"name":"post","color":"post"},"badges":[],"link":"/training-providers/runtrainingproviderquery","deprecated":false},{"title":"/trainingProviders/{tenantId}/{id}","summary":"Returns a training provider from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/training-providers/deletetrainingprovider","deprecated":false},{"title":"/trainingProviders/{tenantId}/{id}","summary":"Returns a training provider from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/training-providers/gettrainingprovider","deprecated":false},{"title":"/trainingProviders/{tenantId}/{id}","summary":"Partially updates a training provider with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/training-providers/patchtrainingprovider","deprecated":false},{"title":"/trainingProviders/{tenantId}/{id}","summary":"Updates a training provider with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/training-providers/updatetrainingprovider","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Activity":{"id":"components/schemas/Activity","kind":"json-schema","title":"Activity","data":{"additionalProperties":false,"properties":{"additional_details":{"description":"Additional details","title":"Additional Details","type":"string"},"contact_id":{"description":"The owner of the activity","title":"Contact","type":"string"},"credit_calculator_variables":{"title":"Credit Calculator Variables","type":"object"},"credits":{"items":{"additionalProperties":false,"properties":{"credit_type_id":{"description":"The type of credit","title":"Credit Type","type":"string"},"quantity":{"description":"The amount of credits","format":"double","minimum":0,"title":"Quantity","type":"number"}},"required":["credit_type_id","quantity"],"type":"object"},"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"Date of the activity","title":"Date","type":"string"},"file_upload_uri":{"description":"File upload for supporting documentation of the activity","title":"File Upload Uri","type":"string"},"id":{"description":"The unique, string identifier of this activity","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"name":{"description":"Name of the activity","title":"Name","type":"string"},"process_id":{"description":"The reporting process","title":"Process","type":"string"},"processed_date":{"description":"The date the activity was processed","format":"date-time","title":"Processed Date","type":"string"},"quantity":{"description":"If applicable, quantity associated with the activity","format":"float","title":"Quantity","type":"number"},"status":{"enum":["draft","processed","under review","verified"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total_number_of_credits":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total # of credits"},"children":[]}]}]}],"format":"double","title":"Total Number Of Credits","type":"number"},"type_id":{"description":"The type of activity","title":"Type","type":"string"}},"required":["contact_id","date","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type_id"],"type":"object"}},"components/schemas/ActivityRegProcess":{"id":"components/schemas/ActivityRegProcess","kind":"json-schema","title":"ActivityRegProcess","data":{"additionalProperties":false,"properties":{"activity_type_ids":{"items":{"type":"string"},"title":"Activity Types","type":"array"},"available_in_portal":{"description":"If true, not available in the portal","title":"Available In Portal","type":"boolean"},"confirmation_email":{"additionalProperties":false,"description":"Email to send once the registration is activated","properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Confirmation Email","type":"object"},"contact_form_options":{"additionalProperties":false,"properties":{"contact_form_id":{"description":"The default contact form to present to the user to verify the contact info before proceeding","pattern":"^rolodex-contacts__.*","title":"Contact Form","type":"string"},"html":{"description":"Text to show on the top of the form","title":"Html","type":"string"}},"required":["contact_form_id"],"title":"Contact Form Options","type":"object"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"A description of the process to help the user understand whether to choose","title":"Description","type":"string"},"display_in_portal_as":{"description":"How to display in portal","title":"Display In Portal As","type":"string"},"display_order":{"description":"The display order","format":"float","title":"Display Order","type":"number"},"enable_confirmation_email":{"description":"Whether or not to send an email when the registration is processed","title":"Enable Confirmation Email","type":"boolean"},"form_id":{"description":"The default application form for this process","pattern":"^certifications-activities__.*","title":"Form","type":"string"},"id":{"description":"The unique, string identifier of this activity reg process","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this activity reg process is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the activity reg process","title":"Name","type":"string"},"restrict_activity_types":{"description":"Restrict activity types","title":"Restrict Activity Types","type":"boolean"},"show_contact_form":{"description":"Whether or not to show a contact form","title":"Show Contact Form","type":"boolean"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"enum":["self-report"],"title":"Type","type":"string"}},"required":["activity_type_ids","confirmation_email","contact_form_options","form_id","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type"],"type":"object"}},"components/schemas/ActivitySearchParameters":{"id":"components/schemas/ActivitySearchParameters","kind":"json-schema","title":"ActivitySearchParameters","data":{"additionalProperties":false,"properties":{"date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"name":{"title":"Name","type":"string"},"processed_date":{"items":{"format":"date-time","type":"string"},"title":"Processed Date","type":"array"},"quantity":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Quantity","type":"array"},"status":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Status","type":"array"},"sys_created_at":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Sys Created At","type":"array"},"total_number_of_credits":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total Number Of Credits","type":"array"},"type_id":{"items":{"type":"string"},"title":"Type","type":"array"}},"type":"object"}},"components/schemas/ActivitySearchResults":{"id":"components/schemas/ActivitySearchResults","kind":"json-schema","title":"ActivitySearchResults","data":{"additionalProperties":false,"properties":{"additional_details":{"description":"Additional details","title":"Additional Details","type":"string"},"contact_id":{"description":"The owner of the activity","title":"Contact","type":"string"},"credit_calculator_variables":{"title":"Credit Calculator Variables","type":"object"},"credits":{"items":{"additionalProperties":false,"properties":{"credit_type_id":{"description":"The type of credit","title":"Credit Type","type":"string"},"quantity":{"description":"The amount of credits","format":"double","minimum":0,"title":"Quantity","type":"number"}},"required":["credit_type_id","quantity"],"type":"object"},"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"Date of the activity","title":"Date","type":"string"},"file_upload_uri":{"description":"File upload for supporting documentation of the activity","title":"File Upload Uri","type":"string"},"id":{"description":"The unique, string identifier of this activity","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"name":{"description":"Name of the activity","title":"Name","type":"string"},"process_id":{"description":"The reporting process","title":"Process","type":"string"},"processed_date":{"description":"The date the activity was processed","format":"date-time","title":"Processed Date","type":"string"},"quantity":{"description":"If applicable, quantity associated with the activity","format":"float","title":"Quantity","type":"number"},"status":{"enum":["draft","processed","under review","verified"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total_number_of_credits":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total # of credits"},"children":[]}]}]}],"format":"double","title":"Total Number Of Credits","type":"number"},"type_id":{"description":"The type of activity","title":"Type","type":"string"}},"required":["contact_id","date","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type_id"],"type":"object"}},"components/schemas/ActivityType":{"id":"components/schemas/ActivityType","kind":"json-schema","title":"ActivityType","data":{"additionalProperties":false,"properties":{"activity_editing_options":{"additionalProperties":false,"properties":{"form_id":{"description":"The form to use","pattern":"^certifications-activities__.*","title":"Form","type":"string"},"relative_date":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Date","type":"object"},"until":{"enum":["forever","relative date"],"title":"Until","type":"string"}},"title":"Activity Editing Options","type":"object"},"additional_details_prompt":{"description":"The prompt text to show in the portal for additional details of an activity of this type","title":"Additional Details Prompt","type":"string"},"allow_editing_in_portal":{"description":"Allow for editing activities in the portal","title":"Allow Editing In Portal","type":"boolean"},"credit_calculator_options":{"additionalProperties":false,"properties":{"formulas":{"items":{"additionalProperties":false,"properties":{"credit_type_id":{"title":"Credit Type","type":"string"},"formula":{"description":"Expression ","title":"Formula","type":"string"}},"required":["credit_type_id"],"type":"object"},"type":"array"},"instructions":{"description":"Instructions to display","title":"Instructions","type":"string"},"variables":{"items":{"additionalProperties":false,"properties":{"label":{"description":"The display of the variable","title":"Label","type":"string"},"name":{"pattern":"[\\w_]+","title":"Name","type":"string"}},"required":["label","name"],"type":"object"},"minItems":1,"type":"array"}},"required":["variables"],"title":"Credit Calculator Options","type":"object"},"credit_instructions":{"description":"Instructions on how to give CEU credits","title":"Credit Instructions","type":"string"},"credit_type_ids":{"description":"The CEU types granted by activities of this type","items":{"type":"string"},"title":"Credit Types","type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date_prompt":{"description":"The prompt text to show in the portal for the date of an activity of this type","title":"Date Prompt","type":"string"},"description":{"description":"Description of this activity and what credits it generates","title":"Description","type":"string"},"display_order":{"description":"Order to display this type","format":"float","title":"Display Order","type":"number"},"enable_credit_calculator":{"description":"Enables to display of a credit calculate to automatically calculate credits","title":"Enable Credit Calculator","type":"boolean"},"file_upload_prompt":{"description":"The prompt text to show in the portal for an file upload of an activity of this type","title":"File Upload Prompt","type":"string"},"file_upload_setting":{"description":"Whether or not this activity requires a file upload","enum":["disabled","optional","required"],"title":"File Upload Setting","type":"string"},"hide_from_portal":{"description":"If set, hide from portal","title":"Hide From Portal","type":"boolean"},"id":{"description":"The unique, string identifier of this activity type","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this activity type is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the activity type","title":"Name","type":"string"},"name_prompt":{"description":"The prompt text to show in the portal for the name of an activity of this type","title":"Name Prompt","type":"string"},"quantity_prompt":{"description":"The prompt text to show in the portal for quantity","title":"Quantity Prompt","type":"string"},"quantity_setting":{"description":"Whether or not this activity requires a quantity","enum":["disabled","optional","required"],"title":"Quantity Setting","type":"string"},"require_additional_details":{"description":"Whether additional details are required","title":"Require Additional Details","type":"boolean"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["credit_calculator_options","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"additionalProperties":false,"description":"A complete address","properties":{"city":{"description":"The city of the address","title":"City","type":"string"},"country":{"description":"The country ISO code","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","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","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","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","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"maxLength":2,"minLength":2,"title":"Country","type":"string"},"country_name":{"description":"The full name of hte country","title":"Country Name","type":"string"},"county":{"description":"The county","title":"County","type":"string"},"latitude":{"format":"double","title":"Latitude","type":"number"},"line1":{"description":"The first line of the address","title":"Line 1","type":"string"},"line2":{"description":"The second line of the address","title":"Line 2","type":"string"},"line3":{"description":"The third line of the address","title":"Line 3","type":"string"},"longitude":{"format":"double","title":"Longitude","type":"number"},"postal_code":{"description":"The zip/postal code","title":"Postal Code","type":"string"},"state":{"description":"The state/province of the address","title":"State","type":"string"},"time_zone_id":{"title":"Time Zone","type":"string"}},"type":"object"}},"components/schemas/AppReferenceProcess":{"id":"components/schemas/AppReferenceProcess","kind":"json-schema","title":"AppReferenceProcess","data":{"additionalProperties":false,"properties":{"application_notice_email":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Application Notice Email","type":"object"},"contact_form_options":{"additionalProperties":false,"properties":{"contact_form_id":{"description":"The default contact form to present to the user to verify the contact info before proceeding","pattern":"^rolodex-contacts__.*","title":"Contact Form","type":"string"},"html":{"description":"Text to show on the top of the form","title":"Html","type":"string"}},"required":["contact_form_id"],"title":"Contact Form Options","type":"object"},"display_in_portal":{"description":"Whether or not to hide in the portal","title":"Display In Portal","type":"boolean"},"display_in_portal_as":{"description":"How to display this process in the portal","title":"Display In Portal As","type":"string"},"enable_application_notice_email":{"description":"If true, an email is sent to the applicant notifying them that their application still requires a reference","title":"Enable Application Notice Email","type":"boolean"},"enable_reference_notification_email":{"description":"If true, an email is sent to the reference once the application is processes","title":"Enable Reference Notification Email","type":"boolean"},"id":{"description":"The unique, string identifier of this reference","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this process is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the process","title":"Name","type":"string"},"organization_form_options":{"additionalProperties":false,"properties":{"html":{"description":"Text to show on the top of the form","title":"Html","type":"string"},"organization_form_id":{"description":"The default organization form to present to the user to verify the organization info before proceeding","pattern":"^rolodex-organizations__.*","title":"Organization Form","type":"string"}},"required":["organization_form_id"],"title":"Organization Form Options","type":"object"},"reference_form_id":{"description":"The form the reference should use","pattern":"^certifications-application-references__.*","title":"Reference Form","type":"string"},"reference_notification_email":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Reference Notification Email","type":"object"},"show_contact_form":{"description":"Whether or not to show a contact form","title":"Show Contact Form","type":"boolean"},"show_organization_form":{"description":"Whether or not to show an organization form","title":"Show Organization Form","type":"boolean"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["application_notice_email","contact_form_options","id","name","organization_form_options","reference_form_id","reference_notification_email","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/AppReferenceType":{"id":"components/schemas/AppReferenceType","kind":"json-schema","title":"AppReferenceType","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this app reference type","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this app reference type is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the app reference type","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/AppStatusReason":{"id":"components/schemas/AppStatusReason","kind":"json-schema","title":"AppStatusReason","data":{"additionalProperties":false,"properties":{"applicable_statuses":{"items":{"enum":["activated","approved","draft","expired","missing requirements","pending approval","rejected"],"type":"string"},"title":"Applicable Statuses","type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this app status reason","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this app status reason is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the app status reason","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Application":{"id":"components/schemas/Application","kind":"json-schema","title":"Application","data":{"additionalProperties":false,"properties":{"activation_date":{"description":"The date the certification was activated","title":"Activation Date","type":"string"},"average_score":{"description":"The average score for this submission in the most recent round","format":"float","title":"Average Score","type":"number"},"bucket_id":{"description":"The review bucket","title":"Bucket","type":"string"},"certification_id":{"description":"The certification that this application is tied to","title":"Certification","type":"string"},"city":{"description":"The member city","title":"City","type":"string"},"contact_id":{"description":"The contact who is applying","title":"Contact","type":"string"},"country":{"description":"The member country","title":"Country","type":"string"},"course_offering_ids":{"items":{"type":"string"},"title":"Course Offerings","type":"array"},"credits":{"items":{"additionalProperties":false,"properties":{"credit_id":{"description":"The credit being used","title":"Credit","type":"string"},"credit_type_id":{"description":"The type of credit","title":"Credit Type","type":"string"},"exclusive":{"description":"If true, this credit application reduced the available quantity on the credit","title":"Exclusive","type":"boolean"},"quantity":{"description":"The number of credits applied to the application","format":"double","title":"Quantity","type":"number"}},"required":["credit_id","credit_type_id","quantity"],"type":"object"},"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the application","title":"Date","type":"string"},"email_address":{"description":"The member's email address","title":"Email Address","type":"string"},"embed_membership_application":{"description":"Whether or not to embed a whole membership application","title":"Embed Membership Application","type":"boolean"},"exam_fail_letter_sent_date":{"description":"The date a letter was sent notifying the user that the failed the exam","title":"Exam Fail Letter Sent Date","type":"string"},"exam_offering_ids":{"items":{"type":"string"},"title":"Exam Offerings","type":"array"},"exam_pass_letter_sent_date":{"description":"The date a letter was sent notifying the user that the passed the exam","title":"Exam Pass Letter Sent Date","type":"string"},"expiration_date":{"description":"The date this application should no longer be eligible","title":"Expiration Date","type":"string"},"first_name":{"description":"The member's first name","title":"First Name","type":"string"},"id":{"description":"The unique, string identifier of this application","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"job_title":{"description":"The member job title","title":"Job Title","type":"string"},"last_name":{"description":"The member's last name","title":"Last Name","type":"string"},"last_reminder_date":{"description":"The last time a reminder was sent for this application","title":"Last Reminder Date","type":"string"},"last_requirements_calculation_date":{"description":"The date/time that requirements were last calculated","format":"date-time","title":"Last Requirements Calculation Date","type":"string"},"last_review_status_change":{"description":"The date that the review status was last changed","format":"date-time","title":"Last Review Status Change","type":"string"},"missing_requirements":{"description":"A list of missing requirements... this is automatically calculated for reporting only","items":{"additionalProperties":false,"properties":{"id":{"description":"Requirement id","title":"ID","type":"string"},"internal_notes":{"description":"Internal notes","title":"Internal Notes","type":"string"},"name":{"description":"A description of the requirement","title":"Name","type":"string"},"notes":{"description":"Any notes, visible to the applicant","title":"Notes","type":"string"},"portal_explanation":{"title":"Portal Explanation","type":"string"},"type":{"title":"Type","type":"string"},"weight":{"format":"float","title":"Weight","type":"number"}},"required":["id"],"type":"object"},"type":"array"},"name":{"description":"The member's name","title":"Name","type":"string"},"name_to_be_printed_on_certificate":{"description":"The name to be displayed on the certificate","title":"Name To Be Printed On Certificate","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"notices":{"items":{"additionalProperties":false,"properties":{"date":{"description":"The date the notice was send","format":"date-time","title":"Date","type":"string"},"notice_id":{"description":"The notice","title":"Notice","type":"string"}},"required":["date","notice_id"],"type":"object"},"type":"array"},"number":{"description":"The application number","format":"float","title":"Number","type":"number"},"number_of_missing_requirements":{"description":"The number of missing requirements","format":"float","title":"Number Of Missing Requirements","type":"number"},"order_id":{"description":"The order that last touched this application","title":"Order","type":"string"},"order_line_item_id":{"description":"The order line item touched this application","title":"Order Line Item","type":"string"},"organization_id":{"description":"The organization","title":"Organization","type":"string"},"override_bucket_assignment":{"description":"If set, the bucket is not calculated automatically, and instead manually assigned","title":"Override Bucket Assignment","type":"boolean"},"owner_type":{"enum":["contact","organization"],"title":"Owner Type","type":"string"},"pending_console_review":{"description":"If true, then this record has been reviewed and now needs action by the staff","title":"Pending Console Review","type":"boolean"},"percentage_complete":{"description":"The percentage of requirements that have been met","format":"float","title":"Percentage Complete","type":"number"},"process_id":{"description":"The application process","title":"Process","type":"string"},"program_id":{"description":"The certification program","title":"Program","type":"string"},"references":{"items":{"additionalProperties":false,"properties":{"id":{"description":"A unique identifier for the reference","title":"ID","type":"string"},"reference_contact_info":{"additionalProperties":false,"description":"Contact info for the reference","properties":{},"title":"Reference Contact Info","type":"object"},"reference_type_id":{"description":"Type of reference","title":"Reference Type","type":"string"}},"type":"object"},"minItems":1,"type":"array"},"requirements":{"items":{"additionalProperties":false,"properties":{"date_requirement_fulfilled":{"description":"The date that the requirement was fulfilled","format":"date-time","title":"Date Requirement Fulfilled","type":"string"},"id":{"description":"Requirement id","title":"ID","type":"string"},"internal_notes":{"description":"Internal notes","title":"Internal Notes","type":"string"},"name":{"description":"A description of the requirement","title":"Name","type":"string"},"not_applicable":{"description":"If true, this requirement is not applicable to this application and not used in calculations","title":"Not Applicable","type":"boolean"},"notes":{"description":"Any notes, visible to the applicant","title":"Notes","type":"string"},"portal_explanation":{"title":"Portal Explanation","type":"string"},"status":{"enum":["fulfilled","pending review","unfulfilled"],"title":"Status","type":"string"},"type":{"title":"Type","type":"string"},"weight":{"format":"float","title":"Weight","type":"number"}},"required":["id","status"],"type":"object"},"type":"array"},"review_board_approval_date":{"description":"The date the application was decided by the board","title":"Review Board Approval Date","type":"string"},"review_board_submission_date":{"description":"The date the application was submitted to the review board","title":"Review Board Submission Date","type":"string"},"review_status":{"description":"The review status of this application","enum":["accepted","alternate","declined","pending review"],"title":"Review Status","type":"string"},"reviewer_recommendation":{"description":"Aggregate recommendation across all reviewers","title":"Reviewer Recommendation","type":"string"},"round_id":{"description":"The review round","title":"Round","type":"string"},"signature_uri":{"description":"The signature","title":"Signature Uri","type":"string"},"state":{"description":"The state","title":"State","type":"string"},"status":{"enum":["activated","approved","draft","expired","missing requirements","pending approval","rejected"],"title":"Status","type":"string"},"status_reason_id":{"description":"The reason the app is in the status - sub-status","title":"Status Reason","type":"string"},"submission_space_id":{"description":"The submission space to which this object belongs","title":"Submission Space","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"target_program_id":{"description":"For transfer applications, the target program to transfer","title":"Target Program","type":"string"},"total_score":{"description":"The total score for this submission in the most recent round","format":"float","title":"Total Score","type":"number"},"training_provider_billing_date":{"description":"The date this application was billing to the training provider","title":"Training Provider Billing Date","type":"string"},"training_provider_billing_invoice_id":{"description":"The invoice that was created to bill for this application","title":"Training Provider Billing Invoice","type":"string"},"training_provider_billing_invoice_line_item_id":{"description":"The invoice that was created to bill for this application","title":"Training Provider Billing Invoice Line Item","type":"string"},"training_provider_billing_name":{"description":"The training provider name (for billing)","title":"Training Provider Billing Name","type":"string"},"training_provider_billing_status":{"description":"The training provider billing status for this application","enum":["billed","billing hold","exempt from billing","not yet billed"],"title":"Training Provider Billing Status","type":"string"},"training_provider_id":{"description":"The training provider with which this application is associated","title":"Training Provider","type":"string"},"type":{"enum":["certification","reinstatement","renewal","transfer"],"title":"Type","type":"string"}},"required":["bucket_id","contact_id","date","id","name","organization_id","owner_type","program_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","target_program_id","type"],"type":"object"}},"components/schemas/ApplicationFee":{"id":"components/schemas/ApplicationFee","kind":"json-schema","title":"ApplicationFee","data":{"additionalProperties":false,"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bulk_pricing_rules":{"items":{"additionalProperties":false,"properties":{"discount_amount":{"description":"The percentage/flat rate","format":"float","minimum":0,"title":"Discount Amount","type":"number"},"discount_type":{"description":"The type of discount rule","enum":["flat rate","percentage"],"title":"Discount Type","type":"string"},"ending_range":{"description":"The ending range of the rule","minimum":0,"title":"Ending Range","type":"integer"},"starting_range":{"description":"The starting range of the rule","minimum":0,"title":"Starting Range","type":"integer"}},"required":["discount_amount","discount_type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products":{"items":{"additionalProperties":false,"properties":{"member_price":{"description":"The member price","format":"double","title":"Member Price","type":"number"},"price":{"description":"The price to bundle","format":"double","title":"Price","type":"number"},"product_id":{"description":"The product ID","title":"Product","type":"string"},"product_type":{"description":"The product type","title":"Product Type","type":"string"},"quantity":{"description":"The quantity to bundle","title":"Quantity","type":"integer"},"type":{"enum":["bundled product","inline bundled product"],"title":"Type","type":"string"}},"required":["product_id","product_type","quantity","type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products_inventory_handling":{"description":"Whether to track inventory for the entire bundle, or for each product separately","enum":["bundle","each product"],"title":"Bundled Products Inventory Handling","type":"string"},"business_unit_id":{"description":"The business unit of the product","title":"Business Unit","type":"string"},"cancellation_fee":{"description":"Cancellation fees associated with this product","format":"double","title":"Cancellation Fee","type":"number"},"commerce_entitlements_to_create":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"quantity":{"description":"The quantity","format":"float","title":"Quantity","type":"number"},"relative_expiration_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["expiration_type","type_id"],"type":"object"},"type":"array"},"coupon_codes":{"items":{"additionalProperties":false,"properties":{"coupon_code_generation_process_id":{"description":"The process by which the coupons are generated","title":"Coupon Code Generation Process","type":"string"},"coupon_code_type":{"enum":["multi use","single use"],"title":"Coupon Code Type","type":"string"},"coupon_id":{"title":"Coupon","type":"string"},"coupon_type":{"title":"Coupon Type","type":"string"},"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"maximum_number_of_total_uses":{"description":"The maximum number of total uses","minimum":1,"oneOf":[{"enum":[1],"x-required":true}],"title":"Maximum Number Of Total Uses","type":"integer"},"maximum_number_of_uses_per_customer":{"description":"The maximum number of total uses for a given customer","minimum":1,"oneOf":[{"enum":[1],"x-required":true}],"title":"Maximum Number Of Uses Per Customer","type":"integer"},"quantity":{"description":"The number of coupons to generate","maximum":250,"title":"Quantity","type":"integer"},"relative_expiration_date":{"additionalProperties":false,"description":"Expiration date relative to purchase","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"},"restrict_to_contact":{"description":"If true, the code generated is restricted to the contact who made the purchase","title":"Restrict To Contact","type":"boolean"},"restrict_to_organization":{"description":"If true, the code generated is restricted to the organization made the purchase","title":"Restrict To Organization","type":"boolean"}},"required":["coupon_code_generation_process_id","coupon_code_type","coupon_id","coupon_type","quantity"],"type":"object"},"minItems":1,"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"custom_pricing_options":{"additionalProperties":false,"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Pricing Options","type":"object"},"document_entitlements_to_create":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"file_cabinet_id":{"description":"The file cabinet","title":"File Cabinet","type":"string"},"item_id":{"description":"The item","title":"Item","type":"string"},"library_path":{"description":"The optional path that items will be mounted onto the digital library","title":"Library Path","type":"string"},"relative_expiration_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"}},"required":["expiration_type","file_cabinet_id"],"type":"object"},"type":"array"},"enable_bulk_pricing":{"description":"Whether or not bulk pricing is enabled","title":"Enable Bulk Pricing","type":"boolean"},"enable_bundled_products":{"description":"Whether to enable bundled products","title":"Enable Bundled Products","type":"boolean"},"enable_cancellation_fees":{"description":"Whether or not cancellation fees are applicable","title":"Enable Cancellation Fees","type":"boolean"},"enable_commerce_entitlement_creation":{"description":"If set, document entitlements will be created to access folders or documents","title":"Enable Commerce Entitlement Creation","type":"boolean"},"enable_coupon_code_generation":{"description":"If true, purchasing this product will generate coupons","title":"Enable Coupon Code Generation","type":"boolean"},"enable_custom_pricing":{"description":"If set, the order engine will call out to a custom lambda function for custom/complex pricing","title":"Enable Custom Pricing","type":"boolean"},"enable_document_entitlement_creation":{"description":"If set, document entitlements will be created to access folders or documents","title":"Enable Document Entitlement Creation","type":"boolean"},"enable_product_confirmation_email":{"description":"If enabled, a custom email goes out whenever this product is ordered","title":"Enable Product Confirmation Email","type":"boolean"},"enable_purchase_limits":{"description":"If true, purchase limits are in place for this product","title":"Enable Purchase Limits","type":"boolean"},"enable_purchasing_eligibility":{"description":"If set, purchases of this merchandise are restricted","title":"Enable Purchasing Eligibility","type":"boolean"},"enable_special_prices":{"description":"Whether to enable special pricing logic","title":"Enable Special Prices","type":"boolean"},"enable_task_generation":{"description":"If set, tasks will be generated","title":"Enable Task Generation","type":"boolean"},"foreign_currency_prices":{"items":{"additionalProperties":false,"properties":{"cancellation_fee":{"description":"The cancellation fee of the product for this currency","format":"double","title":"Cancellation Fee","type":"number"},"currency_code":{"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"title":"Currency Code","type":"string"},"member_price":{"description":"The price of the product for a member","format":"double","title":"Member Price","type":"number"},"mode":{"description":"How this foreign currency should be treated","enum":["calculate price","prohibit purchase","set price"],"title":"Mode","type":"string"},"price":{"description":"The price of the product","format":"double","oneOf":[{"x-required":true}],"title":"Price","type":"number"},"restocking_fee":{"description":"The restocking fee of the product for this currency","format":"double","title":"Restocking Fee","type":"number"}},"required":["currency_code"],"type":"object"},"type":"array"},"hide_from_portal":{"description":"If set, this product should not be shown in the portal","title":"Hide From Portal","type":"boolean"},"id":{"description":"The unique, string identifier of this miscellaneous product","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"type":"array"},"is_active":{"description":"Whether this product is active/used","title":"Is Active","type":"boolean"},"member_price":{"description":"The price of the product for an active member","format":"double","title":"Member Price","type":"number"},"name":{"description":"The name of the miscellaneous product","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"portal_options":{"additionalProperties":false,"properties":{"available_from":{"description":"The date from which this product should be available","format":"date-time","title":"Available From","type":"string"},"available_until":{"description":"The date until which this product should be available","format":"date-time","title":"Available Until","type":"string"}},"title":"Portal Options","type":"object"},"price":{"description":"The price of the product","format":"double","title":"Price","type":"number"},"product_confirmation_email_options":{"additionalProperties":false,"properties":{"product_confirmation_email_id":{"oneOf":[{"x-required":true}],"title":"Product Confirmation Email","type":"string"},"product_specific_email":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Product Specific Email","type":"object"},"type":{"enum":["product specific","shared"],"title":"Type","type":"string"}},"title":"Product Confirmation Email Options","type":"object"},"program_id":{"description":"The program this fee belongs","title":"Program","type":"string"},"publish_to_portal":{"description":"Whether or not this product should be available in the portal","title":"Publish To Portal","type":"boolean"},"purchase_limits":{"additionalProperties":false,"properties":{"error_message":{"description":"The error message to show","title":"Error Message","type":"string"},"maximum":{"description":"The maximum","format":"float","title":"Maximum","type":"number"},"relative_time_window":{"additionalProperties":false,"description":"the time window","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Time Window","type":"object"},"time_period":{"enum":["all time","sliding time window"],"title":"Time Period","type":"string"},"type":{"enum":["per customer"],"title":"Type","type":"string"}},"required":["maximum","time_period","type"],"title":"Purchase Limits","type":"object"},"purchasing_eligibility_criteria":{"title":"Purchasing Eligibility Criteria","type":"object"},"special_prices":{"items":{"additionalProperties":false,"properties":{"criteria":{"title":"Criteria","type":"object"},"enable_formula":{"description":"if set, a formula is used to calculate the price. If the formula fails, the price is used","title":"Enable Formula","type":"boolean"},"formula":{"description":"The formula evaluated using the expr-eval npm package","oneOf":[{"x-required":true}],"title":"Formula","type":"string"},"name":{"title":"Name","type":"string"},"price":{"format":"float","title":"Price","type":"number"}},"required":["criteria","price"],"type":"object"},"minItems":1,"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"tasks_to_generate":{"items":{"additionalProperties":false,"properties":{"assignee_type":{"enum":["assignment role","queue","user"],"title":"Assignee Type","type":"string"},"assignment_role_id":{"description":"The assignment role that should receive the ask","oneOf":[{"x-required":true}],"title":"Assignment Role","type":"string"},"description":{"description":"A description","title":"Description","type":"string"},"due_date_type":{"description":"Whether there is a due date","enum":["none","relative date","specific date"],"title":"Due Date Type","type":"string"},"name":{"description":"The name of the task","title":"Name","type":"string"},"notify_assignees":{"description":"Notify assignee when the task is created","title":"Notify Assignees","type":"boolean"},"priority":{"enum":["high","low","normal","urgent"],"title":"Priority","type":"string"},"queue_id":{"description":"The queue that should be assigned the ask","oneOf":[{"x-required":true}],"title":"Queue","type":"string"},"relative_due_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Due Date","type":"object"},"specific_due_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Specific Due Date","type":"string"},"type_id":{"description":"The type of task","title":"Type","type":"string"},"user_id":{"description":"The user that should be assigned the ask","oneOf":[{"x-required":true}],"title":"User","type":"string"}},"required":["assignee_type","due_date_type","name","type_id"],"type":"object"},"type":"array"},"type":{"description":"The product type","enum":["certifications-application-fees"],"title":"Type","type":"string"}},"required":["bulk_pricing_rules","bundled_products","business_unit_id","coupon_codes","custom_pricing_options","id","installment_plan_options","name","price","product_confirmation_email_options","program_id","purchase_limits","special_prices","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ApplicationGenerationResult":{"id":"components/schemas/ApplicationGenerationResult","kind":"json-schema","title":"ApplicationGenerationResult","data":{"additionalProperties":false,"properties":{"activities":{"items":{"additionalProperties":false,"properties":{"additional_details":{"description":"Additional details","title":"Additional Details","type":"string"},"contact_id":{"description":"The owner of the activity","title":"Contact","type":"string"},"credits":{"items":{"additionalProperties":false,"properties":{"credit_type_id":{"description":"The type of credit","title":"Credit Type","type":"string"},"quantity":{"description":"The amount of credits","format":"double","minimum":0,"title":"Quantity","type":"number"}},"type":"object"},"type":"array"},"date":{"description":"Date of the activity","title":"Date","type":"string"},"file_upload_uri":{"description":"File upload for supporting documentation of the activity","title":"File Upload Uri","type":"string"},"id":{"description":"The unique, string identifier of this activity","title":"ID","type":"string"},"name":{"description":"Name of the activity","title":"Name","type":"string"},"process_id":{"description":"The reporting process","title":"Process","type":"string"},"processed_date":{"description":"The date the activity was processed","format":"date-time","title":"Processed Date","type":"string"},"quantity":{"description":"If applicable, quantity associated with the activity","format":"float","title":"Quantity","type":"number"},"status":{"enum":["draft","processed","under review","verified"],"title":"Status","type":"string"},"total_number_of_credits":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total # of credits"},"children":[]}]}]}],"format":"double","title":"Total Number Of Credits","type":"number"},"type_id":{"description":"The type of activity","title":"Type","type":"string"}},"type":"object"},"type":"array"},"application":{"additionalProperties":false,"properties":{"activation_date":{"description":"The date the certification was activated","title":"Activation Date","type":"string"},"average_score":{"description":"The average score for this submission in the most recent round","format":"float","title":"Average Score","type":"number"},"bucket_id":{"description":"The review bucket","oneOf":[{"x-required":true}],"title":"Bucket","type":"string"},"certification_id":{"description":"The certification that this application is tied to","title":"Certification","type":"string"},"city":{"description":"The member city","title":"City","type":"string"},"contact_id":{"description":"The contact who is applying","title":"Contact","type":"string"},"country":{"description":"The member country","title":"Country","type":"string"},"course_offering_ids":{"items":{"type":"string"},"title":"Course Offerings","type":"array"},"credits":{"items":{"additionalProperties":false,"properties":{"credit_id":{"description":"The credit being used","title":"Credit","type":"string"},"credit_type_id":{"description":"The type of credit","title":"Credit Type","type":"string"},"exclusive":{"description":"If true, this credit application reduced the available quantity on the credit","title":"Exclusive","type":"boolean"},"quantity":{"description":"The number of credits applied to the application","format":"double","title":"Quantity","type":"number"}},"required":["credit_id","credit_type_id","quantity"],"type":"object"},"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the application","title":"Date","type":"string"},"email_address":{"description":"The member's email address","title":"Email Address","type":"string"},"embed_membership_application":{"description":"Whether or not to embed a whole membership application","title":"Embed Membership Application","type":"boolean"},"exam_fail_letter_sent_date":{"description":"The date a letter was sent notifying the user that the failed the exam","title":"Exam Fail Letter Sent Date","type":"string"},"exam_offering_ids":{"items":{"type":"string"},"title":"Exam Offerings","type":"array"},"exam_pass_letter_sent_date":{"description":"The date a letter was sent notifying the user that the passed the exam","title":"Exam Pass Letter Sent Date","type":"string"},"expiration_date":{"description":"The date this application should no longer be eligible","title":"Expiration Date","type":"string"},"first_name":{"description":"The member's first name","title":"First Name","type":"string"},"id":{"description":"The unique, string identifier of this application","oneOf":[{"x-required":true}],"pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"job_title":{"description":"The member job title","title":"Job Title","type":"string"},"last_name":{"description":"The member's last name","title":"Last Name","type":"string"},"last_reminder_date":{"description":"The last time a reminder was sent for this application","title":"Last Reminder Date","type":"string"},"last_requirements_calculation_date":{"description":"The date/time that requirements were last calculated","format":"date-time","title":"Last Requirements Calculation Date","type":"string"},"last_review_status_change":{"description":"The date that the review status was last changed","format":"date-time","title":"Last Review Status Change","type":"string"},"missing_requirements":{"description":"A list of missing requirements... this is automatically calculated for reporting only","items":{"additionalProperties":false,"properties":{"id":{"description":"Requirement id","title":"ID","type":"string"},"internal_notes":{"description":"Internal notes","title":"Internal Notes","type":"string"},"name":{"description":"A description of the requirement","title":"Name","type":"string"},"notes":{"description":"Any notes, visible to the applicant","title":"Notes","type":"string"},"portal_explanation":{"title":"Portal Explanation","type":"string"},"type":{"title":"Type","type":"string"},"weight":{"format":"float","title":"Weight","type":"number"}},"required":["id"],"type":"object"},"type":"array"},"name":{"description":"The member's name","title":"Name","type":"string"},"name_to_be_printed_on_certificate":{"description":"The name to be displayed on the certificate","title":"Name To Be Printed On Certificate","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"notices":{"items":{"additionalProperties":false,"properties":{"date":{"description":"The date the notice was send","format":"date-time","title":"Date","type":"string"},"notice_id":{"description":"The notice","title":"Notice","type":"string"}},"required":["date","notice_id"],"type":"object"},"type":"array"},"number":{"description":"The application number","format":"float","title":"Number","type":"number"},"number_of_missing_requirements":{"description":"The number of missing requirements","format":"float","title":"Number Of Missing Requirements","type":"number"},"order_id":{"description":"The order that last touched this application","title":"Order","type":"string"},"order_line_item_id":{"description":"The order line item touched this application","title":"Order Line Item","type":"string"},"organization_id":{"description":"The organization","oneOf":[{"x-required":true}],"title":"Organization","type":"string"},"override_bucket_assignment":{"description":"If set, the bucket is not calculated automatically, and instead manually assigned","title":"Override Bucket Assignment","type":"boolean"},"owner_type":{"enum":["contact","organization"],"title":"Owner Type","type":"string"},"pending_console_review":{"description":"If true, then this record has been reviewed and now needs action by the staff","title":"Pending Console Review","type":"boolean"},"percentage_complete":{"description":"The percentage of requirements that have been met","format":"float","title":"Percentage Complete","type":"number"},"process_id":{"description":"The application process","title":"Process","type":"string"},"program_id":{"description":"The certification program","title":"Program","type":"string"},"references":{"items":{"additionalProperties":false,"properties":{"id":{"description":"A unique identifier for the reference","title":"ID","type":"string"},"reference_contact_info":{"additionalProperties":false,"description":"Contact info for the reference","properties":{},"title":"Reference Contact Info","type":"object"},"reference_type_id":{"description":"Type of reference","title":"Reference Type","type":"string"}},"type":"object"},"minItems":1,"type":"array"},"requirements":{"items":{"additionalProperties":false,"properties":{"date_requirement_fulfilled":{"description":"The date that the requirement was fulfilled","format":"date-time","title":"Date Requirement Fulfilled","type":"string"},"id":{"description":"Requirement id","title":"ID","type":"string"},"internal_notes":{"description":"Internal notes","title":"Internal Notes","type":"string"},"name":{"description":"A description of the requirement","title":"Name","type":"string"},"not_applicable":{"description":"If true, this requirement is not applicable to this application and not used in calculations","title":"Not Applicable","type":"boolean"},"notes":{"description":"Any notes, visible to the applicant","title":"Notes","type":"string"},"portal_explanation":{"title":"Portal Explanation","type":"string"},"status":{"enum":["fulfilled","pending review","unfulfilled"],"title":"Status","type":"string"},"type":{"title":"Type","type":"string"},"weight":{"format":"float","title":"Weight","type":"number"}},"required":["id","status"],"type":"object"},"type":"array"},"review_board_approval_date":{"description":"The date the application was decided by the board","title":"Review Board Approval Date","type":"string"},"review_board_submission_date":{"description":"The date the application was submitted to the review board","title":"Review Board Submission Date","type":"string"},"review_status":{"description":"The review status of this application","enum":["accepted","alternate","declined","pending review"],"title":"Review Status","type":"string"},"reviewer_recommendation":{"description":"Aggregate recommendation across all reviewers","title":"Reviewer Recommendation","type":"string"},"round_id":{"description":"The review round","title":"Round","type":"string"},"signature_uri":{"description":"The signature","title":"Signature Uri","type":"string"},"state":{"description":"The state","title":"State","type":"string"},"status":{"enum":["activated","approved","draft","expired","missing requirements","pending approval","rejected"],"title":"Status","type":"string"},"status_reason_id":{"description":"The reason the app is in the status - sub-status","title":"Status Reason","type":"string"},"submission_space_id":{"description":"The submission space to which this object belongs","title":"Submission Space","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","oneOf":[{"x-required":true}],"title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","oneOf":[{"x-required":true}],"title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","oneOf":[{"x-required":true}],"title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","oneOf":[{"x-required":true}],"title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"target_program_id":{"description":"For transfer applications, the target program to transfer","oneOf":[{"x-required":true}],"title":"Target Program","type":"string"},"total_score":{"description":"The total score for this submission in the most recent round","format":"float","title":"Total Score","type":"number"},"training_provider_billing_date":{"description":"The date this application was billing to the training provider","title":"Training Provider Billing Date","type":"string"},"training_provider_billing_invoice_id":{"description":"The invoice that was created to bill for this application","title":"Training Provider Billing Invoice","type":"string"},"training_provider_billing_invoice_line_item_id":{"description":"The invoice that was created to bill for this application","title":"Training Provider Billing Invoice Line Item","type":"string"},"training_provider_billing_name":{"description":"The training provider name (for billing)","title":"Training Provider Billing Name","type":"string"},"training_provider_billing_status":{"description":"The training provider billing status for this application","enum":["billed","billing hold","exempt from billing","not yet billed"],"title":"Training Provider Billing Status","type":"string"},"training_provider_id":{"description":"The training provider with which this application is associated","title":"Training Provider","type":"string"},"type":{"enum":["certification","reinstatement","renewal","transfer"],"title":"Type","type":"string"}},"required":["contact_id","date","name","owner_type","program_id","type"],"title":"Application","type":"object"},"available_credits":{"items":{"additionalProperties":false,"properties":{"credit_id":{"description":"The credit","title":"Credit","type":"string"},"credit_type_id":{"description":"The credit type","title":"Credit Type","type":"string"},"quantity_available":{"format":"float","title":"Quantity Available","type":"number"}},"type":"object"},"type":"array"},"courses":{"items":{"additionalProperties":false,"properties":{"course_ids":{"description":"The courses","items":{"type":"string"},"title":"Courses","type":"array"},"requirement_id":{"description":"The course identifier","title":"Requirement","type":"string"},"status":{"enum":["already registered","registration optional","registration required"],"title":"Status","type":"string"}},"type":"object"},"type":"array"},"credit_requirements":{"items":{"additionalProperties":false,"properties":{"credit_type_id":{"description":"The credit type","title":"Credit Type","type":"string"},"quantity_accrued":{"format":"float","title":"Quantity Accrued","type":"number"},"quantity_missing":{"format":"float","title":"Quantity Missing","type":"number"},"quantity_required":{"format":"float","title":"Quantity Required","type":"number"}},"type":"object"},"type":"array"},"exams":{"items":{"additionalProperties":false,"properties":{"exam_ids":{"description":"The courses","items":{"type":"string"},"title":"Exams","type":"array"},"first_eligible_offering_date":{"title":"First Eligible Offering Date","type":"string"},"requirement_id":{"description":"The exam identifier","title":"Requirement","type":"string"},"status":{"enum":["already registered","registration optional","registration required"],"title":"Status","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/ApplicationNotice":{"id":"components/schemas/ApplicationNotice","kind":"json-schema","title":"ApplicationNotice","data":{"additionalProperties":false,"properties":{"applicable_status_reason_ids":{"items":{"type":"string"},"title":"Applicable Status Reasons","type":"array"},"applicable_statuses":{"items":{"enum":["activated","approved","draft","missing requirements","pending approval","rejected"],"type":"string"},"title":"Applicable Statuses","type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"email":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"id":{"description":"The unique, string identifier of this application notice","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this application notice is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the application notice","title":"Name","type":"string"},"restrict_to_certain_programs":{"description":"If true, this notice is only applicable to certain certification programs","title":"Restrict To Certain Programs","type":"boolean"},"restrict_to_certain_status_reasons":{"description":"If true, this notice is only applicable to certain statuses","title":"Restrict To Certain Status Reasons","type":"boolean"},"restrict_to_certain_statuses":{"description":"If true, this notice is only applicable to certain statuses","title":"Restrict To Certain Statuses","type":"boolean"},"restricted_program_ids":{"items":{"type":"string"},"title":"Restricted Programs","type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["email","id","name","restricted_program_ids","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ApplicationProcess":{"id":"components/schemas/ApplicationProcess","kind":"json-schema","title":"ApplicationProcess","data":{"additionalProperties":false,"properties":{"allow_applicants_to_update_in_portal":{"description":"Allow for applicants to update the application while it is under review","title":"Allow Applicants To Update In Portal","type":"boolean"},"applicant_update_options":{"additionalProperties":false,"properties":{"update_form_id":{"description":"The certification application form for updating","pattern":"certifications-applications__.*","title":"Update Form","type":"string"}},"required":["update_form_id"],"title":"Applicant Update Options","type":"object"},"application_confirmation_email_options":{"additionalProperties":false,"properties":{"application_confirmation_email":{"additionalProperties":false,"description":"The email to send when the application is received","oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Application Confirmation Email","type":"object"},"application_notice_id":{"description":"The application notice to use","oneOf":[{"x-required":true}],"title":"Application Notice","type":"string"},"type":{"description":"The type of confirmation email to use","enum":["application notice","specific email"],"title":"Type","type":"string"}},"required":["type"],"title":"Application Confirmation Email Options","type":"object"},"application_expiration_rule_set_id":{"description":"The rule set for calculating the expiration of an application submitted by this process","title":"Application Expiration Rule Set","type":"string"},"application_form_id":{"description":"The certification application form","pattern":"certifications-applications__.*","title":"Application Form","type":"string"},"automatically_approve_applications_once_requirements_are_met":{"description":"If true, applications in this process are marked approved once requirements are met. Otherwise they are pending approval","title":"Automatically Approve Applications Once Requirements Are Met","type":"boolean"},"available_to_training_providers":{"description":"If true, this process is available to training providers","title":"Available To Training Providers","type":"boolean"},"certification_activation_email_options":{"additionalProperties":false,"properties":{"application_notice_id":{"description":"The application notice to use","oneOf":[{"x-required":true}],"title":"Application Notice","type":"string"},"certification_activation_email":{"additionalProperties":false,"description":"The email to send when the certification is activated","oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Certification Activation Email","type":"object"},"type":{"description":"The type of confirmation email to use","enum":["application notice","specific email"],"title":"Type","type":"string"}},"required":["type"],"title":"Certification Activation Email Options","type":"object"},"checkout_settings":{"additionalProperties":false,"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bank_account_id":{"description":"The default bank account that the store should use to receive payments","title":"Bank Account","type":"string"},"bill_my_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Organization Options","type":"object"},"bill_my_parent_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Parent Organization Options","type":"object"},"business_unit_id":{"description":"The business unit of the store","title":"Business Unit","type":"string"},"cancellation_fee_product_id":{"description":"The ID of the product used for cancellation fees","title":"Cancellation Fee Product","type":"string"},"checkout_donation_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"simple_checkout_donation_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"allow_user_to_specify_custom_amount":{"description":"If set, the user can specify their own custom donation","title":"Allow User To Specify Custom Amount","type":"boolean"},"donation_ask_text":{"description":"The text shown to the user when making the donation","title":"Donation Ask Text","type":"string"},"donation_denominations":{"items":{"format":"double","type":"number"},"title":"Donation Denominations","type":"array"},"donation_information":{"description":"Additional information about the donation","title":"Donation Information","type":"string"},"donation_product_id":{"description":"The misc product that should be used","title":"Donation Product","type":"string"},"override_donation_denominations":{"description":"If set, donation denominations are specified here and the defaults are not used","title":"Override Donation Denominations","type":"boolean"},"suggested_donation":{"description":"A suggested donation","format":"double","title":"Suggested Donation","type":"number"}},"required":["donation_product_id"],"title":"Simple Checkout Donation Options","type":"object"},"type":{"enum":["simple"],"title":"Type","type":"string"}},"title":"Checkout Donation Options","type":"object"},"credit_card_minimum_range_end":{"description":"If set, the maximum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range End","type":"number"},"credit_card_minimum_range_start":{"description":"If set, the minimum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range Start","type":"number"},"credit_card_mode":{"description":"Determines whether or not credit cards are accepted","enum":["disabled","enabled","range"],"title":"Credit Card Mode","type":"string"},"credit_card_processing_fee_mode":{"description":"Determines how credit card processing fees should be handled","enum":["charge","do not charge","prompt user"],"title":"Credit Card Processing Fee Mode","type":"string"},"credit_card_processing_fee_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"fee_percentage":{"description":"The fee percentage to charge for credit card processing ","format":"float","title":"Fee Percentage","type":"number"},"maximum_fee":{"description":"The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged","format":"float","title":"Maximum Fee","type":"number"},"minimum_fee":{"description":"The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged","format":"float","title":"Minimum Fee","type":"number"},"product_id":{"description":"The misc product to use for the credit card processing","title":"Product","type":"string"},"prompt_sub_text":{"description":"Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Sub Text","type":"string"},"prompt_text":{"description":"The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Text","type":"string"}},"required":["fee_percentage","product_id"],"title":"Credit Card Processing Fee Options","type":"object"},"custom_order_preprocessing_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Order Preprocessing Options","type":"object"},"custom_order_pricing_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Order Pricing Options","type":"object"},"disable_electronic_payment_vaulting":{"description":"If set, in the portal people are not allowed to save credit cards","title":"Disable Electronic Payment Vaulting","type":"boolean"},"enable_bill_my_organization":{"description":"If set, the user has the option to bill their organization","title":"Enable Bill My Organization","type":"boolean"},"enable_bill_my_parent_organization":{"description":"If set, the user has the option to bill their organization's parent organization","title":"Enable Bill My Parent Organization","type":"boolean"},"enable_custom_order_preprocessing":{"description":"If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion","title":"Enable Custom Order Preprocessing","type":"boolean"},"enable_custom_order_pricing":{"description":"If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation","title":"Enable Custom Order Pricing","type":"boolean"},"enable_donations_at_checkout":{"description":"If selected, users will be prompted to make a donation upon checking out","title":"Enable Donations At Checkout","type":"boolean"},"enable_electronic_checks":{"description":"If set, electronic checks are allowed","title":"Enable Electronic Checks","type":"boolean"},"enable_pay_later":{"description":"If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed","title":"Enable Pay Later","type":"boolean"},"enable_payroll_deduction":{"description":"If set, payroll deduction is allowed","title":"Enable Payroll Deduction","type":"boolean"},"enable_split_payments":{"description":"If set, users are allowed to split payments","title":"Enable Split Payments","type":"boolean"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"oneOf":[{"x-required":true}],"type":"array"},"invoice_payment_terms_id":{"description":"The payment terms for invoices; if left blank, default is used","title":"Invoice Payment Terms","type":"string"},"invoice_template_id":{"description":"The template to use for invoices created during this process","title":"Invoice Template","type":"string"},"merchant_account_id":{"description":"The merchant account that the store should use to receive payments","title":"Merchant Account","type":"string"},"pay_later_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Pay Later Options","type":"object"},"restocking_fee_product_id":{"description":"The ID of the product used for restocking fees","title":"Restocking Fee Product","type":"string"},"special_instructions":{"description":"Instructions shown to the user","title":"Special Instructions","type":"string"},"use_pro_forma_invoices":{"description":"Whether to use pro forma invoices when user elects to pay later","title":"Use Pro Forma Invoices","type":"boolean"}},"required":["bank_account_id","business_unit_id","merchant_account_id"],"title":"Checkout Settings","type":"object"},"contact_form_options":{"additionalProperties":false,"properties":{"contact_form_id":{"description":"The default contact form to present to the user to verify the contact info before proceeding","pattern":"^rolodex-contacts__.*","title":"Contact Form","type":"string"},"html":{"description":"Text to show on the top of the form","title":"Html","type":"string"}},"required":["contact_form_id"],"title":"Contact Form Options","type":"object"},"course_registration_options":{"additionalProperties":false,"properties":{"course_registration_process_id":{"description":"The process to use when registering for courses, which tells us the email to send","title":"Course Registration Process","type":"string"}},"required":["course_registration_process_id"],"title":"Course Registration Options","type":"object"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"description":{"description":"A description of the process","title":"Description","type":"string"},"display_in_portal":{"description":"Whether or not to hide in the portal","title":"Display In Portal","type":"boolean"},"display_in_portal_as":{"description":"How to display this process in the portal","title":"Display In Portal As","type":"string"},"display_order":{"description":"Optional order to display the process","format":"float","title":"Display Order","type":"number"},"eligibility_criteria":{"additionalProperties":false,"description":"The criteria to use","properties":{"advanced_rule_error_message":{"description":"The error message to show when the advanced rule fails","title":"Advanced Rule Error Message","type":"string"},"advanced_rules":{"title":"Advanced Rules","type":"object"},"age_restrictions":{"additionalProperties":false,"properties":{"maximum_age":{"description":"The maximum age of the contact","format":"float","title":"Maximum Age","type":"number"},"minimum_age":{"description":"The minimum age of the contact","format":"float","title":"Minimum Age","type":"number"}},"title":"Age Restrictions","type":"object"},"award_options":{"additionalProperties":false,"properties":{"award_ids":{"items":{"type":"string"},"title":"Awards","type":"array"},"award_type_ids":{"items":{"type":"string"},"title":"Award Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Award Options","type":"object"},"award_recipients":{"description":"If set, only people who have received awards","title":"Award Recipients","type":"boolean"},"by_location":{"description":"If true, then filter by location","title":"By Location","type":"boolean"},"certificants":{"description":"If set, only people with specific certifications","title":"Certificants","type":"boolean"},"certification_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"program_ids":{"items":{"type":"string"},"title":"Programs","type":"array"}},"title":"Certification Options","type":"object"},"committee_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"committee_ids":{"items":{"type":"string"},"title":"Committees","type":"array"},"committee_position_ids":{"items":{"type":"string"},"title":"Committee Positions","type":"array"},"committee_type_ids":{"items":{"type":"string"},"title":"Committee Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Committee Member Options","type":"object"},"committee_members":{"description":"If set, active members who belong to a committee can purchase","title":"Committee Members","type":"boolean"},"custom_logic_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Logic Options","type":"object"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"donor_options":{"additionalProperties":false,"properties":{"donor_club_ids":{"items":{"type":"string"},"title":"Donor Clubs","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Donor Options","type":"object"},"donors":{"description":"If true, only donors","title":"Donors","type":"boolean"},"enable_advanced_rules":{"description":"Enable advanced JSON rules","title":"Enable Advanced Rules","type":"boolean"},"enable_age_restrictions":{"description":"Age registrations","title":"Enable Age Restrictions","type":"boolean"},"enable_custom_logic":{"description":"If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion","title":"Enable Custom Logic","type":"boolean"},"enable_entitlement_restrictions":{"description":"If set, then you must have certain entitlements","title":"Enable Entitlement Restrictions","type":"boolean"},"enable_expression":{"description":"Whether or not to enable an expression for evaluation","title":"Enable Expression","type":"boolean"},"enable_organization_restrictions":{"description":"If set, you can restrict organizations","title":"Enable Organization Restrictions","type":"boolean"},"enable_status_restriction":{"description":"If set, you can restrict by status","title":"Enable Status Restriction","type":"boolean"},"entitlement_restrictions":{"items":{"additionalProperties":false,"properties":{"quantity":{"description":"The quantity you must have","format":"float","title":"Quantity","type":"number"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["type_id"],"type":"object"},"type":"array"},"event_registration_options":{"additionalProperties":false,"properties":{"event_ids":{"items":{"type":"string"},"title":"Events","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"registration_category_ids":{"items":{"type":"string"},"title":"Registration Categories","type":"array"}},"title":"Event Registration Options","type":"object"},"event_registrations":{"description":"If set, only people who have registered for events","title":"Event Registrations","type":"boolean"},"expression":{"description":"The expression","title":"Expression","type":"string"},"expression_error_message":{"description":"The error message to show when the expression fails","title":"Expression Error Message","type":"string"},"location":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"countries":{"description":"Countries","items":{"type":"string"},"title":"Countries","type":"array"},"negate_logic":{"description":"If true, the logic in this section is negated; so NOT from these places","title":"Negate Logic","type":"boolean"}},"title":"Location","type":"object"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_ids":{"items":{"type":"string"},"title":"Chapters","type":"array"},"chapter_type_ids":{"items":{"type":"string"},"title":"Chapter Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Chapter Member Options","type":"object"},"chapter_members":{"description":"If set, active members who belong to a chapter can purchase","title":"Chapter Members","type":"boolean"},"member_package_ids":{"description":"The member package","items":{"type":"string"},"title":"Member Packages","type":"array"},"member_status_reason_ids":{"items":{"type":"string"},"title":"Member Status Reasons","type":"array"},"member_statuses":{"items":{"enum":["active","inactive","suspended"],"type":"string"},"title":"Member Statuses","type":"array"},"member_type_ids":{"description":"The member types","items":{"type":"string"},"title":"Member Types","type":"array"},"section_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"section_ids":{"items":{"type":"string"},"title":"Sections","type":"array"},"section_type_ids":{"items":{"type":"string"},"title":"Section Types","type":"array"}},"title":"Section Member Options","type":"object"},"section_members":{"description":"If set, active members who belong to a section can purchase","title":"Section Members","type":"boolean"}},"title":"Member Options","type":"object"},"members":{"description":"If set, active members can purchase this","title":"Members","type":"boolean"},"non_members":{"description":"If set, only nonmembers can purchase","title":"Non Members","type":"boolean"},"organization_restrictions":{"additionalProperties":false,"properties":{"contact_role_ids":{"items":{"type":"string"},"title":"Contact Roles","type":"array"},"organization_type_ids":{"items":{"type":"string"},"title":"Organization Types","type":"array"}},"title":"Organization Restrictions","type":"object"},"status_restrictions":{"description":"The statuses","items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Restrictions","type":"array"},"use_organization_for_eligibility":{"description":"If checked, a person's organization is used to check for eligibility, rather than the person themselves","title":"Use Organization For Eligibility","type":"boolean"}},"title":"Eligibility Criteria","type":"object"},"enable_application_confirmation_email":{"description":"Whether or not an email should be sent when the application is received","title":"Enable Application Confirmation Email","type":"boolean"},"enable_certification_activation_email":{"description":"Whether or not to send an email when the certification is actually activated","title":"Enable Certification Activation Email","type":"boolean"},"enable_course_registration":{"description":"If true, users can register for courses while applying for the certification","title":"Enable Course Registration","type":"boolean"},"enable_eligibility_criteria":{"description":"If true, only certain eligible persons can proceed with this process","title":"Enable Eligibility Criteria","type":"boolean"},"enable_exam_registration":{"description":"If true, users can register for exams while applying for the certification","title":"Enable Exam Registration","type":"boolean"},"enable_grandfather_restrictions":{"description":"Only people who are grandfathered into other certification programs may complete this process","title":"Enable Grandfather Restrictions","type":"boolean"},"exam_registration_options":{"additionalProperties":false,"properties":{"exam_registration_process_id":{"description":"The process to use when registering for exams, which tells us the email to send","title":"Exam Registration Process","type":"string"}},"required":["exam_registration_process_id"],"title":"Exam Registration Options","type":"object"},"expiration_rule_set_id":{"description":"The rule set for calculating the expiration of a certification generated by this process","title":"Expiration Rule Set","type":"string"},"fee_id":{"description":"The baseline fee","title":"Fee","type":"string"},"grandfather_restrictions":{"additionalProperties":false,"properties":{"certification_program_ids":{"description":"The programs that a person must have an active, grandfather certification in order to complete this process","items":{"type":"string"},"minItems":1,"title":"Certification Programs","type":"array"},"invert_logic":{"description":"If true, then this process will be available if a person does NOT have one of the grandfathered certs","title":"Invert Logic","type":"boolean"}},"required":["certification_program_ids"],"title":"Grandfather Restrictions","type":"object"},"id":{"description":"The unique, string identifier of this process","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this process is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the process","title":"Name","type":"string"},"organization_form_options":{"additionalProperties":false,"properties":{"html":{"description":"Text to show on the top of the form","title":"Html","type":"string"},"organization_form_id":{"description":"The default organization form to present to the user to verify the organization info before proceeding","pattern":"^rolodex-organizations__.*","title":"Organization Form","type":"string"}},"required":["organization_form_id"],"title":"Organization Form Options","type":"object"},"organization_type_ids":{"items":{"type":"string"},"minItems":1,"title":"Organization Types","type":"array"},"override_checkout_settings":{"description":"Whether or not to override POC settings","title":"Override Checkout Settings","type":"boolean"},"prefill_application_with_profile_information":{"description":"If true, data stored in the certification profile is used as the starting point for the application","title":"Prefill Application With Profile Information","type":"boolean"},"program_id":{"description":"The program to which this process is tied","title":"Program","type":"string"},"reinstatement_options":{"additionalProperties":false,"properties":{"reinstatement_period":{"description":"Number of days after termination after which a person can be reinstated - leave blank for an indefinite time period","format":"float","title":"Reinstatement Period","type":"number"}},"title":"Reinstatement Options","type":"object"},"renewal_options":{"additionalProperties":false,"properties":{"renewal_window":{"description":"The number of days prior to expiration this person is allowed to renew","format":"float","title":"Renewal Window","type":"number"}},"required":["renewal_window"],"title":"Renewal Options","type":"object"},"requirements":{"items":{"additionalProperties":false,"properties":{"course_requirements":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"attendance_required":{"description":"If true, then only course registrations with a status of attended will be considered to have met this requirement","title":"Attendance Required","type":"boolean"},"course_ids":{"description":"The required courses; a user fulfills this requirement by taking any of these courses","items":{"type":"string"},"minItems":1,"title":"Courses","type":"array"},"hide_during_application_process":{"description":"If, set, then during the application process this course is not displayed for selection","title":"Hide During Application Process","type":"boolean"},"time_frame":{"additionalProperties":false,"description":"The timeframe in which the course needs to have been taken","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Time Frame","type":"object"}},"required":["course_ids"],"title":"Course Requirements","type":"object"},"credit_requirements":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"credit_type_id":{"description":"The type of credits required","title":"Credit Type","type":"string"},"do_not_allow_reuse":{"description":"If true, a credit used by this requirement cannot be reused elsewhere","title":"Do Not Allow Reuse","type":"boolean"},"formula":{"description":"A formula to determine the number of credits","oneOf":[{"x-required":true}],"title":"Formula","type":"string"},"number_of_credits":{"description":"The number of credits required","format":"float","oneOf":[{"x-required":true}],"title":"Number Of Credits","type":"number"},"restrict_certain_activity_types":{"description":"If true, credits gained by certain activities are NOT allowed to be counted to fulfilling requirements","title":"Restrict Certain Activity Types","type":"boolean"},"restricted_activity_type_ids":{"description":"Credits gained from these activities will not be counted towards requirements","items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Restricted Activity Types","type":"array"},"type":{"description":"Whether or not the number of credits is fixed or calculated","enum":["calculated","fixed"],"title":"Type","type":"string"}},"required":["credit_type_id"],"title":"Credit Requirements","type":"object"},"enable_partial_applicability":{"description":"If true, this requirement is only applied to a subset of applicants","title":"Enable Partial Applicability","type":"boolean"},"exam_requirements":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"exam_ids":{"description":"The required exams; a user fulfills this requirement by taking any of these exams","items":{"type":"string"},"minItems":1,"title":"Exams","type":"array"},"hide_during_application_process":{"description":"If, set, then during the application process this course is not displayed for selection","title":"Hide During Application Process","type":"boolean"},"time_frame":{"additionalProperties":false,"description":"The timeframe in which the exam needs to have been taken","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Time Frame","type":"object"}},"required":["exam_ids"],"title":"Exam Requirements","type":"object"},"expression_requirements":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"expression":{"description":"An optional expression to be used to determine whether or not the requirement is met ","title":"Expression","type":"string"}},"required":["expression"],"title":"Expression Requirements","type":"object"},"field_requirements":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"mapped_field":{"description":"The field to be used in determining whether this requirement has been met","title":"Mapped Field","type":"string"}},"required":["mapped_field"],"title":"Field Requirements","type":"object"},"id":{"description":"The unique, string identifier of the requirement","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"name":{"description":"The name of the requirement","title":"Name","type":"string"},"partial_applicability_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"percentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The % of applicants that should have this rule applied to them"},"children":[]}]}]}],"format":"float","maximum":100,"minimum":1,"title":"Percentage","type":"number"}},"required":["percentage"],"title":"Partial Applicability Options","type":"object"},"portal_explanation":{"description":"An optional explanation to display in the portal","title":"Portal Explanation","type":"string"},"reference_requirements":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"number_of_references":{"description":"The number of references","format":"float","maximum":10,"minimum":1,"title":"Number Of References","type":"number"},"reference_process_id":{"description":"The reference process","title":"Reference Process","type":"string"},"reference_type_id":{"description":"The type of reference","title":"Reference Type","type":"string"}},"required":["number_of_references","reference_process_id","reference_type_id"],"title":"Reference Requirements","type":"object"},"type":{"enum":["course","credit","exam","expression","field","manual","reference"],"title":"Type","type":"string"},"weight":{"description":"For the purposes of displaying completeness, the weight which you assign this requirement","format":"float","title":"Weight","type":"number"}},"required":["id","name"],"type":"object"},"type":"array"},"restrict_organization_types":{"description":"Restrict to certain types of organizations","title":"Restrict Organization Types","type":"boolean"},"show_contact_form":{"description":"Whether or not to show a contact form","title":"Show Contact Form","type":"boolean"},"show_organization_form":{"description":"Whether or not to show an organization form","title":"Show Organization Form","type":"boolean"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"transfer_options":{"additionalProperties":false,"properties":{"allowed_program_ids":{"description":"The programs that are allowed to be transferred into; blank for all","items":{"type":"string"},"minItems":1,"title":"Allowed Programs","type":"array"}},"title":"Transfer Options","type":"object"},"type":{"enum":["certification","reinstatement","renewal","transfer"],"title":"Type","type":"string"}},"required":["applicant_update_options","application_confirmation_email_options","application_form_id","certification_activation_email_options","checkout_settings","contact_form_options","course_registration_options","customer_type","eligibility_criteria","exam_registration_options","expiration_rule_set_id","grandfather_restrictions","id","name","organization_form_options","organization_type_ids","program_id","reinstatement_options","renewal_options","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ApplicationReference":{"id":"components/schemas/ApplicationReference","kind":"json-schema","title":"ApplicationReference","data":{"additionalProperties":false,"properties":{"application_id":{"description":"Id of the application on which this reference resides","pattern":"^[\\w:|-]+$","title":"Application","type":"string"},"city":{"description":"The member city","title":"City","type":"string"},"completion_date":{"description":"Date of reference completion","format":"date-time","title":"Completion Date","type":"string"},"contact_id":{"description":"The rolodex record for the reference","title":"Contact","type":"string"},"country":{"description":"The member country","title":"Country","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"email_address":{"description":"The member's email address","title":"Email Address","type":"string"},"first_name":{"description":"The member's first name","title":"First Name","type":"string"},"id":{"description":"The unique, string identifier of this reference","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"job_title":{"description":"The member job title","title":"Job Title","type":"string"},"last_name":{"description":"The member's last name","title":"Last Name","type":"string"},"name":{"description":"The member's name","title":"Name","type":"string"},"notes":{"description":"Notes about this references","title":"Notes","type":"string"},"organization_id":{"description":"The organization id of the contact, if applicable","title":"Organization","type":"string"},"process_id":{"description":"The id of the reference process","title":"Process","type":"string"},"program_id":{"description":"The id of the program","title":"Program","type":"string"},"state":{"description":"The state","title":"State","type":"string"},"status":{"enum":["completed","declined","pending"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type_id":{"description":"The type of reference","title":"Type","type":"string"}},"required":["application_id","completion_date","contact_id","id","name","process_id","program_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type_id"],"type":"object"}},"components/schemas/ApplicationSearchParameters":{"id":"components/schemas/ApplicationSearchParameters","kind":"json-schema","title":"ApplicationSearchParameters","data":{"additionalProperties":false,"properties":{"contact_id":{"items":{"type":"string"},"title":"Contact","type":"array"},"date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"last_requirements_calculation_date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Last Requirements Calculation Date","type":"array"},"name":{"title":"Name","type":"string"},"number_of_missing_requirements":{"items":{"format":"float","type":"number"},"title":"Number Of Missing Requirements","type":"array"},"organization_id":{"items":{"type":"string"},"title":"Organization","type":"array"},"owner_type":{"items":{"type":"string"},"title":"Owner Type","type":"array"},"percentage_complete":{"items":{"format":"float","type":"number"},"title":"Percentage Complete","type":"array"},"process_id":{"items":{"type":"string"},"title":"Process","type":"array"},"program_id":{"items":{"type":"string"},"title":"Program","type":"array"},"status":{"items":{"type":"string"},"title":"Status","type":"array"},"type":{"items":{"type":"string"},"title":"Type","type":"array"}},"type":"object"}},"components/schemas/ApplicationSearchResults":{"id":"components/schemas/ApplicationSearchResults","kind":"json-schema","title":"ApplicationSearchResults","data":{"additionalProperties":false,"properties":{"contact_id":{"title":"Contact","type":"string"},"date":{"title":"Date","type":"string"},"id":{"description":"The id","title":"ID","type":"string"},"last_requirements_calculation_date":{"title":"Last Requirements Calculation Date","type":"string"},"name":{"title":"Name","type":"string"},"number_of_missing_requirements":{"format":"float","title":"Number Of Missing Requirements","type":"number"},"organization_id":{"title":"Organization","type":"string"},"owner_type":{"title":"Owner Type","type":"string"},"percentage_complete":{"format":"float","title":"Percentage Complete","type":"number"},"process_id":{"title":"Process","type":"string"},"program_id":{"title":"Program","type":"string"},"status":{"title":"Status","type":"string"},"type":{"title":"Type","type":"string"}},"type":"object"}},"components/schemas/BatchOperationRequest":{"id":"components/schemas/BatchOperationRequest","kind":"json-schema","title":"BatchOperationRequest","data":{"additionalProperties":false,"properties":{"operations":{"items":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the record","oneOf":[{"x-required":true}],"title":"ID","type":"string"},"object":{"title":"Object","type":"object"},"operation":{"enum":["create","delete","patch","read","update"],"title":"Operation","type":"string"},"patch_directives":{"items":{"additionalProperties":false,"properties":{"op":{"description":"The operation","enum":["add","copy","move","remove","replace","test"],"title":"Op","type":"string"},"path":{"description":"The JSON path","title":"Path","type":"string"},"value":{"title":"Value","type":"string"}},"required":["op","path"],"type":"object"},"maxItems":100,"minItems":1,"oneOf":[{"x-required":true}],"type":"array"}},"required":["operation"],"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/BatchOperationResponse":{"id":"components/schemas/BatchOperationResponse","kind":"json-schema","title":"BatchOperationResponse","data":{"additionalProperties":false,"properties":{"error_count":{"description":"Number of error results","format":"float","title":"Error Count","type":"number"},"results":{"items":{"additionalProperties":false,"properties":{"error_message":{"title":"Error Message","type":"string"},"id":{"description":"The ID of the record","title":"ID","type":"string"},"object":{"title":"Object","type":"object"},"operation":{"enum":["create","delete","patch","read","update"],"title":"Operation","type":"string"},"outcome":{"enum":["error","no change","success"],"title":"Outcome","type":"string"}},"required":["id","operation"],"type":"object"},"type":"array"},"success_count":{"description":"Number of successful results","format":"float","title":"Success Count","type":"number"}},"type":"object"}},"components/schemas/BillingRun":{"id":"components/schemas/BillingRun","kind":"json-schema","title":"BillingRun","data":{"additionalProperties":false,"properties":{"activate_applications":{"description":"If set, this billing run should activate all applications that have met all requirements","title":"Activate Applications","type":"boolean"},"application_activation_options":{"additionalProperties":false,"properties":{"application_notice_id":{"description":"The notice to send when a renewal order is created","title":"Application Notice","type":"string"},"application_types":{"items":{"enum":["certification","reinstatement","renewal"],"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Application Types","type":"array"},"program_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"restrict_application_types":{"description":"If true, only certain types of applications are included","title":"Restrict Application Types","type":"boolean"},"restrict_status_reasons":{"description":"If true, only applications with certain status reasons will be included","title":"Restrict Status Reasons","type":"boolean"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"},"training_provider_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Training Providers","type":"array"},"training_provider_restriction":{"description":"Determines if/how to restrict the training providers in this run","enum":["exclude","include","none"],"title":"Training Provider Restriction","type":"string"}},"title":"Application Activation Options","type":"object"},"application_expiration_options":{"additionalProperties":false,"properties":{"application_notice_id":{"description":"The notice to send when a renewal order is created","title":"Application Notice","type":"string"},"application_types":{"items":{"enum":["certification","reinstatement","renewal"],"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Application Types","type":"array"},"expiration_date_range_end":{"description":"The date to use to filter out which memberships are candidate","format":"date","title":"Expiration Date Range End","type":"string"},"expiration_date_range_start":{"description":"The date to use to filter out which memberships are candidate","format":"date","title":"Expiration Date Range Start","type":"string"},"program_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"restrict_application_types":{"description":"If true, only certain types of applications are included","title":"Restrict Application Types","type":"boolean"},"restrict_status_reasons":{"description":"If true, only applications with certain status reasons will be included","title":"Restrict Status Reasons","type":"boolean"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"},"training_provider_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Training Providers","type":"array"},"training_provider_restriction":{"description":"Determines if/how to restrict the training providers in this run","enum":["exclude","include","none"],"title":"Training Provider Restriction","type":"string"}},"required":["expiration_date_range_end","expiration_date_range_start"],"title":"Application Expiration Options","type":"object"},"application_reminder_options":{"additionalProperties":false,"properties":{"application_types":{"items":{"enum":["certification","reinstatement","renewal"],"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Application Types","type":"array"},"program_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"reminders":{"items":{"additionalProperties":false,"properties":{"expiration_date_range_end":{"description":"The date to use to filter out which memberships are candidate","format":"date","title":"Expiration Date Range End","type":"string"},"expiration_date_range_start":{"description":"The date to use to filter out which memberships are candidate","format":"date","title":"Expiration Date Range Start","type":"string"},"id":{"description":"A unique, unchangeable reminder id","format":"float","title":"ID","type":"number"},"name":{"description":"Optional name","title":"Name","type":"string"},"reminder_notice_id":{"description":"The reminder notice","title":"Reminder Notice","type":"string"}},"required":["expiration_date_range_end","expiration_date_range_start","reminder_notice_id"],"type":"object"},"minItems":1,"type":"array"},"restrict_application_types":{"description":"If true, only certain types of applications are included","title":"Restrict Application Types","type":"boolean"},"restrict_status_reasons":{"description":"If true, only applications with certain status reasons will be included","title":"Restrict Status Reasons","type":"boolean"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"},"training_provider_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Training Providers","type":"array"},"training_provider_restriction":{"description":"Determines if/how to restrict the training providers in this run","enum":["exclude","include","none"],"title":"Training Provider Restriction","type":"string"}},"required":["reminders"],"title":"Application Reminder Options","type":"object"},"bill_training_providers":{"description":"When true, training providers should be sent invoices for training registrations","title":"Bill Training Providers","type":"boolean"},"drop_options":{"additionalProperties":false,"properties":{"drop_notice_id":{"description":"The notice to send when a renewal order is created","title":"Drop Notice","type":"string"},"expiration_date_range_end":{"description":"The date to use to filter out which memberships are candidate","format":"date","title":"Expiration Date Range End","type":"string"},"expiration_date_range_start":{"description":"The date to use to filter out which memberships are candidate","format":"date","title":"Expiration Date Range Start","type":"string"},"program_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"restrict_status_reasons":{"description":"If true, only applications with certain status reasons will be included","title":"Restrict Status Reasons","type":"boolean"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"},"training_provider_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Training Providers","type":"array"},"training_provider_restriction":{"description":"Determines if/how to restrict the training providers in this run","enum":["exclude","include","none"],"title":"Training Provider Restriction","type":"string"}},"required":["expiration_date_range_end","expiration_date_range_start"],"title":"Drop Options","type":"object"},"error":{"description":"The error message","title":"Error","type":"string"},"error_stack":{"description":"The error stack","title":"Error Stack","type":"string"},"expire_applications":{"description":"If set, applications that are past their expiration date are expired","title":"Expire Applications","type":"boolean"},"forecast_renewals":{"description":"Whether this billing run should be issuing renewal forecasts","title":"Forecast Renewals","type":"boolean"},"id":{"description":"The unique, string identifier of this billing run","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"last_refresh_date":{"description":"The last time the billing run was refreshed","format":"date-time","title":"Last Refresh Date","type":"string"},"name":{"description":"The name of the billing run","title":"Name","type":"string"},"notification_email":{"description":"Te address to send notifications","title":"Notification Email","type":"string"},"perform_drops":{"description":"Whether this template should be dropping expired members","title":"Perform Drops","type":"boolean"},"preprocessing_date":{"description":"The date this billing run was actually processed","format":"date-time","title":"Preprocessing Date","type":"string"},"recurring_billing_run_id":{"description":"The recurring billing run","title":"Recurring Billing Run","type":"string"},"renewal_forecasting_options":{"additionalProperties":false,"properties":{"expiration_date_range_end":{"description":"The date to use to filter out which memberships are candidate","format":"date","title":"Expiration Date Range End","type":"string"},"expiration_date_range_start":{"description":"The date to use to filter out which memberships are candidate","format":"date","title":"Expiration Date Range Start","type":"string"},"program_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"restrict_status_reasons":{"description":"If true, only applications with certain status reasons will be included","title":"Restrict Status Reasons","type":"boolean"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"},"training_provider_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Training Providers","type":"array"},"training_provider_restriction":{"description":"Determines if/how to restrict the training providers in this run","enum":["exclude","include","none"],"title":"Training Provider Restriction","type":"string"}},"required":["expiration_date_range_end","expiration_date_range_start"],"title":"Renewal Forecasting Options","type":"object"},"renewal_reminder_options":{"additionalProperties":false,"properties":{"application_types":{"items":{"enum":["certification","reinstatement","renewal"],"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Application Types","type":"array"},"program_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"reminders":{"items":{"additionalProperties":false,"properties":{"expiration_date_range_end":{"description":"The date to use to filter out which memberships are candidate","format":"date","title":"Expiration Date Range End","type":"string"},"expiration_date_range_start":{"description":"The date to use to filter out which memberships are candidate","format":"date","title":"Expiration Date Range Start","type":"string"},"id":{"description":"A unique, unchangeable reminder id","format":"float","title":"ID","type":"number"},"name":{"description":"Optional name","title":"Name","type":"string"},"reminder_notice_id":{"description":"The reminder notice","title":"Reminder Notice","type":"string"}},"required":["expiration_date_range_end","expiration_date_range_start","reminder_notice_id"],"type":"object"},"minItems":1,"type":"array"},"restrict_application_types":{"description":"If true, only certain types of applications are included","title":"Restrict Application Types","type":"boolean"},"restrict_status_reasons":{"description":"If true, only applications with certain status reasons will be included","title":"Restrict Status Reasons","type":"boolean"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"},"training_provider_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Training Providers","type":"array"},"training_provider_restriction":{"description":"Determines if/how to restrict the training providers in this run","enum":["exclude","include","none"],"title":"Training Provider Restriction","type":"string"}},"required":["reminders"],"title":"Renewal Reminder Options","type":"object"},"run_date":{"description":"The date of the billing run","format":"date-time","title":"Run Date","type":"string"},"scheduled_preprocessing_date":{"description":"The date which this billing run should be preprocessed","format":"date-time","title":"Scheduled Preprocessing Date","type":"string"},"scheduled_run_date":{"description":"The date the billing run is scheduled for execution","format":"date-time","title":"Scheduled Run Date","type":"string"},"send_application_reminders":{"description":"If set, this billing run should send out application reminders to applications missing requirements and approaching expiration","title":"Send Application Reminders","type":"boolean"},"send_renewal_reminders":{"description":"If set, this billing run should send out renewal reminders to those approaching expiration","title":"Send Renewal Reminders","type":"boolean"},"statistics":{"items":{"additionalProperties":false,"properties":{"action":{"title":"Action","type":"string"},"error":{"format":"float","title":"Error","type":"number"},"excluded":{"format":"float","title":"Excluded","type":"number"},"pending":{"format":"float","title":"Pending","type":"number"},"processing":{"format":"float","title":"Processing","type":"number"},"successful":{"format":"float","title":"Successful","type":"number"},"total":{"format":"float","title":"Total","type":"number"}},"required":["action"],"type":"object"},"type":"array"},"status":{"enum":["cancelled","completed","draft","error","preprocessing","ready for execution","running","scheduled","scheduled for execution","timed out"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"template_id":{"description":"The billing template that created this run","title":"Template","type":"string"},"training_provider_billing_options":{"additionalProperties":false,"properties":{"email_invoices_to_training_providers":{"description":"If true, all contact roles that are training provider administrators will receive an email with the invoice","title":"Email Invoices To Training Providers","type":"boolean"},"expiration_date_range_end":{"description":"The date to use to filter out which memberships are candidate","format":"date","title":"Expiration Date Range End","type":"string"},"expiration_date_range_start":{"description":"The date to use to filter out which memberships are candidate","format":"date","title":"Expiration Date Range Start","type":"string"},"invoice_template_id":{"description":"The invoice template to use to send out the training provider invoice","title":"Invoice Template","type":"string"},"payment_terms_id":{"description":"The payment terms to use to send out the training provider invoice","title":"Payment Terms","type":"string"},"program_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"training_provider_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Training Providers","type":"array"},"training_provider_restriction":{"description":"Determines if/how to restrict the training providers in this run","enum":["exclude","include","none"],"title":"Training Provider Restriction","type":"string"}},"required":["expiration_date_range_end","expiration_date_range_start","invoice_template_id","payment_terms_id"],"title":"Training Provider Billing Options","type":"object"}},"required":["application_activation_options","application_expiration_options","application_reminder_options","drop_options","id","name","renewal_forecasting_options","renewal_reminder_options","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","training_provider_billing_options"],"type":"object"}},"components/schemas/BillingRunAction":{"id":"components/schemas/BillingRunAction","kind":"json-schema","title":"BillingRunAction","data":{"additionalProperties":false,"properties":{"application_id":{"description":"The application linked to this action","title":"Application","type":"string"},"application_notice_id":{"description":"The application notice - if applicable","title":"Application Notice","type":"string"},"billing_run_id":{"description":"The billing run ID","title":"Billing Run","type":"string"},"candidate_id":{"description":"The candidate to which this action is linked","title":"Candidate","type":"string"},"candidate_service":{"description":"The service of the candidate","title":"Candidate Service","type":"string"},"certification_id":{"description":"The certification linked to this action","title":"Certification","type":"string"},"certification_notice_id":{"description":"The certification notice - if applicable","title":"Certification Notice","type":"string"},"date":{"description":"The action date","format":"date-time","title":"Date","type":"string"},"email_training_provider_invoice":{"description":"Whether to email training providers","title":"Email Training Provider Invoice","type":"boolean"},"error_message":{"description":"The error message","title":"Error Message","type":"string"},"error_stack":{"description":"A detailed error message with stack trace","title":"Error Stack","type":"string"},"expiration_date":{"description":"The expiration date","title":"Expiration Date","type":"string"},"id":{"description":"The unique, string identifier of this billing run action","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"invoice_id":{"description":"The invoice that was created","title":"Invoice","type":"string"},"invoice_template_id":{"description":"The invoice template to use to bill the training provider","title":"Invoice Template","type":"string"},"last_refresh_date":{"description":"The date this action was last refreshed","format":"date-time","title":"Last Refresh Date","type":"string"},"name":{"description":"Name of the membership","title":"Name","type":"string"},"outcome_of_last_refresh":{"description":"Describes what happened to this action the last time this billing run was refreshed","enum":["added","no change","removed"],"title":"Outcome Of Last Refresh","type":"string"},"program_id":{"description":"The program","title":"Program","type":"string"},"status":{"description":"The status of this action","enum":["completed","error","excluded","expiration date changed","no longer eligible","payment failure","pending","processing","processing order"],"title":"Status","type":"string"},"step_function_execution_arn":{"description":"The step function arn","title":"Step Function Execution Arn","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"training_provider_billing_records":{"items":{"additionalProperties":false,"properties":{"id":{"description":"The id of the record being billed","title":"ID","type":"string"},"service":{"description":"The service of the record","title":"Service","type":"string"}},"required":["id","service"],"type":"object"},"minItems":1,"type":"array"},"training_provider_id":{"description":"The application linked to this action","title":"Training Provider","type":"string"},"type":{"enum":["activate application","bill training provider","drop certification","expire application","forecast renewal","send application reminder","send renewal reminder"],"title":"Type","type":"string"}},"required":["application_id","billing_run_id","candidate_id","candidate_service","certification_id","certification_notice_id","date","id","invoice_template_id","name","program_id","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","training_provider_billing_records","training_provider_id","type"],"type":"object"}},"components/schemas/BillingRunSearchParameters":{"id":"components/schemas/BillingRunSearchParameters","kind":"json-schema","title":"BillingRunSearchParameters","data":{"additionalProperties":false,"properties":{"activate_applications":{"items":{"type":"boolean"},"title":"Activate Applications","type":"array"},"application_expiration_options":{"items":{"type":"boolean"},"title":"Application Expiration Options","type":"array"},"bill_training_providers":{"items":{"type":"boolean"},"title":"Bill Training Providers","type":"array"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"name":{"title":"Name","type":"string"},"perform_drops":{"items":{"type":"boolean"},"title":"Perform Drops","type":"array"},"run_date":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Run Date","type":"array"},"scheduled_run_date":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Scheduled Run Date","type":"array"},"send_application_reminders":{"items":{"type":"boolean"},"title":"Send Application Reminders","type":"array"},"send_renewal_reminders":{"items":{"type":"boolean"},"title":"Send Renewal Reminders","type":"array"},"status":{"items":{"type":"string"},"title":"Status","type":"array"}},"type":"object"}},"components/schemas/BillingRunSearchResults":{"id":"components/schemas/BillingRunSearchResults","kind":"json-schema","title":"BillingRunSearchResults","data":{"additionalProperties":false,"properties":{"generate_renewal_notices":{"title":"Generate Renewal Notices","type":"boolean"},"generate_renewal_orders":{"title":"Generate Renewal Orders","type":"boolean"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"name":{"title":"Name","type":"string"},"perform_auto_renewals":{"title":"Perform Auto Renewals","type":"boolean"},"perform_drops":{"title":"Perform Drops","type":"boolean"},"run_date":{"title":"Run Date","type":"string"},"scheduled_run_date":{"title":"Scheduled Run Date","type":"string"},"send_auto_renewal_reminders":{"title":"Send Auto Renewal Reminders","type":"boolean"},"send_expiring_credit_card_reminders":{"title":"Send Expiring Credit Card Reminders","type":"boolean"},"send_renewal_reminders":{"title":"Send Renewal Reminders","type":"boolean"},"status":{"title":"Status","type":"string"}},"type":"object"}},"components/schemas/BillingTemplate":{"id":"components/schemas/BillingTemplate","kind":"json-schema","title":"BillingTemplate","data":{"additionalProperties":false,"properties":{"activate_applications":{"description":"If set, this billing run should activate all applications that have met all requirements","title":"Activate Applications","type":"boolean"},"application_activation_options":{"additionalProperties":false,"properties":{"application_notice_id":{"description":"The notice to send when a renewal order is created","title":"Application Notice","type":"string"},"application_types":{"items":{"enum":["certification","reinstatement","renewal"],"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Application Types","type":"array"},"program_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"restrict_application_types":{"description":"If true, only certain types of applications are included","title":"Restrict Application Types","type":"boolean"},"restrict_status_reasons":{"description":"If true, only applications with certain status reasons will be included","title":"Restrict Status Reasons","type":"boolean"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"},"training_provider_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Training Providers","type":"array"},"training_provider_restriction":{"description":"Determines if/how to restrict the training providers in this run","enum":["exclude","include","none"],"title":"Training Provider Restriction","type":"string"}},"title":"Application Activation Options","type":"object"},"application_expiration_options":{"additionalProperties":false,"properties":{"application_notice_id":{"description":"The notice to send when a renewal order is created","title":"Application Notice","type":"string"},"application_types":{"items":{"enum":["certification","reinstatement","renewal"],"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Application Types","type":"array"},"expiration_date_range_end":{"additionalProperties":false,"description":"The date to use to filter out which memberships are candidate","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Expiration Date Range End","type":"object"},"expiration_date_range_start":{"additionalProperties":false,"description":"The date to use to filter out which memberships are candidate","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Expiration Date Range Start","type":"object"},"program_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"restrict_application_types":{"description":"If true, only certain types of applications are included","title":"Restrict Application Types","type":"boolean"},"restrict_status_reasons":{"description":"If true, only applications with certain status reasons will be included","title":"Restrict Status Reasons","type":"boolean"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"},"training_provider_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Training Providers","type":"array"},"training_provider_restriction":{"description":"Determines if/how to restrict the training providers in this run","enum":["exclude","include","none"],"title":"Training Provider Restriction","type":"string"}},"required":["expiration_date_range_end","expiration_date_range_start"],"title":"Application Expiration Options","type":"object"},"application_reminder_options":{"additionalProperties":false,"properties":{"application_types":{"items":{"enum":["certification","reinstatement","renewal"],"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Application Types","type":"array"},"program_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"reminders":{"items":{"additionalProperties":false,"properties":{"expiration_date_range_end":{"additionalProperties":false,"description":"The date to use to filter out which memberships are candidate","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Expiration Date Range End","type":"object"},"expiration_date_range_start":{"additionalProperties":false,"description":"The date to use to filter out which memberships are candidate","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Expiration Date Range Start","type":"object"},"id":{"description":"A unique, unchangeable reminder id","format":"float","title":"ID","type":"number"},"name":{"description":"Optional name","title":"Name","type":"string"},"reminder_notice_id":{"description":"The reminder notice","title":"Reminder Notice","type":"string"}},"required":["expiration_date_range_end","expiration_date_range_start","reminder_notice_id"],"type":"object"},"minItems":1,"type":"array"},"restrict_application_types":{"description":"If true, only certain types of applications are included","title":"Restrict Application Types","type":"boolean"},"restrict_status_reasons":{"description":"If true, only applications with certain status reasons will be included","title":"Restrict Status Reasons","type":"boolean"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"},"training_provider_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Training Providers","type":"array"},"training_provider_restriction":{"description":"Determines if/how to restrict the training providers in this run","enum":["exclude","include","none"],"title":"Training Provider Restriction","type":"string"}},"required":["reminders"],"title":"Application Reminder Options","type":"object"},"bill_training_providers":{"description":"When true, training providers should be sent invoices for training registrations","title":"Bill Training Providers","type":"boolean"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"A description of the template","title":"Description","type":"string"},"drop_options":{"additionalProperties":false,"properties":{"drop_notice_id":{"description":"The notice to send when a renewal order is created","title":"Drop Notice","type":"string"},"expiration_date_range_end":{"additionalProperties":false,"description":"The date to use to filter out which memberships are candidate","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Expiration Date Range End","type":"object"},"expiration_date_range_start":{"additionalProperties":false,"description":"The date to use to filter out which memberships are candidate","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Expiration Date Range Start","type":"object"},"program_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"restrict_status_reasons":{"description":"If true, only applications with certain status reasons will be included","title":"Restrict Status Reasons","type":"boolean"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"},"training_provider_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Training Providers","type":"array"},"training_provider_restriction":{"description":"Determines if/how to restrict the training providers in this run","enum":["exclude","include","none"],"title":"Training Provider Restriction","type":"string"}},"required":["expiration_date_range_end","expiration_date_range_start"],"title":"Drop Options","type":"object"},"expire_applications":{"description":"If set, applications that are past their expiration date are expired","title":"Expire Applications","type":"boolean"},"forecast_renewals":{"description":"Whether this template should be issuing renewal forecasts","title":"Forecast Renewals","type":"boolean"},"id":{"description":"The unique, string identifier of this billing template","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this billing template is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the billing template","title":"Name","type":"string"},"notification_email":{"description":"Te address to send notifications","title":"Notification Email","type":"string"},"perform_drops":{"description":"Whether this template should be dropping expired members","title":"Perform Drops","type":"boolean"},"renewal_forecasting_options":{"additionalProperties":false,"properties":{"expiration_date_range_end":{"additionalProperties":false,"description":"The date to use to filter out which memberships are candidate","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Expiration Date Range End","type":"object"},"expiration_date_range_start":{"additionalProperties":false,"description":"The date to use to filter out which memberships are candidate","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Expiration Date Range Start","type":"object"},"program_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"restrict_status_reasons":{"description":"If true, only applications with certain status reasons will be included","title":"Restrict Status Reasons","type":"boolean"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"},"training_provider_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Training Providers","type":"array"},"training_provider_restriction":{"description":"Determines if/how to restrict the training providers in this run","enum":["exclude","include","none"],"title":"Training Provider Restriction","type":"string"}},"required":["expiration_date_range_end","expiration_date_range_start"],"title":"Renewal Forecasting Options","type":"object"},"renewal_reminder_options":{"additionalProperties":false,"properties":{"application_types":{"items":{"enum":["certification","reinstatement","renewal"],"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Application Types","type":"array"},"program_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"reminders":{"items":{"additionalProperties":false,"properties":{"expiration_date_range_end":{"additionalProperties":false,"description":"The date to use to filter out which memberships are candidate","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Expiration Date Range End","type":"object"},"expiration_date_range_start":{"additionalProperties":false,"description":"The date to use to filter out which memberships are candidate","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Expiration Date Range Start","type":"object"},"id":{"description":"A unique, unchangeable reminder id","format":"float","title":"ID","type":"number"},"name":{"description":"Optional name","title":"Name","type":"string"},"reminder_notice_id":{"description":"The reminder notice","title":"Reminder Notice","type":"string"}},"required":["expiration_date_range_end","expiration_date_range_start","reminder_notice_id"],"type":"object"},"minItems":1,"type":"array"},"restrict_application_types":{"description":"If true, only certain types of applications are included","title":"Restrict Application Types","type":"boolean"},"restrict_status_reasons":{"description":"If true, only applications with certain status reasons will be included","title":"Restrict Status Reasons","type":"boolean"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"},"training_provider_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Training Providers","type":"array"},"training_provider_restriction":{"description":"Determines if/how to restrict the training providers in this run","enum":["exclude","include","none"],"title":"Training Provider Restriction","type":"string"}},"required":["reminders"],"title":"Renewal Reminder Options","type":"object"},"send_application_reminders":{"description":"If set, this billing run should send out application reminders to applications missing requirements and approaching expiration","title":"Send Application Reminders","type":"boolean"},"send_renewal_reminders":{"description":"If set, this billing run should send out renewal reminders to those approaching expiration","title":"Send Renewal Reminders","type":"boolean"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"training_provider_billing_options":{"additionalProperties":false,"properties":{"email_invoices_to_training_providers":{"description":"If true, all contact roles that are training provider administrators will receive an email with the invoice","title":"Email Invoices To Training Providers","type":"boolean"},"expiration_date_range_end":{"additionalProperties":false,"description":"The date to use to filter out which memberships are candidate","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Expiration Date Range End","type":"object"},"expiration_date_range_start":{"additionalProperties":false,"description":"The date to use to filter out which memberships are candidate","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Expiration Date Range Start","type":"object"},"invoice_template_id":{"description":"The invoice template to use to send out the training provider invoice","title":"Invoice Template","type":"string"},"payment_terms_id":{"description":"The payment terms to use to send out the training provider invoice","title":"Payment Terms","type":"string"},"program_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"training_provider_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Training Providers","type":"array"},"training_provider_restriction":{"description":"Determines if/how to restrict the training providers in this run","enum":["exclude","include","none"],"title":"Training Provider Restriction","type":"string"}},"required":["expiration_date_range_end","expiration_date_range_start","invoice_template_id","payment_terms_id"],"title":"Training Provider Billing Options","type":"object"}},"required":["application_activation_options","application_expiration_options","application_reminder_options","drop_options","id","name","renewal_forecasting_options","renewal_reminder_options","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","training_provider_billing_options"],"type":"object"}},"components/schemas/CanEditResponse":{"id":"components/schemas/CanEditResponse","kind":"json-schema","title":"CanEditResponse","data":{"additionalProperties":false,"properties":{"activity":{"additionalProperties":false,"properties":{"additional_details":{"description":"Additional details","title":"Additional Details","type":"string"},"contact_id":{"description":"The owner of the activity","title":"Contact","type":"string"},"credit_calculator_variables":{"title":"Credit Calculator Variables","type":"object"},"credits":{"items":{"additionalProperties":false,"properties":{"credit_type_id":{"description":"The type of credit","title":"Credit Type","type":"string"},"quantity":{"description":"The amount of credits","format":"double","minimum":0,"title":"Quantity","type":"number"}},"required":["credit_type_id","quantity"],"type":"object"},"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"Date of the activity","title":"Date","type":"string"},"file_upload_uri":{"description":"File upload for supporting documentation of the activity","title":"File Upload Uri","type":"string"},"id":{"description":"The unique, string identifier of this activity","oneOf":[{"x-required":true}],"pattern":"^[\\w|-]+$","title":"ID","type":"string"},"name":{"description":"Name of the activity","title":"Name","type":"string"},"process_id":{"description":"The reporting process","title":"Process","type":"string"},"processed_date":{"description":"The date the activity was processed","format":"date-time","title":"Processed Date","type":"string"},"quantity":{"description":"If applicable, quantity associated with the activity","format":"float","title":"Quantity","type":"number"},"status":{"enum":["draft","processed","under review","verified"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","oneOf":[{"x-required":true}],"title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","oneOf":[{"x-required":true}],"title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","oneOf":[{"x-required":true}],"title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","oneOf":[{"x-required":true}],"title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total_number_of_credits":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total # of credits"},"children":[]}]}]}],"format":"double","title":"Total Number Of Credits","type":"number"},"type_id":{"description":"The type of activity","title":"Type","type":"string"}},"required":["contact_id","date","name","type_id"],"title":"Activity","type":"object"},"form_id":{"title":"Form","type":"string"},"type":{"title":"Type","type":"object"}},"type":"object"}},"components/schemas/Certification":{"id":"components/schemas/Certification","kind":"json-schema","title":"Certification","data":{"additionalProperties":false,"properties":{"certificate_uri":{"description":"A link to an externally created certificate of membership","title":"Certificate Uri","type":"string"},"certification_date":{"description":"The date of the certification","title":"Certification Date","type":"string"},"city":{"description":"The member city","title":"City","type":"string"},"contact_id":{"description":"The contact that owns the certification","title":"Contact","type":"string"},"country":{"description":"The member country","title":"Country","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"customer_id":{"description":"For reporting only; the contact ID if this is owned by a contact, the organization if this is owned by an organization","title":"Customer","type":"string"},"do_not_drop":{"description":"If set, the certification is not dropped on a normal billing cycle","title":"Do Not Drop","type":"boolean"},"email_address":{"description":"The member's email address","title":"Email Address","type":"string"},"expiration_date":{"description":"The date the membership expires","title":"Expiration Date","type":"string"},"first_name":{"description":"The member's first name","title":"First Name","type":"string"},"forecasted_renewal_amount":{"description":"The amount this certification is forecasted to generate upon renewal","format":"float","title":"Forecasted Renewal Amount","type":"number"},"grandfathered":{"description":"If this is true,this is a grandfathered certification that should be renewed automatically with other certifications","title":"Grandfathered","type":"boolean"},"id":{"description":"The unique, string identifier of this certification","pattern":"^[\\w-|:]+$","title":"ID","type":"string"},"issuing_training_provider_id":{"description":"The provider that issued this certification","title":"Issuing Training Provider","type":"string"},"job_title":{"description":"The member job title","title":"Job Title","type":"string"},"lapse_date":{"description":"The last date that this record was terminated. Unlike termination date does not get erased","title":"Lapse Date","type":"string"},"last_application_id":{"description":"This is the last application that updated this certification","title":"Last Application","type":"string"},"last_name":{"description":"The member's last name","title":"Last Name","type":"string"},"last_reminder_date":{"description":"The last time a reminder was sent for this certification","title":"Last Reminder Date","type":"string"},"name":{"description":"The member's name","title":"Name","type":"string"},"name_to_be_printed_on_certificate":{"description":"The name to be displayed on the certificate","title":"Name To Be Printed On Certificate","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"notices":{"items":{"additionalProperties":false,"properties":{"date":{"description":"The date the notice was send","format":"date-time","title":"Date","type":"string"},"notice_id":{"description":"The notice","title":"Notice","type":"string"}},"required":["date","notice_id"],"type":"object"},"type":"array"},"number":{"description":"The cert number","format":"float","title":"Number","type":"number"},"organization_id":{"description":"The organization that owns the certifications","title":"Organization","type":"string"},"owner_type":{"enum":["contact","organization"],"title":"Owner Type","type":"string"},"program_id":{"description":"The certification program","title":"Program","type":"string"},"reinstatement_date":{"description":"The date the member was last reinstated","title":"Reinstatement Date","type":"string"},"renewal_date":{"description":"The date the member last renewed","title":"Renewal Date","type":"string"},"renewal_training_provider_id":{"description":"The renewal training provider","title":"Renewal Training Provider","type":"string"},"state":{"description":"The state","title":"State","type":"string"},"status":{"enum":["active","inactive","retired","suspended"],"title":"Status","type":"string"},"status_reason_id":{"description":"The configurable reason why the certification is in the specified status","title":"Status Reason","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"term_start_date":{"description":"The date the most recently purchased membership type starts","title":"Term Start Date","type":"string"},"termination_date":{"description":"The date the member was terminated","title":"Termination Date","type":"string"},"transferred_from_id":{"description":"If this certification was transferred from another, link it here","title":"Transferred From","type":"string"}},"required":["contact_id","id","name","number","program_id","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/CertificationSearchParameters":{"id":"components/schemas/CertificationSearchParameters","kind":"json-schema","title":"CertificationSearchParameters","data":{"additionalProperties":false,"properties":{"certification_date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Certification Date","type":"array"},"city":{"title":"City","type":"string"},"email_address":{"title":"Email Address","type":"string"},"expiration_date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Expiration Date","type":"array"},"id":{"description":"IDs to search","items":{"type":"string"},"title":"ID","type":"array"},"is_new":{"title":"Is New","type":"string"},"job_title":{"title":"Job Title","type":"string"},"name":{"title":"Name","type":"string"},"number":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Number","type":"array"},"origin":{"items":{"type":"string"},"title":"Origin","type":"array"},"owner_type":{"title":"Owner Type","type":"string"},"program_id":{"items":{"type":"string"},"title":"Program","type":"array"},"renewal_date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Renewal Date","type":"array"},"state":{"title":"State","type":"string"},"status":{"items":{"type":"string"},"title":"Status","type":"array"},"termination_date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Termination Date","type":"array"}},"type":"object"}},"components/schemas/CertificationSearchResults":{"id":"components/schemas/CertificationSearchResults","kind":"json-schema","title":"CertificationSearchResults","data":{"additionalProperties":false,"properties":{"certification_date":{"title":"Certification Date","type":"string"},"city":{"title":"City","type":"string"},"email_address":{"title":"Email Address","type":"string"},"expiration_date":{"title":"Expiration Date","type":"string"},"id":{"title":"ID","type":"string"},"job_title":{"title":"Job Title","type":"string"},"number":{"format":"float","title":"Number","type":"number"},"owner_type":{"title":"Owner Type","type":"string"},"program_id":{"title":"Program","type":"string"},"renewal_date":{"title":"Renewal Date","type":"string"},"state":{"title":"State","type":"string"},"status":{"title":"Status","type":"string"},"termination_date":{"title":"Termination Date","type":"string"}},"type":"object"}},"components/schemas/Coupon":{"id":"components/schemas/Coupon","kind":"json-schema","title":"Coupon","data":{"additionalProperties":false,"properties":{"application_fee_discount_info":{"additionalProperties":false,"properties":{"amount":{"format":"float","title":"Amount","type":"number"},"applies_to_new_applications":{"description":"Whether this coupon should apply to new applicants","title":"Applies To New Applications","type":"boolean"},"applies_to_reinstatement_applications":{"description":"Whether this coupon should apply to new applicants","title":"Applies To Reinstatement Applications","type":"boolean"},"applies_to_renewing_applications":{"description":"Whether this coupon should apply to new applicants","title":"Applies To Renewing Applications","type":"boolean"},"fee_ids":{"description":"The fees","items":{"type":"string"},"title":"Fees","type":"array"},"method":{"enum":["amount","percentage"],"title":"Method","type":"string"},"process_ids":{"description":"The process IDs to which this discount should apply","items":{"type":"string"},"title":"Processes","type":"array"},"program_ids":{"description":"The program IDs to which this discount should apply","items":{"type":"string"},"title":"Programs","type":"array"}},"required":["amount"],"title":"Application Fee Discount Info","type":"object"},"apply_to_application_fees":{"description":"If set, this will apply to certification application fees","title":"Apply To Application Fees","type":"boolean"},"apply_to_course_fees":{"description":"This applies to courses","title":"Apply To Course Fees","type":"boolean"},"apply_to_exam_fees":{"description":"This applies to exams","title":"Apply To Exam Fees","type":"boolean"},"code_generation_html":{"description":"HTML you can add into HTML generation for the code","title":"Code Generation Html","type":"string"},"course_fee_discount_info":{"additionalProperties":false,"properties":{"amount":{"format":"float","title":"Amount","type":"number"},"course_fee_ids":{"description":"The specific course offerings to which this discount should apply","items":{"type":"string"},"title":"Course Fees","type":"array"},"course_ids":{"description":"The specific courses to which this discount should apply","items":{"type":"string"},"title":"Courses","type":"array"},"course_type_ids":{"description":"The types of courses to which this discount should apply","items":{"type":"string"},"title":"Course Types","type":"array"},"method":{"enum":["amount","percentage"],"title":"Method","type":"string"},"program_ids":{"description":"The program IDs to which this discount should apply","items":{"type":"string"},"title":"Programs","type":"array"}},"required":["amount"],"title":"Course Fee Discount Info","type":"object"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"discount_method":{"enum":["discount line item","inline discount"],"title":"Discount Method","type":"string"},"discount_product_id":{"title":"Discount Product","type":"string"},"exam_fee_discount_info":{"additionalProperties":false,"properties":{"amount":{"format":"float","title":"Amount","type":"number"},"exam_fee_ids":{"description":"The specific course offerings to which this discount should apply","items":{"type":"string"},"title":"Exam Fees","type":"array"},"exam_ids":{"description":"The specific exams to which this discount should apply","items":{"type":"string"},"title":"Exams","type":"array"},"method":{"enum":["amount","percentage"],"title":"Method","type":"string"},"program_ids":{"description":"The program IDs to which this discount should apply","items":{"type":"string"},"title":"Programs","type":"array"}},"required":["amount"],"title":"Exam Fee Discount Info","type":"object"},"id":{"description":"The unique, string identifier of this coupon","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this coupon is active","title":"Is Active","type":"boolean"},"maximum_discount":{"description":"The optional maximum discount that this coupon can yield, irrespective of its configuration","format":"float","title":"Maximum Discount","type":"number"},"name":{"description":"The name of the coupon","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["application_fee_discount_info","course_fee_discount_info","discount_method","discount_product_id","exam_fee_discount_info","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Course":{"id":"components/schemas/Course","kind":"json-schema","title":"Course","data":{"additionalProperties":false,"properties":{"assign_credits":{"description":"If true, registrants of this course should receive credits","title":"Assign Credits","type":"boolean"},"credits_to_assign":{"items":{"additionalProperties":false,"properties":{"automatically_verify":{"description":"If true, the credits are verified upon assignment","title":"Automatically Verify","type":"boolean"},"credit_type_id":{"description":"The credit type","title":"Credit Type","type":"string"},"quantity":{"description":"The qty to assign","format":"float","title":"Quantity","type":"number"}},"required":["credit_type_id","quantity"],"type":"object"},"minItems":1,"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"A description of the course, which will appear in course catalogs","title":"Description","type":"string"},"exam_ids":{"description":"The exams associated with this course","items":{"type":"string"},"title":"Exams","type":"array"},"id":{"description":"The unique, string identifier of this course","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this course is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the course","title":"Name","type":"string"},"program_ids":{"description":"The programs for which this course is relevant","items":{"type":"string"},"title":"Programs","type":"array"},"publish_to_portal":{"description":"Whether to publish the course to the portal","title":"Publish To Portal","type":"boolean"},"short_description":{"description":"Any short descriptive information to display in the directory","title":"Short Description","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type_id":{"description":"The type of course","title":"Type","type":"string"},"universal_shopping_cart_image_uri":{"description":"The image to display for this course when it is in the online store","title":"Universal Shopping Cart Image Uri","type":"string"}},"required":["credits_to_assign","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type_id"],"type":"object"}},"components/schemas/CourseFee":{"id":"components/schemas/CourseFee","kind":"json-schema","title":"CourseFee","data":{"additionalProperties":false,"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bulk_pricing_rules":{"items":{"additionalProperties":false,"properties":{"discount_amount":{"description":"The percentage/flat rate","format":"float","minimum":0,"title":"Discount Amount","type":"number"},"discount_type":{"description":"The type of discount rule","enum":["flat rate","percentage"],"title":"Discount Type","type":"string"},"ending_range":{"description":"The ending range of the rule","minimum":0,"title":"Ending Range","type":"integer"},"starting_range":{"description":"The starting range of the rule","minimum":0,"title":"Starting Range","type":"integer"}},"required":["discount_amount","discount_type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products":{"items":{"additionalProperties":false,"properties":{"member_price":{"description":"The member price","format":"double","title":"Member Price","type":"number"},"price":{"description":"The price to bundle","format":"double","title":"Price","type":"number"},"product_id":{"description":"The product ID","title":"Product","type":"string"},"product_type":{"description":"The product type","title":"Product Type","type":"string"},"quantity":{"description":"The quantity to bundle","title":"Quantity","type":"integer"},"type":{"enum":["bundled product","inline bundled product"],"title":"Type","type":"string"}},"required":["product_id","product_type","quantity","type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products_inventory_handling":{"description":"Whether to track inventory for the entire bundle, or for each product separately","enum":["bundle","each product"],"title":"Bundled Products Inventory Handling","type":"string"},"business_unit_id":{"description":"The business unit of the product","title":"Business Unit","type":"string"},"cancellation_fee":{"description":"Cancellation fees associated with this product","format":"double","title":"Cancellation Fee","type":"number"},"commerce_entitlements_to_create":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"quantity":{"description":"The quantity","format":"float","title":"Quantity","type":"number"},"relative_expiration_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["expiration_type","type_id"],"type":"object"},"type":"array"},"coupon_codes":{"items":{"additionalProperties":false,"properties":{"coupon_code_generation_process_id":{"description":"The process by which the coupons are generated","title":"Coupon Code Generation Process","type":"string"},"coupon_code_type":{"enum":["multi use","single use"],"title":"Coupon Code Type","type":"string"},"coupon_id":{"title":"Coupon","type":"string"},"coupon_type":{"title":"Coupon Type","type":"string"},"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"maximum_number_of_total_uses":{"description":"The maximum number of total uses","minimum":1,"oneOf":[{"enum":[1],"x-required":true}],"title":"Maximum Number Of Total Uses","type":"integer"},"maximum_number_of_uses_per_customer":{"description":"The maximum number of total uses for a given customer","minimum":1,"oneOf":[{"enum":[1],"x-required":true}],"title":"Maximum Number Of Uses Per Customer","type":"integer"},"quantity":{"description":"The number of coupons to generate","maximum":250,"title":"Quantity","type":"integer"},"relative_expiration_date":{"additionalProperties":false,"description":"Expiration date relative to purchase","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"},"restrict_to_contact":{"description":"If true, the code generated is restricted to the contact who made the purchase","title":"Restrict To Contact","type":"boolean"},"restrict_to_organization":{"description":"If true, the code generated is restricted to the organization made the purchase","title":"Restrict To Organization","type":"boolean"}},"required":["coupon_code_generation_process_id","coupon_code_type","coupon_id","coupon_type","quantity"],"type":"object"},"minItems":1,"type":"array"},"course_id":{"description":"The course","title":"Course","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"custom_pricing_options":{"additionalProperties":false,"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Pricing Options","type":"object"},"document_entitlements_to_create":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"file_cabinet_id":{"description":"The file cabinet","title":"File Cabinet","type":"string"},"item_id":{"description":"The item","title":"Item","type":"string"},"library_path":{"description":"The optional path that items will be mounted onto the digital library","title":"Library Path","type":"string"},"relative_expiration_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"}},"required":["expiration_type","file_cabinet_id"],"type":"object"},"type":"array"},"enable_bulk_pricing":{"description":"Whether or not bulk pricing is enabled","title":"Enable Bulk Pricing","type":"boolean"},"enable_bundled_products":{"description":"Whether to enable bundled products","title":"Enable Bundled Products","type":"boolean"},"enable_cancellation_fees":{"description":"Whether or not cancellation fees are applicable","title":"Enable Cancellation Fees","type":"boolean"},"enable_commerce_entitlement_creation":{"description":"If set, document entitlements will be created to access folders or documents","title":"Enable Commerce Entitlement Creation","type":"boolean"},"enable_coupon_code_generation":{"description":"If true, purchasing this product will generate coupons","title":"Enable Coupon Code Generation","type":"boolean"},"enable_custom_pricing":{"description":"If set, the order engine will call out to a custom lambda function for custom/complex pricing","title":"Enable Custom Pricing","type":"boolean"},"enable_document_entitlement_creation":{"description":"If set, document entitlements will be created to access folders or documents","title":"Enable Document Entitlement Creation","type":"boolean"},"enable_product_confirmation_email":{"description":"If enabled, a custom email goes out whenever this product is ordered","title":"Enable Product Confirmation Email","type":"boolean"},"enable_purchase_limits":{"description":"If true, purchase limits are in place for this product","title":"Enable Purchase Limits","type":"boolean"},"enable_purchasing_eligibility":{"description":"If set, purchases of this merchandise are restricted","title":"Enable Purchasing Eligibility","type":"boolean"},"enable_special_prices":{"description":"Whether to enable special pricing logic","title":"Enable Special Prices","type":"boolean"},"enable_task_generation":{"description":"If set, tasks will be generated","title":"Enable Task Generation","type":"boolean"},"foreign_currency_prices":{"items":{"additionalProperties":false,"properties":{"cancellation_fee":{"description":"The cancellation fee of the product for this currency","format":"double","title":"Cancellation Fee","type":"number"},"currency_code":{"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"title":"Currency Code","type":"string"},"member_price":{"description":"The price of the product for a member","format":"double","title":"Member Price","type":"number"},"mode":{"description":"How this foreign currency should be treated","enum":["calculate price","prohibit purchase","set price"],"title":"Mode","type":"string"},"price":{"description":"The price of the product","format":"double","oneOf":[{"x-required":true}],"title":"Price","type":"number"},"restocking_fee":{"description":"The restocking fee of the product for this currency","format":"double","title":"Restocking Fee","type":"number"}},"required":["currency_code"],"type":"object"},"type":"array"},"hide_from_portal":{"description":"If set, this product should not be shown in the portal","title":"Hide From Portal","type":"boolean"},"id":{"description":"The unique, string identifier of this miscellaneous product","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"type":"array"},"is_active":{"description":"Whether this product is active/used","title":"Is Active","type":"boolean"},"member_price":{"description":"The price of the product for an active member","format":"double","title":"Member Price","type":"number"},"name":{"description":"The name of the miscellaneous product","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"portal_options":{"additionalProperties":false,"properties":{"available_from":{"description":"The date from which this product should be available","format":"date-time","title":"Available From","type":"string"},"available_until":{"description":"The date until which this product should be available","format":"date-time","title":"Available Until","type":"string"}},"title":"Portal Options","type":"object"},"price":{"description":"The price of the product","format":"double","title":"Price","type":"number"},"product_confirmation_email_options":{"additionalProperties":false,"properties":{"product_confirmation_email_id":{"oneOf":[{"x-required":true}],"title":"Product Confirmation Email","type":"string"},"product_specific_email":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Product Specific Email","type":"object"},"type":{"enum":["product specific","shared"],"title":"Type","type":"string"}},"title":"Product Confirmation Email Options","type":"object"},"publish_to_portal":{"description":"Whether or not this product should be available in the portal","title":"Publish To Portal","type":"boolean"},"purchase_limits":{"additionalProperties":false,"properties":{"error_message":{"description":"The error message to show","title":"Error Message","type":"string"},"maximum":{"description":"The maximum","format":"float","title":"Maximum","type":"number"},"relative_time_window":{"additionalProperties":false,"description":"the time window","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Time Window","type":"object"},"time_period":{"enum":["all time","sliding time window"],"title":"Time Period","type":"string"},"type":{"enum":["per customer"],"title":"Type","type":"string"}},"required":["maximum","time_period","type"],"title":"Purchase Limits","type":"object"},"purchasing_eligibility_criteria":{"title":"Purchasing Eligibility Criteria","type":"object"},"special_prices":{"items":{"additionalProperties":false,"properties":{"criteria":{"title":"Criteria","type":"object"},"enable_formula":{"description":"if set, a formula is used to calculate the price. If the formula fails, the price is used","title":"Enable Formula","type":"boolean"},"formula":{"description":"The formula evaluated using the expr-eval npm package","oneOf":[{"x-required":true}],"title":"Formula","type":"string"},"name":{"title":"Name","type":"string"},"price":{"format":"float","title":"Price","type":"number"}},"required":["criteria","price"],"type":"object"},"minItems":1,"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"tasks_to_generate":{"items":{"additionalProperties":false,"properties":{"assignee_type":{"enum":["assignment role","queue","user"],"title":"Assignee Type","type":"string"},"assignment_role_id":{"description":"The assignment role that should receive the ask","oneOf":[{"x-required":true}],"title":"Assignment Role","type":"string"},"description":{"description":"A description","title":"Description","type":"string"},"due_date_type":{"description":"Whether there is a due date","enum":["none","relative date","specific date"],"title":"Due Date Type","type":"string"},"name":{"description":"The name of the task","title":"Name","type":"string"},"notify_assignees":{"description":"Notify assignee when the task is created","title":"Notify Assignees","type":"boolean"},"priority":{"enum":["high","low","normal","urgent"],"title":"Priority","type":"string"},"queue_id":{"description":"The queue that should be assigned the ask","oneOf":[{"x-required":true}],"title":"Queue","type":"string"},"relative_due_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Due Date","type":"object"},"specific_due_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Specific Due Date","type":"string"},"type_id":{"description":"The type of task","title":"Type","type":"string"},"user_id":{"description":"The user that should be assigned the ask","oneOf":[{"x-required":true}],"title":"User","type":"string"}},"required":["assignee_type","due_date_type","name","type_id"],"type":"object"},"type":"array"},"type":{"description":"The product type","enum":["certifications-course-fees"],"title":"Type","type":"string"}},"required":["bulk_pricing_rules","bundled_products","business_unit_id","coupon_codes","course_id","custom_pricing_options","id","installment_plan_options","name","price","product_confirmation_email_options","purchase_limits","special_prices","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/CourseInstructor":{"id":"components/schemas/CourseInstructor","kind":"json-schema","title":"CourseInstructor","data":{"properties":{"contract_uri":{"description":"A link to the contract","format":"file","title":"Contract Uri","type":"string"},"courses":{"items":{"properties":{"course_id":{"description":"The course this instructor is approved to teach","title":"Course","type":"string"},"valid_from":{"format":"date","title":"Valid From","type":"string"},"valid_until":{"format":"date","title":"Valid Until","type":"string"}},"type":"object"},"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this course instructor","pattern":"/^[\\w|-]+$/","title":"ID","type":"string"},"is_active":{"description":"Whether or not this course instructor is active","title":"Is Active","type":"boolean"},"notes":{"description":"Notes on this instructor","title":"Notes","type":"string"},"pay_rate":{"description":"The contract rate for the instructor","format":"float","title":"Pay Rate","type":"number"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"training_provider_id":{"description":"The training provider","title":"Training Provider","type":"string"}},"required":["id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","training_provider_id"],"type":"object"}},"components/schemas/CourseOffering":{"id":"components/schemas/CourseOffering","kind":"json-schema","title":"CourseOffering","data":{"additionalProperties":false,"properties":{"additional_instructor_ids":{"description":"Additional instructors","items":{"type":"string"},"title":"Additional Instructors","type":"array"},"address":{"$ref":"#/components/schemas/Address"},"capacity_options":{"additionalProperties":false,"properties":{"capacity":{"description":"The offering capacity","format":"float","title":"Capacity","type":"number"}},"required":["capacity"],"title":"Capacity Options","type":"object"},"course_id":{"description":"The course being scheduled","title":"Course","type":"string"},"course_type_id":{"description":"The type of course","title":"Course Type","type":"string"},"credits_to_assign":{"items":{"additionalProperties":false,"properties":{"automatically_verify":{"description":"If true, the credits are verified upon assignment","title":"Automatically Verify","type":"boolean"},"credit_type_id":{"description":"The credit type","title":"Credit Type","type":"string"},"quantity":{"description":"The qty to assign","format":"double","title":"Quantity","type":"number"}},"required":["credit_type_id","quantity"],"type":"object"},"minItems":1,"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"Any information you want to display about this in the portal","title":"Description","type":"string"},"eligibility_requirements":{"additionalProperties":false,"description":"The criteria to use","properties":{"advanced_rule_error_message":{"description":"The error message to show when the advanced rule fails","title":"Advanced Rule Error Message","type":"string"},"advanced_rules":{"title":"Advanced Rules","type":"object"},"age_restrictions":{"additionalProperties":false,"properties":{"maximum_age":{"description":"The maximum age of the contact","format":"float","title":"Maximum Age","type":"number"},"minimum_age":{"description":"The minimum age of the contact","format":"float","title":"Minimum Age","type":"number"}},"title":"Age Restrictions","type":"object"},"award_options":{"additionalProperties":false,"properties":{"award_ids":{"items":{"type":"string"},"title":"Awards","type":"array"},"award_type_ids":{"items":{"type":"string"},"title":"Award Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Award Options","type":"object"},"award_recipients":{"description":"If set, only people who have received awards","title":"Award Recipients","type":"boolean"},"by_location":{"description":"If true, then filter by location","title":"By Location","type":"boolean"},"certificants":{"description":"If set, only people with specific certifications","title":"Certificants","type":"boolean"},"certification_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"program_ids":{"items":{"type":"string"},"title":"Programs","type":"array"}},"title":"Certification Options","type":"object"},"committee_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"committee_ids":{"items":{"type":"string"},"title":"Committees","type":"array"},"committee_position_ids":{"items":{"type":"string"},"title":"Committee Positions","type":"array"},"committee_type_ids":{"items":{"type":"string"},"title":"Committee Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Committee Member Options","type":"object"},"committee_members":{"description":"If set, active members who belong to a committee can purchase","title":"Committee Members","type":"boolean"},"custom_logic_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Logic Options","type":"object"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"donor_options":{"additionalProperties":false,"properties":{"donor_club_ids":{"items":{"type":"string"},"title":"Donor Clubs","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Donor Options","type":"object"},"donors":{"description":"If true, only donors","title":"Donors","type":"boolean"},"enable_advanced_rules":{"description":"Enable advanced JSON rules","title":"Enable Advanced Rules","type":"boolean"},"enable_age_restrictions":{"description":"Age registrations","title":"Enable Age Restrictions","type":"boolean"},"enable_custom_logic":{"description":"If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion","title":"Enable Custom Logic","type":"boolean"},"enable_entitlement_restrictions":{"description":"If set, then you must have certain entitlements","title":"Enable Entitlement Restrictions","type":"boolean"},"enable_expression":{"description":"Whether or not to enable an expression for evaluation","title":"Enable Expression","type":"boolean"},"enable_organization_restrictions":{"description":"If set, you can restrict organizations","title":"Enable Organization Restrictions","type":"boolean"},"enable_status_restriction":{"description":"If set, you can restrict by status","title":"Enable Status Restriction","type":"boolean"},"entitlement_restrictions":{"items":{"additionalProperties":false,"properties":{"quantity":{"description":"The quantity you must have","format":"float","title":"Quantity","type":"number"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["type_id"],"type":"object"},"type":"array"},"event_registration_options":{"additionalProperties":false,"properties":{"event_ids":{"items":{"type":"string"},"title":"Events","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"registration_category_ids":{"items":{"type":"string"},"title":"Registration Categories","type":"array"}},"title":"Event Registration Options","type":"object"},"event_registrations":{"description":"If set, only people who have registered for events","title":"Event Registrations","type":"boolean"},"expression":{"description":"The expression","title":"Expression","type":"string"},"expression_error_message":{"description":"The error message to show when the expression fails","title":"Expression Error Message","type":"string"},"location":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"countries":{"description":"Countries","items":{"type":"string"},"title":"Countries","type":"array"},"negate_logic":{"description":"If true, the logic in this section is negated; so NOT from these places","title":"Negate Logic","type":"boolean"}},"title":"Location","type":"object"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_ids":{"items":{"type":"string"},"title":"Chapters","type":"array"},"chapter_type_ids":{"items":{"type":"string"},"title":"Chapter Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Chapter Member Options","type":"object"},"chapter_members":{"description":"If set, active members who belong to a chapter can purchase","title":"Chapter Members","type":"boolean"},"member_package_ids":{"description":"The member package","items":{"type":"string"},"title":"Member Packages","type":"array"},"member_status_reason_ids":{"items":{"type":"string"},"title":"Member Status Reasons","type":"array"},"member_statuses":{"items":{"enum":["active","inactive","suspended"],"type":"string"},"title":"Member Statuses","type":"array"},"member_type_ids":{"description":"The member types","items":{"type":"string"},"title":"Member Types","type":"array"},"section_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"section_ids":{"items":{"type":"string"},"title":"Sections","type":"array"},"section_type_ids":{"items":{"type":"string"},"title":"Section Types","type":"array"}},"title":"Section Member Options","type":"object"},"section_members":{"description":"If set, active members who belong to a section can purchase","title":"Section Members","type":"boolean"}},"title":"Member Options","type":"object"},"members":{"description":"If set, active members can purchase this","title":"Members","type":"boolean"},"non_members":{"description":"If set, only nonmembers can purchase","title":"Non Members","type":"boolean"},"organization_restrictions":{"additionalProperties":false,"properties":{"contact_role_ids":{"items":{"type":"string"},"title":"Contact Roles","type":"array"},"organization_type_ids":{"items":{"type":"string"},"title":"Organization Types","type":"array"}},"title":"Organization Restrictions","type":"object"},"status_restrictions":{"description":"The statuses","items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Restrictions","type":"array"},"use_organization_for_eligibility":{"description":"If checked, a person's organization is used to check for eligibility, rather than the person themselves","title":"Use Organization For Eligibility","type":"boolean"}},"title":"Eligibility Requirements","type":"object"},"enable_capacity":{"description":"Whether capacity is set","title":"Enable Capacity","type":"boolean"},"enable_eligibility_requirements":{"description":"If true, this offering is only available to certain individuals","title":"Enable Eligibility Requirements","type":"boolean"},"enable_webinar_integration":{"description":"If selecting, registration will be linked to an external webinar service","title":"Enable Webinar Integration","type":"boolean"},"end_date":{"description":"The date of the course","format":"date-time","title":"End Date","type":"string"},"event_id":{"description":"If this offering is tied to a course, list it here","title":"Event","type":"string"},"fee_id":{"description":"The course registration fee","title":"Fee","type":"string"},"id":{"description":"The unique, string identifier of this course offering","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"instructor_id":{"description":"The instructor","title":"Instructor","type":"string"},"instructor_names":{"description":"The names of the instructors","items":{"type":"string"},"title":"Instructor Names","type":"array"},"meeting_url":{"description":"The URL of the meeting","title":"Meeting Url","type":"string"},"name":{"description":"The name of the course offering","title":"Name","type":"string"},"override_credit_assignment":{"description":"If true, the credit assignment rules for this course are overridden for the offering","title":"Override Credit Assignment","type":"boolean"},"program_ids":{"description":"The programs for which this course is relevant","items":{"type":"string"},"title":"Programs","type":"array"},"publish_to_portal":{"description":"Whether to sell the offering online","title":"Publish To Portal","type":"boolean"},"sell_from":{"description":"Date to sell online from","format":"date-time","title":"Sell From","type":"string"},"sell_until":{"description":"Date to sell online from","format":"date-time","title":"Sell Until","type":"string"},"short_description":{"description":"Any short descriptive information to display in the directory","title":"Short Description","type":"string"},"start_date":{"description":"The date of the course","format":"date-time","title":"Start Date","type":"string"},"survey_url":{"description":"A link to the survey to use after the course is complete","title":"Survey Url","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"timezone":{"description":"The timezone in which the course offering lives","title":"Timezone","type":"string"},"timezone_abbreviation":{"description":"The timezone abbreviation, based on the event start date","title":"Timezone Abbreviation","type":"string"},"timezone_mode":{"enum":["local","specific timezone"],"title":"Timezone Mode","type":"string"},"timezone_offset":{"description":"The time zone offset, in minutes, from UTC, based on the event start date","format":"float","title":"Timezone Offset","type":"number"},"training_location_id":{"description":"The training location","title":"Training Location","type":"string"},"training_provider_id":{"description":"The training provider administering the course","title":"Training Provider","type":"string"},"type":{"enum":["in person","on-demand","virtual"],"title":"Type","type":"string"},"webinar_integration_options":{"additionalProperties":false,"properties":{"meeting_id":{"description":"The meeting id","oneOf":[{"x-required":true}],"title":"Meeting","type":"string"},"type":{"description":"The video conference type ","enum":["meeting","webinar"],"title":"Type","type":"string"},"webinar_account_id":{"description":"The account ID","title":"Webinar Account","type":"string"},"webinar_id":{"description":"The webinar id","oneOf":[{"x-required":true}],"title":"Webinar","type":"string"},"webinar_service":{"description":"The integration service","enum":["integrations-zoom-accounts"],"title":"Webinar Service","type":"string"}},"required":["webinar_account_id","webinar_service"],"title":"Webinar Integration Options","type":"object"},"webinar_url":{"description":"The URL of the webinar","title":"Webinar Url","type":"string"}},"required":["capacity_options","course_id","credits_to_assign","eligibility_requirements","end_date","id","name","start_date","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","timezone","training_location_id","training_provider_id","webinar_integration_options"],"type":"object"}},"components/schemas/CourseOfferingSearchParameters":{"id":"components/schemas/CourseOfferingSearchParameters","kind":"json-schema","title":"CourseOfferingSearchParameters","data":{"additionalProperties":false,"properties":{"country":{"title":"Country","type":"string"},"course_id":{"items":{"type":"string"},"title":"Course","type":"array"},"course_type_id":{"items":{"type":"string"},"title":"Course Type","type":"array"},"end_date":{"items":{"type":"string"},"maxItems":2,"title":"End Date","type":"array"},"fee_id":{"items":{"type":"string"},"title":"Fee","type":"array"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"instructor_id":{"items":{"type":"string"},"title":"Instructor","type":"array"},"program_id":{"title":"Program","type":"string"},"publish_to_portal":{"items":{"type":"boolean"},"title":"Publish To Portal","type":"array"},"start_date":{"items":{"type":"string"},"maxItems":2,"title":"Start Date","type":"array"},"state":{"title":"State","type":"string"},"training_location_id":{"items":{"type":"string"},"title":"Training Location","type":"array"},"training_provider_id":{"items":{"type":"string"},"title":"Training Provider","type":"array"},"type":{"items":{"type":"string"},"title":"Type","type":"array"}},"type":"object"}},"components/schemas/CourseOfferingSearchResults":{"id":"components/schemas/CourseOfferingSearchResults","kind":"json-schema","title":"CourseOfferingSearchResults","data":{"additionalProperties":false,"properties":{"additional_instructor_ids":{"description":"Additional instructors","items":{"type":"string"},"title":"Additional Instructors","type":"array"},"address":{"$ref":"#/components/schemas/Address"},"capacity_options":{"additionalProperties":false,"properties":{"capacity":{"description":"The offering capacity","format":"float","title":"Capacity","type":"number"}},"required":["capacity"],"title":"Capacity Options","type":"object"},"course_id":{"description":"The course being scheduled","title":"Course","type":"string"},"course_type_id":{"description":"The type of course","title":"Course Type","type":"string"},"credits_to_assign":{"items":{"additionalProperties":false,"properties":{"automatically_verify":{"description":"If true, the credits are verified upon assignment","title":"Automatically Verify","type":"boolean"},"credit_type_id":{"description":"The credit type","title":"Credit Type","type":"string"},"quantity":{"description":"The qty to assign","format":"double","title":"Quantity","type":"number"}},"required":["credit_type_id","quantity"],"type":"object"},"minItems":1,"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"Any information you want to display about this in the portal","title":"Description","type":"string"},"eligibility_requirements":{"additionalProperties":false,"description":"The criteria to use","properties":{"advanced_rule_error_message":{"description":"The error message to show when the advanced rule fails","title":"Advanced Rule Error Message","type":"string"},"advanced_rules":{"title":"Advanced Rules","type":"object"},"age_restrictions":{"additionalProperties":false,"properties":{"maximum_age":{"description":"The maximum age of the contact","format":"float","title":"Maximum Age","type":"number"},"minimum_age":{"description":"The minimum age of the contact","format":"float","title":"Minimum Age","type":"number"}},"title":"Age Restrictions","type":"object"},"award_options":{"additionalProperties":false,"properties":{"award_ids":{"items":{"type":"string"},"title":"Awards","type":"array"},"award_type_ids":{"items":{"type":"string"},"title":"Award Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Award Options","type":"object"},"award_recipients":{"description":"If set, only people who have received awards","title":"Award Recipients","type":"boolean"},"by_location":{"description":"If true, then filter by location","title":"By Location","type":"boolean"},"certificants":{"description":"If set, only people with specific certifications","title":"Certificants","type":"boolean"},"certification_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"program_ids":{"items":{"type":"string"},"title":"Programs","type":"array"}},"title":"Certification Options","type":"object"},"committee_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"committee_ids":{"items":{"type":"string"},"title":"Committees","type":"array"},"committee_position_ids":{"items":{"type":"string"},"title":"Committee Positions","type":"array"},"committee_type_ids":{"items":{"type":"string"},"title":"Committee Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Committee Member Options","type":"object"},"committee_members":{"description":"If set, active members who belong to a committee can purchase","title":"Committee Members","type":"boolean"},"custom_logic_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Logic Options","type":"object"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"donor_options":{"additionalProperties":false,"properties":{"donor_club_ids":{"items":{"type":"string"},"title":"Donor Clubs","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Donor Options","type":"object"},"donors":{"description":"If true, only donors","title":"Donors","type":"boolean"},"enable_advanced_rules":{"description":"Enable advanced JSON rules","title":"Enable Advanced Rules","type":"boolean"},"enable_age_restrictions":{"description":"Age registrations","title":"Enable Age Restrictions","type":"boolean"},"enable_custom_logic":{"description":"If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion","title":"Enable Custom Logic","type":"boolean"},"enable_entitlement_restrictions":{"description":"If set, then you must have certain entitlements","title":"Enable Entitlement Restrictions","type":"boolean"},"enable_expression":{"description":"Whether or not to enable an expression for evaluation","title":"Enable Expression","type":"boolean"},"enable_organization_restrictions":{"description":"If set, you can restrict organizations","title":"Enable Organization Restrictions","type":"boolean"},"enable_status_restriction":{"description":"If set, you can restrict by status","title":"Enable Status Restriction","type":"boolean"},"entitlement_restrictions":{"items":{"additionalProperties":false,"properties":{"quantity":{"description":"The quantity you must have","format":"float","title":"Quantity","type":"number"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["type_id"],"type":"object"},"type":"array"},"event_registration_options":{"additionalProperties":false,"properties":{"event_ids":{"items":{"type":"string"},"title":"Events","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"registration_category_ids":{"items":{"type":"string"},"title":"Registration Categories","type":"array"}},"title":"Event Registration Options","type":"object"},"event_registrations":{"description":"If set, only people who have registered for events","title":"Event Registrations","type":"boolean"},"expression":{"description":"The expression","title":"Expression","type":"string"},"expression_error_message":{"description":"The error message to show when the expression fails","title":"Expression Error Message","type":"string"},"location":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"countries":{"description":"Countries","items":{"type":"string"},"title":"Countries","type":"array"},"negate_logic":{"description":"If true, the logic in this section is negated; so NOT from these places","title":"Negate Logic","type":"boolean"}},"title":"Location","type":"object"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_ids":{"items":{"type":"string"},"title":"Chapters","type":"array"},"chapter_type_ids":{"items":{"type":"string"},"title":"Chapter Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Chapter Member Options","type":"object"},"chapter_members":{"description":"If set, active members who belong to a chapter can purchase","title":"Chapter Members","type":"boolean"},"member_package_ids":{"description":"The member package","items":{"type":"string"},"title":"Member Packages","type":"array"},"member_status_reason_ids":{"items":{"type":"string"},"title":"Member Status Reasons","type":"array"},"member_statuses":{"items":{"enum":["active","inactive","suspended"],"type":"string"},"title":"Member Statuses","type":"array"},"member_type_ids":{"description":"The member types","items":{"type":"string"},"title":"Member Types","type":"array"},"section_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"section_ids":{"items":{"type":"string"},"title":"Sections","type":"array"},"section_type_ids":{"items":{"type":"string"},"title":"Section Types","type":"array"}},"title":"Section Member Options","type":"object"},"section_members":{"description":"If set, active members who belong to a section can purchase","title":"Section Members","type":"boolean"}},"title":"Member Options","type":"object"},"members":{"description":"If set, active members can purchase this","title":"Members","type":"boolean"},"non_members":{"description":"If set, only nonmembers can purchase","title":"Non Members","type":"boolean"},"organization_restrictions":{"additionalProperties":false,"properties":{"contact_role_ids":{"items":{"type":"string"},"title":"Contact Roles","type":"array"},"organization_type_ids":{"items":{"type":"string"},"title":"Organization Types","type":"array"}},"title":"Organization Restrictions","type":"object"},"status_restrictions":{"description":"The statuses","items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Restrictions","type":"array"},"use_organization_for_eligibility":{"description":"If checked, a person's organization is used to check for eligibility, rather than the person themselves","title":"Use Organization For Eligibility","type":"boolean"}},"title":"Eligibility Requirements","type":"object"},"enable_capacity":{"description":"Whether capacity is set","title":"Enable Capacity","type":"boolean"},"enable_eligibility_requirements":{"description":"If true, this offering is only available to certain individuals","title":"Enable Eligibility Requirements","type":"boolean"},"enable_webinar_integration":{"description":"If selecting, registration will be linked to an external webinar service","title":"Enable Webinar Integration","type":"boolean"},"end_date":{"description":"The date of the course","format":"date-time","title":"End Date","type":"string"},"event_id":{"description":"If this offering is tied to a course, list it here","title":"Event","type":"string"},"fee_id":{"description":"The course registration fee","title":"Fee","type":"string"},"id":{"description":"The unique, string identifier of this course offering","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"instructor_id":{"description":"The instructor","title":"Instructor","type":"string"},"instructor_names":{"description":"The names of the instructors","items":{"type":"string"},"title":"Instructor Names","type":"array"},"meeting_url":{"description":"The URL of the meeting","title":"Meeting Url","type":"string"},"name":{"description":"The name of the course offering","title":"Name","type":"string"},"override_credit_assignment":{"description":"If true, the credit assignment rules for this course are overridden for the offering","title":"Override Credit Assignment","type":"boolean"},"program_ids":{"description":"The programs for which this course is relevant","items":{"type":"string"},"title":"Programs","type":"array"},"publish_to_portal":{"description":"Whether to sell the offering online","title":"Publish To Portal","type":"boolean"},"sell_from":{"description":"Date to sell online from","format":"date-time","title":"Sell From","type":"string"},"sell_until":{"description":"Date to sell online from","format":"date-time","title":"Sell Until","type":"string"},"short_description":{"description":"Any short descriptive information to display in the directory","title":"Short Description","type":"string"},"start_date":{"description":"The date of the course","format":"date-time","title":"Start Date","type":"string"},"survey_url":{"description":"A link to the survey to use after the course is complete","title":"Survey Url","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"timezone":{"description":"The timezone in which the course offering lives","title":"Timezone","type":"string"},"timezone_abbreviation":{"description":"The timezone abbreviation, based on the event start date","title":"Timezone Abbreviation","type":"string"},"timezone_mode":{"enum":["local","specific timezone"],"title":"Timezone Mode","type":"string"},"timezone_offset":{"description":"The time zone offset, in minutes, from UTC, based on the event start date","format":"float","title":"Timezone Offset","type":"number"},"training_location_id":{"description":"The training location","title":"Training Location","type":"string"},"training_provider_id":{"description":"The training provider administering the course","title":"Training Provider","type":"string"},"type":{"enum":["in person","on-demand","virtual"],"title":"Type","type":"string"},"webinar_integration_options":{"additionalProperties":false,"properties":{"meeting_id":{"description":"The meeting id","oneOf":[{"x-required":true}],"title":"Meeting","type":"string"},"type":{"description":"The video conference type ","enum":["meeting","webinar"],"title":"Type","type":"string"},"webinar_account_id":{"description":"The account ID","title":"Webinar Account","type":"string"},"webinar_id":{"description":"The webinar id","oneOf":[{"x-required":true}],"title":"Webinar","type":"string"},"webinar_service":{"description":"The integration service","enum":["integrations-zoom-accounts"],"title":"Webinar Service","type":"string"}},"required":["webinar_account_id","webinar_service"],"title":"Webinar Integration Options","type":"object"},"webinar_url":{"description":"The URL of the webinar","title":"Webinar Url","type":"string"}},"required":["capacity_options","course_id","credits_to_assign","eligibility_requirements","end_date","id","name","start_date","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","timezone","training_location_id","training_provider_id","webinar_integration_options"],"type":"object"}},"components/schemas/CourseRegProcess":{"id":"components/schemas/CourseRegProcess","kind":"json-schema","title":"CourseRegProcess","data":{"additionalProperties":false,"properties":{"available_in_portal":{"description":"If true, not available in the portal","title":"Available In Portal","type":"boolean"},"available_to_training_providers":{"description":"If true, this process is available to training providers","title":"Available To Training Providers","type":"boolean"},"checkout_settings":{"additionalProperties":false,"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bank_account_id":{"description":"The default bank account that the store should use to receive payments","title":"Bank Account","type":"string"},"bill_my_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Organization Options","type":"object"},"bill_my_parent_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Parent Organization Options","type":"object"},"business_unit_id":{"description":"The business unit of the store","title":"Business Unit","type":"string"},"cancellation_fee_product_id":{"description":"The ID of the product used for cancellation fees","title":"Cancellation Fee Product","type":"string"},"checkout_donation_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"simple_checkout_donation_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"allow_user_to_specify_custom_amount":{"description":"If set, the user can specify their own custom donation","title":"Allow User To Specify Custom Amount","type":"boolean"},"donation_ask_text":{"description":"The text shown to the user when making the donation","title":"Donation Ask Text","type":"string"},"donation_denominations":{"items":{"format":"double","type":"number"},"title":"Donation Denominations","type":"array"},"donation_information":{"description":"Additional information about the donation","title":"Donation Information","type":"string"},"donation_product_id":{"description":"The misc product that should be used","title":"Donation Product","type":"string"},"override_donation_denominations":{"description":"If set, donation denominations are specified here and the defaults are not used","title":"Override Donation Denominations","type":"boolean"},"suggested_donation":{"description":"A suggested donation","format":"double","title":"Suggested Donation","type":"number"}},"required":["donation_product_id"],"title":"Simple Checkout Donation Options","type":"object"},"type":{"enum":["simple"],"title":"Type","type":"string"}},"title":"Checkout Donation Options","type":"object"},"credit_card_minimum_range_end":{"description":"If set, the maximum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range End","type":"number"},"credit_card_minimum_range_start":{"description":"If set, the minimum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range Start","type":"number"},"credit_card_mode":{"description":"Determines whether or not credit cards are accepted","enum":["disabled","enabled","range"],"title":"Credit Card Mode","type":"string"},"credit_card_processing_fee_mode":{"description":"Determines how credit card processing fees should be handled","enum":["charge","do not charge","prompt user"],"title":"Credit Card Processing Fee Mode","type":"string"},"credit_card_processing_fee_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"fee_percentage":{"description":"The fee percentage to charge for credit card processing ","format":"float","title":"Fee Percentage","type":"number"},"maximum_fee":{"description":"The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged","format":"float","title":"Maximum Fee","type":"number"},"minimum_fee":{"description":"The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged","format":"float","title":"Minimum Fee","type":"number"},"product_id":{"description":"The misc product to use for the credit card processing","title":"Product","type":"string"},"prompt_sub_text":{"description":"Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Sub Text","type":"string"},"prompt_text":{"description":"The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Text","type":"string"}},"required":["fee_percentage","product_id"],"title":"Credit Card Processing Fee Options","type":"object"},"disable_electronic_payment_vaulting":{"description":"If set, in the portal people are not allowed to save credit cards","title":"Disable Electronic Payment Vaulting","type":"boolean"},"enable_bill_my_organization":{"description":"If set, the user has the option to bill their organization","title":"Enable Bill My Organization","type":"boolean"},"enable_bill_my_parent_organization":{"description":"If set, the user has the option to bill their organization's parent organization","title":"Enable Bill My Parent Organization","type":"boolean"},"enable_donations_at_checkout":{"description":"If selected, users will be prompted to make a donation upon checking out","title":"Enable Donations At Checkout","type":"boolean"},"enable_electronic_checks":{"description":"If set, electronic checks are allowed","title":"Enable Electronic Checks","type":"boolean"},"enable_pay_later":{"description":"If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed","title":"Enable Pay Later","type":"boolean"},"enable_payroll_deduction":{"description":"If set, payroll deduction is allowed","title":"Enable Payroll Deduction","type":"boolean"},"enable_split_payments":{"description":"If set, users are allowed to split payments","title":"Enable Split Payments","type":"boolean"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"oneOf":[{"x-required":true}],"type":"array"},"invoice_payment_terms_id":{"description":"The payment terms for invoices; if left blank, default is used","title":"Invoice Payment Terms","type":"string"},"invoice_template_id":{"description":"The template to use for invoices created during this process","title":"Invoice Template","type":"string"},"merchant_account_id":{"description":"The merchant account that the store should use to receive payments","title":"Merchant Account","type":"string"},"pay_later_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Pay Later Options","type":"object"},"restocking_fee_product_id":{"description":"The ID of the product used for restocking fees","title":"Restocking Fee Product","type":"string"},"special_instructions":{"description":"Instructions shown to the user","title":"Special Instructions","type":"string"},"use_pro_forma_invoices":{"description":"Whether to use pro forma invoices when user elects to pay later","title":"Use Pro Forma Invoices","type":"boolean"}},"required":["bank_account_id","business_unit_id","merchant_account_id"],"title":"Checkout Settings","type":"object"},"confirmation_email":{"additionalProperties":false,"description":"Email to send once the registration is activated","properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Confirmation Email","type":"object"},"contact_form_options":{"additionalProperties":false,"properties":{"contact_form_id":{"description":"The default contact form to present to the user to verify the contact info before proceeding","pattern":"^rolodex-contacts__.*","title":"Contact Form","type":"string"},"html":{"description":"Text to show on the top of the form","title":"Html","type":"string"}},"required":["contact_form_id"],"title":"Contact Form Options","type":"object"},"course_ids":{"items":{"type":"string"},"title":"Courses","type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"A description of the process to help the user understand whether to choose","title":"Description","type":"string"},"display_in_portal_as":{"description":"How to display in portal","title":"Display In Portal As","type":"string"},"display_order":{"description":"The display order","format":"float","title":"Display Order","type":"number"},"enable_confirmation_email":{"description":"Whether or not to send an email when the registration is processed","title":"Enable Confirmation Email","type":"boolean"},"enable_confirmation_email_for_virtual":{"description":"Whether or not to send an email when the registration, and the offering is virtual or on demand","title":"Enable Confirmation Email For Virtual","type":"boolean"},"form_id":{"description":"The default application form for this process","pattern":"^certifications-course-registrations__.*","title":"Form","type":"string"},"id":{"description":"The unique, string identifier of this course reg process","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this course reg process is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the course reg process","title":"Name","type":"string"},"override_checkout_settings":{"description":"Whether or not to override POC settings","title":"Override Checkout Settings","type":"boolean"},"restrict_courses":{"description":"Whether this is restricted to only certain courses","title":"Restrict Courses","type":"boolean"},"show_contact_form":{"description":"Whether or not to show a contact form","title":"Show Contact Form","type":"boolean"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"enum":["register"],"title":"Type","type":"string"},"virtual_confirmation_email":{"additionalProperties":false,"description":"Email to send once the registration is activated for virtual or on-demand","properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Virtual Confirmation Email","type":"object"}},"required":["checkout_settings","confirmation_email","contact_form_options","course_ids","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type","virtual_confirmation_email"],"type":"object"}},"components/schemas/CourseRegistration":{"id":"components/schemas/CourseRegistration","kind":"json-schema","title":"CourseRegistration","data":{"additionalProperties":false,"properties":{"application_id":{"description":"The certification application to which this registration ","title":"Application","type":"string"},"arrival_date":{"description":"The date the person arrived at the course","format":"date-time","title":"Arrival Date","type":"string"},"cancellation_date":{"format":"date-time","title":"Cancellation Date","type":"string"},"city":{"description":"The member city","title":"City","type":"string"},"completion_percentage":{"description":"The completion amount","format":"double","title":"Completion Percentage","type":"number"},"country":{"description":"The member country","title":"Country","type":"string"},"course_date":{"description":"The date of the course","format":"date-time","title":"Course Date","type":"string"},"course_id":{"description":"The course","title":"Course","type":"string"},"course_offering_id":{"description":"The scheduled course","title":"Course Offering","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date/time of the course registration","format":"date-time","title":"Date","type":"string"},"departure_date":{"description":"The date the person left  the course","format":"date-time","title":"Departure Date","type":"string"},"email_address":{"description":"The member's email address","title":"Email Address","type":"string"},"event_registration_id":{"description":"The event registration to which this is tied","title":"Event Registration","type":"string"},"exam_offering_ids":{"description":"The exams to register for at the same time as the course","items":{"type":"string"},"title":"Exam Offerings","type":"array"},"first_name":{"description":"The member's first name","title":"First Name","type":"string"},"id":{"description":"The unique, string identifier of this course registration","pattern":"^[\\w-|:]+$","title":"ID","type":"string"},"job_title":{"description":"The member job title","title":"Job Title","type":"string"},"last_name":{"description":"The member's last name","title":"Last Name","type":"string"},"meeting_join_url":{"description":"The URL used to join the meeting","title":"Meeting Join Url","type":"string"},"meeting_participant_id":{"description":"The external ID of this registration in the linked meeting","title":"Meeting Participant","type":"string"},"name":{"description":"The member's name","title":"Name","type":"string"},"notes":{"description":"Any notes","title":"Notes","type":"string"},"number":{"description":"The registration number","format":"float","title":"Number","type":"number"},"order_amount_paid":{"description":"The amount paid","format":"double","title":"Order Amount Paid","type":"number"},"order_balance_due":{"description":"The balance due on the order","format":"double","title":"Order Balance Due","type":"number"},"order_currency_code":{"title":"Order Currency Code","type":"string"},"order_currency_symbol":{"title":"Order Currency Symbol","type":"string"},"order_id":{"description":"The order","title":"Order","type":"string"},"order_line_item_id":{"description":"The order line item","title":"Order Line Item","type":"string"},"order_number":{"description":"The order number","format":"float","title":"Order Number","type":"number"},"order_status":{"enum":["awaiting payment","awaiting pickup","awaiting shipping","cancelled","completed","disputed","open","partially shipped","returned","shipped","void"],"title":"Order Status","type":"string"},"order_total":{"description":"The total of the order","format":"double","title":"Order Total","type":"number"},"organization_id":{"description":"Organization","title":"Organization","type":"string"},"process_id":{"description":"The registration process used to create the registration","title":"Process","type":"string"},"state":{"description":"The state","title":"State","type":"string"},"status":{"enum":["attended","cancelled","completed","draft","in progress","no show","registered"],"title":"Status","type":"string"},"student_id":{"description":"The person registering for the course","title":"Student","type":"string"},"substitutions":{"items":{"additionalProperties":false,"properties":{"course_offering_id":{"description":"The scheduled course","title":"Course Offering","type":"string"},"date":{"description":"The date of substitution","format":"date-time","title":"Date","type":"string"},"notes":{"description":"Any reasoning/information for substitution","title":"Notes","type":"string"},"student_id":{"description":"The person registering for the course","title":"Student","type":"string"}},"required":["course_offering_id","date","student_id"],"type":"object"},"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"training_location_id":{"description":"The location","title":"Training Location","type":"string"},"training_provider_billing_date":{"description":"The date this registration was billing to the training provider","title":"Training Provider Billing Date","type":"string"},"training_provider_billing_invoice_id":{"description":"The invoice that was created to bill for this registration","title":"Training Provider Billing Invoice","type":"string"},"training_provider_billing_invoice_line_item_id":{"description":"The invoice that was created to bill for this registration","title":"Training Provider Billing Invoice Line Item","type":"string"},"training_provider_billing_name":{"description":"The training provider name (for billing)","title":"Training Provider Billing Name","type":"string"},"training_provider_billing_status":{"description":"The training provider billing status for this registration","enum":["billed","billing hold","exempt from billing","not yet billed"],"title":"Training Provider Billing Status","type":"string"},"training_provider_id":{"description":"The training provider","title":"Training Provider","type":"string"},"webinar_join_url":{"description":"The URL used to join the webinar","title":"Webinar Join Url","type":"string"},"webinar_participant_id":{"description":"The external ID of this registration in the linked webinar","title":"Webinar Participant","type":"string"}},"required":["course_id","course_offering_id","id","name","student_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/CourseRegistrationSearchParameters":{"id":"components/schemas/CourseRegistrationSearchParameters","kind":"json-schema","title":"CourseRegistrationSearchParameters","data":{"additionalProperties":false,"properties":{"arrival_date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Arrival Date","type":"array"},"city":{"description":"City to search","title":"City","type":"string"},"course_id":{"items":{"type":"string"},"title":"Course","type":"array"},"course_offering_id":{"items":{"type":"string"},"title":"Course Offering","type":"array"},"date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"departure_date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Departure Date","type":"array"},"email_address":{"title":"Email Address","type":"string"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"job_title":{"title":"Job Title","type":"string"},"name":{"title":"Name","type":"string"},"order_amount_paid":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Order Amount Paid","type":"array"},"order_balance_due":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Order Balance Due","type":"array"},"order_id":{"items":{"type":"string"},"title":"Order","type":"array"},"order_number":{"items":{"format":"float","type":"number"},"title":"Order Number","type":"array"},"order_status":{"items":{"type":"string"},"title":"Order Status","type":"array"},"order_total":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Order Total","type":"array"},"state":{"description":"The state","title":"State","type":"string"},"status":{"items":{"type":"string"},"title":"Status","type":"array"},"sys_created_at":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Sys Created At","type":"array"},"training_location_id":{"items":{"type":"string"},"title":"Training Location","type":"array"},"training_provider_id":{"items":{"type":"string"},"title":"Training Provider","type":"array"}},"type":"object"}},"components/schemas/CourseRegistrationSearchResults":{"id":"components/schemas/CourseRegistrationSearchResults","kind":"json-schema","title":"CourseRegistrationSearchResults","data":{"additionalProperties":false,"properties":{"arrival_date":{"format":"date-time","title":"Arrival Date","type":"string"},"city":{"description":"City to search","title":"City","type":"string"},"course_id":{"title":"Course","type":"string"},"course_offering_id":{"title":"Course Offering","type":"string"},"date":{"format":"date-time","title":"Date","type":"string"},"departure_date":{"format":"date-time","title":"Departure Date","type":"string"},"email_address":{"title":"Email Address","type":"string"},"id":{"title":"ID","type":"string"},"job_title":{"title":"Job Title","type":"string"},"name":{"title":"Name","type":"string"},"organization_id":{"title":"Organization","type":"string"},"state":{"description":"The state","title":"State","type":"string"},"status":{"title":"Status","type":"string"},"training_location_id":{"title":"Training Location","type":"string"},"training_provider_id":{"title":"Training Provider","type":"string"}},"type":"object"}},"components/schemas/CourseType":{"id":"components/schemas/CourseType","kind":"json-schema","title":"CourseType","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"display_in_portal_as":{"description":"The way this type of course is shown in the portal, particularly in the online store","title":"Display In Portal As","type":"string"},"display_order":{"description":"Display order of the course type","format":"float","title":"Display Order","type":"number"},"id":{"description":"The unique, string identifier of this course type","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this course type is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the course type","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"universal_shopping_cart_image_uri":{"description":"The image to display for this course when it is in the online store","title":"Universal Shopping Cart Image Uri","type":"string"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Credit":{"id":"components/schemas/Credit","kind":"json-schema","title":"Credit","data":{"additionalProperties":false,"properties":{"activity_id":{"description":"The activity to which this credit is linked ","title":"Activity","type":"string"},"contact_id":{"description":"The owner of the credit","title":"Contact","type":"string"},"course_registration_id":{"description":"The course reg to which this credit is linked ","title":"Course Registration","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the credit","format":"date","title":"Date","type":"string"},"event_id":{"title":"Event","type":"string"},"event_registration_id":{"title":"Event Registration","type":"string"},"expiration_date":{"description":"The date the credit expires","title":"Expiration Date","type":"string"},"id":{"description":"The unique, string identifier of this credit","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"notes":{"description":"Any notes about the credit","title":"Notes","type":"string"},"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit #"},"children":[]}]}]}],"format":"float","title":"Number","type":"number"},"origin":{"enum":["certification activity","course registration","event registration","legacy system"],"title":"Origin","type":"string"},"quantity":{"description":"The quantity of credits","format":"double","minimum":0.01,"title":"Quantity","type":"number"},"quantity_available":{"description":"The quantity of credits that are available","format":"double","title":"Quantity Available","type":"number"},"quantity_used":{"description":"The total amount used","format":"double","title":"Quantity Used","type":"number"},"self_reported":{"description":"Whether or not this credit was self reported","title":"Self Reported","type":"boolean"},"status":{"enum":["archived","draft","rejected","submitted","under review","verified"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type_id":{"description":"The type of credit","title":"Type","type":"string"},"usages":{"items":{"additionalProperties":false,"properties":{"application_id":{"description":"The certification application for which the credit was used","title":"Application","type":"string"},"quantity":{"description":"The number of credits applied to the application","format":"double","title":"Quantity","type":"number"}},"required":["application_id","quantity"],"type":"object"},"type":"array"}},"required":["activity_id","contact_id","course_registration_id","date","event_id","event_registration_id","id","origin","quantity","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type_id"],"type":"object"}},"components/schemas/CreditApplicationRequest":{"id":"components/schemas/CreditApplicationRequest","kind":"json-schema","title":"CreditApplicationRequest","data":{"additionalProperties":false,"properties":{"credits":{"items":{"additionalProperties":false,"properties":{"credit_id":{"title":"Credit","type":"string"}},"required":["credit_id"],"type":"object"},"minItems":1,"type":"array"}},"required":["credits"],"type":"object"}},"components/schemas/CreditRequirementFormulaTestRequest":{"id":"components/schemas/CreditRequirementFormulaTestRequest","kind":"json-schema","title":"CreditRequirementFormulaTestRequest","data":{"properties":{"credit_type_id":{"description":"The type of credits required","title":"Credit Type","type":"string"},"formula":{"description":"A formula to determine the number of credits","title":"Formula","type":"string"},"number_of_credits":{"description":"The number of credits required","format":"float","title":"Number Of Credits","type":"number"},"type":{"description":"Whether or not the number of credits is fixed or calculated","enum":["calculated","fixed"],"title":"Type","type":"string"}},"required":["credit_type_id","formula","number_of_credits"],"type":"object"}},"components/schemas/CreditRequirementFormulaTestResponse":{"id":"components/schemas/CreditRequirementFormulaTestResponse","kind":"json-schema","title":"CreditRequirementFormulaTestResponse","data":{"additionalProperties":false,"properties":{"date_requirement_fulfilled":{"description":"The date that the requirement was fulfilled","format":"date-time","title":"Date Requirement Fulfilled","type":"string"},"id":{"description":"Requirement id","title":"ID","type":"string"},"internal_notes":{"description":"Internal notes","title":"Internal Notes","type":"string"},"name":{"description":"A description of the requirement","title":"Name","type":"string"},"not_applicable":{"description":"If true, this requirement is not applicable to this application and not used in calculations","title":"Not Applicable","type":"boolean"},"notes":{"description":"Any notes, visible to the applicant","title":"Notes","type":"string"},"portal_explanation":{"title":"Portal Explanation","type":"string"},"status":{"enum":["fulfilled","pending review","unfulfilled"],"title":"Status","type":"string"},"type":{"title":"Type","type":"string"},"weight":{"format":"float","title":"Weight","type":"number"}},"required":["id","status"],"type":"object"}},"components/schemas/CreditSearchParameters":{"id":"components/schemas/CreditSearchParameters","kind":"json-schema","title":"CreditSearchParameters","data":{"additionalProperties":false,"properties":{"contact_id":{"items":{"type":"string"},"title":"Contact","type":"array"},"date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"expiration_date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Expiration Date","type":"array"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"origin":{"title":"Origin","type":"string"},"quantity":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Quantity","type":"array"},"quantity_available":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Quantity Available","type":"array"},"quantity_used":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Quantity Used","type":"array"},"self_reported":{"items":{"type":"boolean"},"title":"Self Reported","type":"array"},"status":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Status","type":"array"},"type_id":{"items":{"type":"string"},"title":"Type","type":"array"}},"type":"object"}},"components/schemas/CreditSearchResults":{"id":"components/schemas/CreditSearchResults","kind":"json-schema","title":"CreditSearchResults","data":{"additionalProperties":false,"properties":{"activity_id":{"description":"The activity to which this credit is linked ","title":"Activity","type":"string"},"contact_id":{"description":"The owner of the credit","title":"Contact","type":"string"},"course_registration_id":{"description":"The course reg to which this credit is linked ","title":"Course Registration","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the credit","format":"date","title":"Date","type":"string"},"event_id":{"title":"Event","type":"string"},"event_registration_id":{"title":"Event Registration","type":"string"},"expiration_date":{"description":"The date the credit expires","title":"Expiration Date","type":"string"},"id":{"description":"The unique, string identifier of this credit","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"notes":{"description":"Any notes about the credit","title":"Notes","type":"string"},"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit #"},"children":[]}]}]}],"format":"float","title":"Number","type":"number"},"origin":{"enum":["certification activity","course registration","event registration","legacy system"],"title":"Origin","type":"string"},"quantity":{"description":"The quantity of credits","format":"double","minimum":0.01,"title":"Quantity","type":"number"},"quantity_available":{"description":"The quantity of credits that are available","format":"double","title":"Quantity Available","type":"number"},"quantity_used":{"description":"The total amount used","format":"double","title":"Quantity Used","type":"number"},"self_reported":{"description":"Whether or not this credit was self reported","title":"Self Reported","type":"boolean"},"status":{"enum":["archived","draft","rejected","submitted","under review","verified"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type_id":{"description":"The type of credit","title":"Type","type":"string"},"usages":{"items":{"additionalProperties":false,"properties":{"application_id":{"description":"The certification application for which the credit was used","title":"Application","type":"string"},"quantity":{"description":"The number of credits applied to the application","format":"double","title":"Quantity","type":"number"}},"required":["application_id","quantity"],"type":"object"},"type":"array"}},"required":["activity_id","contact_id","course_registration_id","date","event_id","event_registration_id","id","origin","quantity","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type_id"],"type":"object"}},"components/schemas/CreditType":{"id":"components/schemas/CreditType","kind":"json-schema","title":"CreditType","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this credit type","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this credit type is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the credit type","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/CustomFieldValue":{"id":"components/schemas/CustomFieldValue","kind":"json-schema","title":"CustomFieldValue","data":{"additionalProperties":false,"properties":{"boolean_value":{"description":"The boolean value","title":"Boolean Value","type":"boolean"},"custom_field_id":{"description":"The unique identifier of the custom field","title":"Custom Field","type":"string"},"file_url_value":{"description":"The pointer to a file value","title":"File Url Value","type":"string"},"list_value":{"description":"The list value","items":{"type":"string"},"title":"List Value","type":"array"},"numeric_value":{"description":"The numeric value","format":"float","title":"Numeric Value","type":"number"},"string_value":{"description":"The string value of the custom field","title":"String Value","type":"string"},"table_value":{"description":"A list of objects (a table)","items":{"additionalProperties":false,"properties":{},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/DescribeCourseOfferingResult":{"id":"components/schemas/DescribeCourseOfferingResult","kind":"json-schema","title":"DescribeCourseOfferingResult","data":{"additionalProperties":false,"properties":{"additional_instructor_ids":{"description":"Additional instructors","items":{"type":"string"},"title":"Additional Instructors","type":"array"},"address":{"$ref":"#/components/schemas/Address"},"capacity_options":{"additionalProperties":false,"properties":{"capacity":{"description":"The offering capacity","format":"float","title":"Capacity","type":"number"}},"required":["capacity"],"title":"Capacity Options","type":"object"},"course_id":{"description":"The course being scheduled","title":"Course","type":"string"},"course_type_id":{"description":"The type of course","title":"Course Type","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"Any information you want to display about this in the portal","title":"Description","type":"string"},"enable_capacity":{"description":"Whether capacity is set","title":"Enable Capacity","type":"boolean"},"enable_webinar_integration":{"description":"If selecting, registration will be linked to an external webinar service","title":"Enable Webinar Integration","type":"boolean"},"end_date":{"description":"The date of the course","format":"date-time","title":"End Date","type":"string"},"event_id":{"description":"If this offering is tied to a course, list it here","title":"Event","type":"string"},"fee_id":{"description":"The course registration fee","title":"Fee","type":"string"},"id":{"description":"The unique, string identifier of this course offering","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"instructor_id":{"description":"The course instructor","title":"Instructor","type":"string"},"meeting_url":{"description":"The URL of the meeting","title":"Meeting Url","type":"string"},"name":{"description":"The name of the course offering","title":"Name","type":"string"},"program_ids":{"description":"The programs for which this course is relevant","items":{"type":"string"},"title":"Programs","type":"array"},"short_description":{"description":"Any short descriptive information to display in the directory","title":"Short Description","type":"string"},"sold_out":{"description":"This offering is sold out","title":"Sold Out","type":"boolean"},"start_date":{"description":"The date of the course","format":"date-time","title":"Start Date","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"training_location_id":{"description":"The training location","title":"Training Location","type":"string"},"training_provider_id":{"description":"The training provider administering the course","title":"Training Provider","type":"string"},"type":{"enum":["in person","on-demand","virtual"],"title":"Type","type":"string"},"webinar_integration_options":{"additionalProperties":false,"properties":{"meeting_id":{"description":"The meeting id","oneOf":[{"x-required":true}],"title":"Meeting","type":"string"},"type":{"description":"The video conference type ","enum":["meeting","webinar"],"title":"Type","type":"string"},"webinar_account_id":{"description":"The account ID","title":"Webinar Account","type":"string"},"webinar_id":{"description":"The webinar id","oneOf":[{"x-required":true}],"title":"Webinar","type":"string"},"webinar_service":{"description":"The integration service","enum":["integrations-zoom-accounts"],"title":"Webinar Service","type":"string"}},"required":["webinar_account_id","webinar_service"],"title":"Webinar Integration Options","type":"object"},"webinar_url":{"description":"The URL of the webinar","title":"Webinar Url","type":"string"}},"required":["capacity_options","course_id","end_date","id","name","start_date","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","training_location_id","training_provider_id","webinar_integration_options"],"type":"object"}},"components/schemas/DescribeCourseOfferingsResponse":{"id":"components/schemas/DescribeCourseOfferingsResponse","kind":"json-schema","title":"DescribeCourseOfferingsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/DescribeCourseOfferingResult"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/DescribeSavedQueriesResponse":{"id":"components/schemas/DescribeSavedQueriesResponse","kind":"json-schema","title":"DescribeSavedQueriesResponse","data":{"additionalProperties":false,"properties":{"queries":{"items":{"additionalProperties":false,"properties":{"description":{"title":"Description","type":"string"},"id":{"title":"ID","type":"string"},"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/Directory":{"id":"components/schemas/Directory","kind":"json-schema","title":"Directory","data":{"additionalProperties":false,"properties":{"additional_fields":{"description":"These are additional fields that should be in the directory query, which will be available in the search results","items":{"type":"string"},"title":"Additional Fields","type":"array"},"comment_options":{"additionalProperties":false,"properties":{"comments_header_text":{"description":"The text shown in the header of the comments section","title":"Comments Header Text","type":"string"},"comments_instructions":{"description":"Instructions given to those submitting comments","title":"Comments Instructions","type":"string"},"comments_placeholder_text":{"description":"The placeholder text for the comments","title":"Comments Placeholder Text","type":"string"},"enable_ratings":{"description":"If set, users can rate","title":"Enable Ratings","type":"boolean"},"hide_submitter_name":{"description":"If set, comment submitter names are hidden from the directory","title":"Hide Submitter Name","type":"boolean"},"leave_comment_button_text":{"description":"The button text for Leave Comment","title":"Leave Comment Button Text","type":"string"},"max_rating":{"description":"The maximum rating","format":"float","maximum":10,"minimum":1,"oneOf":[{"x-required":true}],"title":"Max Rating","type":"number"},"no_comments_text":{"description":"The text shown when no comments are present","title":"No Comments Text","type":"string"},"rating_label":{"description":"The label for the rating","title":"Rating Label","type":"string"},"save_comment_button":{"description":"The button text for saving a comment","title":"Save Comment Button","type":"string"}},"title":"Comment Options","type":"object"},"custom_directory_entry_template":{"title":"Custom Directory Entry Template","type":"string"},"custom_search_results_template":{"title":"Custom Search Results Template","type":"string"},"custom_sort_fields":{"items":{"additionalProperties":false,"properties":{"descending":{"title":"Descending","type":"boolean"},"name":{"title":"Name","type":"string"}},"required":["name"],"type":"object"},"minItems":1,"type":"array"},"directory_entry_mode":{"enum":["custom","do not show","use default"],"title":"Directory Entry Mode","type":"string"},"display_mode":{"description":"The way that the directory should be displayed","enum":["list","search"],"title":"Display Mode","type":"string"},"eligibility_criteria":{"additionalProperties":false,"description":"The criteria to use","properties":{"advanced_rule_error_message":{"description":"The error message to show when the advanced rule fails","title":"Advanced Rule Error Message","type":"string"},"advanced_rules":{"title":"Advanced Rules","type":"object"},"age_restrictions":{"additionalProperties":false,"properties":{"maximum_age":{"description":"The maximum age of the contact","format":"float","title":"Maximum Age","type":"number"},"minimum_age":{"description":"The minimum age of the contact","format":"float","title":"Minimum Age","type":"number"}},"title":"Age Restrictions","type":"object"},"award_options":{"additionalProperties":false,"properties":{"award_ids":{"items":{"type":"string"},"title":"Awards","type":"array"},"award_type_ids":{"items":{"type":"string"},"title":"Award Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Award Options","type":"object"},"award_recipients":{"description":"If set, only people who have received awards","title":"Award Recipients","type":"boolean"},"by_location":{"description":"If true, then filter by location","title":"By Location","type":"boolean"},"certificants":{"description":"If set, only people with specific certifications","title":"Certificants","type":"boolean"},"certification_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"program_ids":{"items":{"type":"string"},"title":"Programs","type":"array"}},"title":"Certification Options","type":"object"},"committee_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"committee_ids":{"items":{"type":"string"},"title":"Committees","type":"array"},"committee_position_ids":{"items":{"type":"string"},"title":"Committee Positions","type":"array"},"committee_type_ids":{"items":{"type":"string"},"title":"Committee Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Committee Member Options","type":"object"},"committee_members":{"description":"If set, active members who belong to a committee can purchase","title":"Committee Members","type":"boolean"},"custom_logic_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Logic Options","type":"object"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"donor_options":{"additionalProperties":false,"properties":{"donor_club_ids":{"items":{"type":"string"},"title":"Donor Clubs","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Donor Options","type":"object"},"donors":{"description":"If true, only donors","title":"Donors","type":"boolean"},"enable_advanced_rules":{"description":"Enable advanced JSON rules","title":"Enable Advanced Rules","type":"boolean"},"enable_age_restrictions":{"description":"Age registrations","title":"Enable Age Restrictions","type":"boolean"},"enable_custom_logic":{"description":"If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion","title":"Enable Custom Logic","type":"boolean"},"enable_entitlement_restrictions":{"description":"If set, then you must have certain entitlements","title":"Enable Entitlement Restrictions","type":"boolean"},"enable_expression":{"description":"Whether or not to enable an expression for evaluation","title":"Enable Expression","type":"boolean"},"enable_organization_restrictions":{"description":"If set, you can restrict organizations","title":"Enable Organization Restrictions","type":"boolean"},"enable_status_restriction":{"description":"If set, you can restrict by status","title":"Enable Status Restriction","type":"boolean"},"entitlement_restrictions":{"items":{"additionalProperties":false,"properties":{"quantity":{"description":"The quantity you must have","format":"float","title":"Quantity","type":"number"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["type_id"],"type":"object"},"type":"array"},"event_registration_options":{"additionalProperties":false,"properties":{"event_ids":{"items":{"type":"string"},"title":"Events","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"registration_category_ids":{"items":{"type":"string"},"title":"Registration Categories","type":"array"}},"title":"Event Registration Options","type":"object"},"event_registrations":{"description":"If set, only people who have registered for events","title":"Event Registrations","type":"boolean"},"expression":{"description":"The expression","title":"Expression","type":"string"},"expression_error_message":{"description":"The error message to show when the expression fails","title":"Expression Error Message","type":"string"},"location":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"countries":{"description":"Countries","items":{"type":"string"},"title":"Countries","type":"array"},"negate_logic":{"description":"If true, the logic in this section is negated; so NOT from these places","title":"Negate Logic","type":"boolean"}},"title":"Location","type":"object"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_ids":{"items":{"type":"string"},"title":"Chapters","type":"array"},"chapter_type_ids":{"items":{"type":"string"},"title":"Chapter Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Chapter Member Options","type":"object"},"chapter_members":{"description":"If set, active members who belong to a chapter can purchase","title":"Chapter Members","type":"boolean"},"member_package_ids":{"description":"The member package","items":{"type":"string"},"title":"Member Packages","type":"array"},"member_status_reason_ids":{"items":{"type":"string"},"title":"Member Status Reasons","type":"array"},"member_statuses":{"items":{"enum":["active","inactive","suspended"],"type":"string"},"title":"Member Statuses","type":"array"},"member_type_ids":{"description":"The member types","items":{"type":"string"},"title":"Member Types","type":"array"},"section_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"section_ids":{"items":{"type":"string"},"title":"Sections","type":"array"},"section_type_ids":{"items":{"type":"string"},"title":"Section Types","type":"array"}},"title":"Section Member Options","type":"object"},"section_members":{"description":"If set, active members who belong to a section can purchase","title":"Section Members","type":"boolean"}},"title":"Member Options","type":"object"},"members":{"description":"If set, active members can purchase this","title":"Members","type":"boolean"},"non_members":{"description":"If set, only nonmembers can purchase","title":"Non Members","type":"boolean"},"organization_restrictions":{"additionalProperties":false,"properties":{"contact_role_ids":{"items":{"type":"string"},"title":"Contact Roles","type":"array"},"organization_type_ids":{"items":{"type":"string"},"title":"Organization Types","type":"array"}},"title":"Organization Restrictions","type":"object"},"status_restrictions":{"description":"The statuses","items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Restrictions","type":"array"},"use_organization_for_eligibility":{"description":"If checked, a person's organization is used to check for eligibility, rather than the person themselves","title":"Use Organization For Eligibility","type":"boolean"}},"title":"Eligibility Criteria","type":"object"},"enable_comments":{"description":"If set, users are allowed to submit comments in the directory","title":"Enable Comments","type":"boolean"},"enable_custom_search_results_template":{"description":"If set, a custom search results template is displayed","title":"Enable Custom Search Results Template","type":"boolean"},"enable_custom_sorting":{"description":"If true, the directory results will be sorted differently that the query","title":"Enable Custom Sorting","type":"boolean"},"enable_eligibility_criteria":{"description":"If set, only certain people can access this directory","title":"Enable Eligibility Criteria","type":"boolean"},"enable_messaging":{"description":"When true, users are able to contact other users through the directory","title":"Enable Messaging","type":"boolean"},"enable_query_expression_filter":{"description":"If set to true, an expression can be used to further filter the query","title":"Enable Query Expression Filter","type":"boolean"},"enable_query_filter":{"description":"If set to true, the directory can display a subset of records based on the provided filter. If false, the default filter is used","title":"Enable Query Filter","type":"boolean"},"enable_radius_search":{"description":"If true, the user can search across zip code radius","title":"Enable Radius Search","type":"boolean"},"id":{"description":"The unique, string identifier of this directory","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this directory is active","title":"Is Active","type":"boolean"},"is_public":{"description":"If true, this is a public directory that can be accessed without security","title":"Is Public","type":"boolean"},"name":{"description":"The name of the directory","title":"Name","type":"string"},"page_size":{"description":"The page size, used for server side page and to combat scraping attacks","format":"float","maximum":50,"minimum":1,"title":"Page Size","type":"number"},"query_filter_expression":{"description":"The expression to use to filter the directory","title":"Query Filter Expression","type":"string"},"query_filter_rules":{"title":"Query Filter Rules","type":"object"},"radius_search_options":{"additionalProperties":false,"properties":{"postal_code_field":{"description":"The field to use as the basis for a radius search","title":"Postal Code Field","type":"string"},"radius_options":{"description":"The various default radius that can be selected","items":{"format":"float","type":"number"},"minItems":1,"title":"Radius Options","type":"array"}},"required":["postal_code_field","radius_options"],"title":"Radius Search Options","type":"object"},"refresh_period":{"description":"The period of time (in minutes) after which the directory should refresh it self","format":"float","minimum":5,"title":"Refresh Period","type":"number"},"searchable_fields":{"description":"The fields in the directory that are displayed as search criteria","items":{"additionalProperties":false,"properties":{"group_name":{"description":"The group/display label","title":"Group Name","type":"string"},"label":{"description":"The label that the field should be displayed","title":"Label","type":"string"},"name":{"description":"The field name","title":"Name","type":"string"}},"required":["name"],"type":"object"},"minItems":1,"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["custom_directory_entry_template","custom_search_results_template","custom_sort_fields","eligibility_criteria","id","name","query_filter_expression","radius_search_options","searchable_fields","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/DirectoryMessage":{"id":"components/schemas/DirectoryMessage","kind":"json-schema","title":"DirectoryMessage","data":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"type":"object"}},"components/schemas/DirectorySearchCriteria":{"id":"components/schemas/DirectorySearchCriteria","kind":"json-schema","title":"DirectorySearchCriteria","data":{"additionalProperties":false,"properties":{"criteria":{"title":"Criteria","type":"object"},"page":{"description":"The page being requested","format":"float","title":"Page","type":"number"},"radius_search":{"additionalProperties":false,"properties":{"postal_code":{"title":"Postal Code","type":"string"},"radius":{"format":"float","minimum":1,"title":"Radius","type":"number"}},"required":["postal_code","radius"],"title":"Radius Search","type":"object"}},"type":"object"}},"components/schemas/DirectorySearchResults":{"id":"components/schemas/DirectorySearchResults","kind":"json-schema","title":"DirectorySearchResults","data":{"additionalProperties":false,"properties":{"fields":{"items":{"additionalProperties":false,"properties":{"label":{"title":"Label","type":"string"},"name":{"title":"Name","type":"string"},"type":{"title":"Type","type":"string"}},"type":"object"},"type":"array"},"query":{"additionalProperties":false,"properties":{},"title":"Query","type":"object"},"rows":{"items":{"type":"object"},"type":"array"},"sql":{"title":"Sql","type":"string"},"target_service":{"description":"The target service of the query","title":"Target Service","type":"string"},"totalNumberOfRows":{"format":"float","title":"Totalnumberofrows","type":"number"}},"type":"object"}},"components/schemas/EligibleExamRegProcessesResult":{"id":"components/schemas/EligibleExamRegProcessesResult","kind":"json-schema","title":"EligibleExamRegProcessesResult","data":{"additionalProperties":false,"properties":{"last_registration":{"additionalProperties":false,"properties":{"course_registration_id":{"description":"The course registration this exam is tied to","title":"Course Registration","type":"string"},"date":{"description":"The date/time of the exam","format":"date-time","title":"Date","type":"string"},"email_address":{"title":"Email Address","type":"string"},"exam_id":{"description":"The exam being taken","title":"Exam","type":"string"},"exam_offering_id":{"description":"The scheduled exam","title":"Exam Offering","type":"string"},"first_name":{"title":"First Name","type":"string"},"id":{"description":"The unique, string identifier of this exam registration","title":"ID","type":"string"},"last_name":{"title":"Last Name","type":"string"},"location":{"enum":["testing facility","training location"],"title":"Location","type":"string"},"name":{"title":"Name","type":"string"},"notes":{"description":"notes","title":"Notes","type":"string"},"number":{"description":"The registration number","format":"float","title":"Number","type":"number"},"order_id":{"description":"The order","title":"Order","type":"string"},"order_line_item_id":{"description":"The order line item","title":"Order Line Item","type":"string"},"process_id":{"description":"The registration process used to create the registration","title":"Process","type":"string"},"score":{"description":"The score","format":"float","title":"Score","type":"number"},"status":{"enum":["cancelled","draft","failed","no show","passed","registered"],"title":"Status","type":"string"},"student_id":{"description":"The individual taking the exam","title":"Student","type":"string"},"testing_facility_id":{"description":"The exam testing site","title":"Testing Facility","type":"string"},"training_location_id":{"description":"The training facility","title":"Training Location","type":"string"},"training_provider_id":{"description":"The training facility","title":"Training Provider","type":"string"}},"title":"Last Registration","type":"object"},"processes":{"items":{"additionalProperties":false,"properties":{"available_in_portal":{"description":"If true, not available in the portal","title":"Available In Portal","type":"boolean"},"available_to_training_providers":{"description":"If true, this process is available to training providers","title":"Available To Training Providers","type":"boolean"},"checkout_settings":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bank_account_id":{"description":"The default bank account that the store should use to receive payments","title":"Bank Account","type":"string"},"bill_my_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Organization Options","type":"object"},"bill_my_parent_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Parent Organization Options","type":"object"},"business_unit_id":{"description":"The business unit of the store","title":"Business Unit","type":"string"},"cancellation_fee_product_id":{"description":"The ID of the product used for cancellation fees","title":"Cancellation Fee Product","type":"string"},"checkout_donation_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"simple_checkout_donation_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"allow_user_to_specify_custom_amount":{"description":"If set, the user can specify their own custom donation","title":"Allow User To Specify Custom Amount","type":"boolean"},"donation_ask_text":{"description":"The text shown to the user when making the donation","title":"Donation Ask Text","type":"string"},"donation_denominations":{"items":{"format":"double","type":"number"},"title":"Donation Denominations","type":"array"},"donation_information":{"description":"Additional information about the donation","title":"Donation Information","type":"string"},"donation_product_id":{"description":"The misc product that should be used","title":"Donation Product","type":"string"},"override_donation_denominations":{"description":"If set, donation denominations are specified here and the defaults are not used","title":"Override Donation Denominations","type":"boolean"},"suggested_donation":{"description":"A suggested donation","format":"double","title":"Suggested Donation","type":"number"}},"required":["donation_product_id"],"title":"Simple Checkout Donation Options","type":"object"},"type":{"enum":["simple"],"title":"Type","type":"string"}},"title":"Checkout Donation Options","type":"object"},"credit_card_minimum_range_end":{"description":"If set, the maximum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range End","type":"number"},"credit_card_minimum_range_start":{"description":"If set, the minimum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range Start","type":"number"},"credit_card_mode":{"description":"Determines whether or not credit cards are accepted","enum":["disabled","enabled","range"],"title":"Credit Card Mode","type":"string"},"credit_card_processing_fee_mode":{"description":"Determines how credit card processing fees should be handled","enum":["charge","do not charge","prompt user"],"title":"Credit Card Processing Fee Mode","type":"string"},"credit_card_processing_fee_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"fee_percentage":{"description":"The fee percentage to charge for credit card processing ","format":"float","title":"Fee Percentage","type":"number"},"maximum_fee":{"description":"The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged","format":"float","title":"Maximum Fee","type":"number"},"minimum_fee":{"description":"The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged","format":"float","title":"Minimum Fee","type":"number"},"product_id":{"description":"The misc product to use for the credit card processing","title":"Product","type":"string"},"prompt_sub_text":{"description":"Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Sub Text","type":"string"},"prompt_text":{"description":"The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Text","type":"string"}},"required":["fee_percentage","product_id"],"title":"Credit Card Processing Fee Options","type":"object"},"disable_electronic_payment_vaulting":{"description":"If set, in the portal people are not allowed to save credit cards","title":"Disable Electronic Payment Vaulting","type":"boolean"},"enable_bill_my_organization":{"description":"If set, the user has the option to bill their organization","title":"Enable Bill My Organization","type":"boolean"},"enable_bill_my_parent_organization":{"description":"If set, the user has the option to bill their organization's parent organization","title":"Enable Bill My Parent Organization","type":"boolean"},"enable_donations_at_checkout":{"description":"If selected, users will be prompted to make a donation upon checking out","title":"Enable Donations At Checkout","type":"boolean"},"enable_electronic_checks":{"description":"If set, electronic checks are allowed","title":"Enable Electronic Checks","type":"boolean"},"enable_pay_later":{"description":"If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed","title":"Enable Pay Later","type":"boolean"},"enable_payroll_deduction":{"description":"If set, payroll deduction is allowed","title":"Enable Payroll Deduction","type":"boolean"},"enable_split_payments":{"description":"If set, users are allowed to split payments","title":"Enable Split Payments","type":"boolean"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"oneOf":[{"x-required":true}],"type":"array"},"invoice_payment_terms_id":{"description":"The payment terms for invoices; if left blank, default is used","title":"Invoice Payment Terms","type":"string"},"invoice_template_id":{"description":"The template to use for invoices created during this process","title":"Invoice Template","type":"string"},"merchant_account_id":{"description":"The merchant account that the store should use to receive payments","title":"Merchant Account","type":"string"},"pay_later_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Pay Later Options","type":"object"},"restocking_fee_product_id":{"description":"The ID of the product used for restocking fees","title":"Restocking Fee Product","type":"string"},"special_instructions":{"description":"Instructions shown to the user","title":"Special Instructions","type":"string"},"use_pro_forma_invoices":{"description":"Whether to use pro forma invoices when user elects to pay later","title":"Use Pro Forma Invoices","type":"boolean"}},"required":["bank_account_id","business_unit_id","merchant_account_id"],"title":"Checkout Settings","type":"object"},"confirmation_email":{"additionalProperties":false,"description":"Email to send once the registration is activated","oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Confirmation Email","type":"object"},"contact_form_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"contact_form_id":{"description":"The default contact form to present to the user to verify the contact info before proceeding","pattern":"^rolodex-contacts__.*","title":"Contact Form","type":"string"},"html":{"description":"Text to show on the top of the form","title":"Html","type":"string"}},"required":["contact_form_id"],"title":"Contact Form Options","type":"object"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"A description of the process to help the user understand whether to choose","title":"Description","type":"string"},"display_in_portal_as":{"description":"How to display in portal","title":"Display In Portal As","type":"string"},"display_order":{"description":"The display order","format":"float","title":"Display Order","type":"number"},"enable_confirmation_email":{"description":"Whether or not to send an email when the registration is processed","title":"Enable Confirmation Email","type":"boolean"},"exam_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Exams","type":"array"},"form_id":{"description":"The default application form for this process","pattern":"^certifications-exam-registrations__.*","title":"Form","type":"string"},"id":{"description":"The unique, string identifier of this exam reg process","oneOf":[{"x-required":true}],"pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this exam reg process is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the exam reg process","title":"Name","type":"string"},"override_checkout_settings":{"description":"Whether or not to override POC settings","title":"Override Checkout Settings","type":"boolean"},"restrict_exams":{"description":"Whether this is restricted to only certain exams","title":"Restrict Exams","type":"boolean"},"show_contact_form":{"description":"Whether or not to show a contact form","title":"Show Contact Form","type":"boolean"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","oneOf":[{"x-required":true}],"title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","oneOf":[{"x-required":true}],"title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","oneOf":[{"x-required":true}],"title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","oneOf":[{"x-required":true}],"title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"enum":["register","retest"],"title":"Type","type":"string"}},"required":["name","type"],"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/Exam":{"id":"components/schemas/Exam","kind":"json-schema","title":"Exam","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"A description to be displayed on the portal","title":"Description","type":"string"},"fail_letter_id":{"description":"The exam notice to send when someone has passed this exam","title":"Fail Letter","type":"string"},"id":{"description":"The unique, string identifier of this exam","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this exam is active","title":"Is Active","type":"boolean"},"maximum_retest_period":{"description":"The time at which retesting is no longer possible","format":"float","title":"Maximum Retest Period","type":"number"},"minimum_retest_period":{"description":"The minimum number of days between exam testing","format":"float","title":"Minimum Retest Period","type":"number"},"name":{"description":"The name of the exam","title":"Name","type":"string"},"pass_letter_id":{"description":"The exam notice to send when someone has passed this exam","title":"Pass Letter","type":"string"},"passing_score":{"description":"The score threshold for passing the exam","format":"float","title":"Passing Score","type":"number"},"program_ids":{"description":"The programs for which this exam is relevant","items":{"type":"string"},"title":"Programs","type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"universal_shopping_cart_image_uri":{"description":"The image to display for this course when it is in the online store","title":"Universal Shopping Cart Image Uri","type":"string"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ExamFee":{"id":"components/schemas/ExamFee","kind":"json-schema","title":"ExamFee","data":{"additionalProperties":false,"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bulk_pricing_rules":{"items":{"additionalProperties":false,"properties":{"discount_amount":{"description":"The percentage/flat rate","format":"float","minimum":0,"title":"Discount Amount","type":"number"},"discount_type":{"description":"The type of discount rule","enum":["flat rate","percentage"],"title":"Discount Type","type":"string"},"ending_range":{"description":"The ending range of the rule","minimum":0,"title":"Ending Range","type":"integer"},"starting_range":{"description":"The starting range of the rule","minimum":0,"title":"Starting Range","type":"integer"}},"required":["discount_amount","discount_type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products":{"items":{"additionalProperties":false,"properties":{"member_price":{"description":"The member price","format":"double","title":"Member Price","type":"number"},"price":{"description":"The price to bundle","format":"double","title":"Price","type":"number"},"product_id":{"description":"The product ID","title":"Product","type":"string"},"product_type":{"description":"The product type","title":"Product Type","type":"string"},"quantity":{"description":"The quantity to bundle","title":"Quantity","type":"integer"},"type":{"enum":["bundled product","inline bundled product"],"title":"Type","type":"string"}},"required":["product_id","product_type","quantity","type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products_inventory_handling":{"description":"Whether to track inventory for the entire bundle, or for each product separately","enum":["bundle","each product"],"title":"Bundled Products Inventory Handling","type":"string"},"business_unit_id":{"description":"The business unit of the product","title":"Business Unit","type":"string"},"cancellation_fee":{"description":"Cancellation fees associated with this product","format":"double","title":"Cancellation Fee","type":"number"},"commerce_entitlements_to_create":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"quantity":{"description":"The quantity","format":"float","title":"Quantity","type":"number"},"relative_expiration_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["expiration_type","type_id"],"type":"object"},"type":"array"},"coupon_codes":{"items":{"additionalProperties":false,"properties":{"coupon_code_generation_process_id":{"description":"The process by which the coupons are generated","title":"Coupon Code Generation Process","type":"string"},"coupon_code_type":{"enum":["multi use","single use"],"title":"Coupon Code Type","type":"string"},"coupon_id":{"title":"Coupon","type":"string"},"coupon_type":{"title":"Coupon Type","type":"string"},"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"maximum_number_of_total_uses":{"description":"The maximum number of total uses","minimum":1,"oneOf":[{"enum":[1],"x-required":true}],"title":"Maximum Number Of Total Uses","type":"integer"},"maximum_number_of_uses_per_customer":{"description":"The maximum number of total uses for a given customer","minimum":1,"oneOf":[{"enum":[1],"x-required":true}],"title":"Maximum Number Of Uses Per Customer","type":"integer"},"quantity":{"description":"The number of coupons to generate","maximum":250,"title":"Quantity","type":"integer"},"relative_expiration_date":{"additionalProperties":false,"description":"Expiration date relative to purchase","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"},"restrict_to_contact":{"description":"If true, the code generated is restricted to the contact who made the purchase","title":"Restrict To Contact","type":"boolean"},"restrict_to_organization":{"description":"If true, the code generated is restricted to the organization made the purchase","title":"Restrict To Organization","type":"boolean"}},"required":["coupon_code_generation_process_id","coupon_code_type","coupon_id","coupon_type","quantity"],"type":"object"},"minItems":1,"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"custom_pricing_options":{"additionalProperties":false,"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Pricing Options","type":"object"},"document_entitlements_to_create":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"file_cabinet_id":{"description":"The file cabinet","title":"File Cabinet","type":"string"},"item_id":{"description":"The item","title":"Item","type":"string"},"library_path":{"description":"The optional path that items will be mounted onto the digital library","title":"Library Path","type":"string"},"relative_expiration_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"}},"required":["expiration_type","file_cabinet_id"],"type":"object"},"type":"array"},"enable_bulk_pricing":{"description":"Whether or not bulk pricing is enabled","title":"Enable Bulk Pricing","type":"boolean"},"enable_bundled_products":{"description":"Whether to enable bundled products","title":"Enable Bundled Products","type":"boolean"},"enable_cancellation_fees":{"description":"Whether or not cancellation fees are applicable","title":"Enable Cancellation Fees","type":"boolean"},"enable_commerce_entitlement_creation":{"description":"If set, document entitlements will be created to access folders or documents","title":"Enable Commerce Entitlement Creation","type":"boolean"},"enable_coupon_code_generation":{"description":"If true, purchasing this product will generate coupons","title":"Enable Coupon Code Generation","type":"boolean"},"enable_custom_pricing":{"description":"If set, the order engine will call out to a custom lambda function for custom/complex pricing","title":"Enable Custom Pricing","type":"boolean"},"enable_document_entitlement_creation":{"description":"If set, document entitlements will be created to access folders or documents","title":"Enable Document Entitlement Creation","type":"boolean"},"enable_product_confirmation_email":{"description":"If enabled, a custom email goes out whenever this product is ordered","title":"Enable Product Confirmation Email","type":"boolean"},"enable_purchase_limits":{"description":"If true, purchase limits are in place for this product","title":"Enable Purchase Limits","type":"boolean"},"enable_purchasing_eligibility":{"description":"If set, purchases of this merchandise are restricted","title":"Enable Purchasing Eligibility","type":"boolean"},"enable_special_prices":{"description":"Whether to enable special pricing logic","title":"Enable Special Prices","type":"boolean"},"enable_task_generation":{"description":"If set, tasks will be generated","title":"Enable Task Generation","type":"boolean"},"exam_id":{"description":"The exam","title":"Exam","type":"string"},"foreign_currency_prices":{"items":{"additionalProperties":false,"properties":{"cancellation_fee":{"description":"The cancellation fee of the product for this currency","format":"double","title":"Cancellation Fee","type":"number"},"currency_code":{"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"title":"Currency Code","type":"string"},"member_price":{"description":"The price of the product for a member","format":"double","title":"Member Price","type":"number"},"mode":{"description":"How this foreign currency should be treated","enum":["calculate price","prohibit purchase","set price"],"title":"Mode","type":"string"},"price":{"description":"The price of the product","format":"double","oneOf":[{"x-required":true}],"title":"Price","type":"number"},"restocking_fee":{"description":"The restocking fee of the product for this currency","format":"double","title":"Restocking Fee","type":"number"}},"required":["currency_code"],"type":"object"},"type":"array"},"hide_from_portal":{"description":"If set, this product should not be shown in the portal","title":"Hide From Portal","type":"boolean"},"id":{"description":"The unique, string identifier of this miscellaneous product","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"type":"array"},"is_active":{"description":"Whether this product is active/used","title":"Is Active","type":"boolean"},"member_price":{"description":"The price of the product for an active member","format":"double","title":"Member Price","type":"number"},"name":{"description":"The name of the miscellaneous product","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"portal_options":{"additionalProperties":false,"properties":{"available_from":{"description":"The date from which this product should be available","format":"date-time","title":"Available From","type":"string"},"available_until":{"description":"The date until which this product should be available","format":"date-time","title":"Available Until","type":"string"}},"title":"Portal Options","type":"object"},"price":{"description":"The price of the product","format":"double","title":"Price","type":"number"},"product_confirmation_email_options":{"additionalProperties":false,"properties":{"product_confirmation_email_id":{"oneOf":[{"x-required":true}],"title":"Product Confirmation Email","type":"string"},"product_specific_email":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Product Specific Email","type":"object"},"type":{"enum":["product specific","shared"],"title":"Type","type":"string"}},"title":"Product Confirmation Email Options","type":"object"},"publish_to_portal":{"description":"Whether or not this product should be available in the portal","title":"Publish To Portal","type":"boolean"},"purchase_limits":{"additionalProperties":false,"properties":{"error_message":{"description":"The error message to show","title":"Error Message","type":"string"},"maximum":{"description":"The maximum","format":"float","title":"Maximum","type":"number"},"relative_time_window":{"additionalProperties":false,"description":"the time window","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Time Window","type":"object"},"time_period":{"enum":["all time","sliding time window"],"title":"Time Period","type":"string"},"type":{"enum":["per customer"],"title":"Type","type":"string"}},"required":["maximum","time_period","type"],"title":"Purchase Limits","type":"object"},"purchasing_eligibility_criteria":{"title":"Purchasing Eligibility Criteria","type":"object"},"special_prices":{"items":{"additionalProperties":false,"properties":{"criteria":{"title":"Criteria","type":"object"},"enable_formula":{"description":"if set, a formula is used to calculate the price. If the formula fails, the price is used","title":"Enable Formula","type":"boolean"},"formula":{"description":"The formula evaluated using the expr-eval npm package","oneOf":[{"x-required":true}],"title":"Formula","type":"string"},"name":{"title":"Name","type":"string"},"price":{"format":"float","title":"Price","type":"number"}},"required":["criteria","price"],"type":"object"},"minItems":1,"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"tasks_to_generate":{"items":{"additionalProperties":false,"properties":{"assignee_type":{"enum":["assignment role","queue","user"],"title":"Assignee Type","type":"string"},"assignment_role_id":{"description":"The assignment role that should receive the ask","oneOf":[{"x-required":true}],"title":"Assignment Role","type":"string"},"description":{"description":"A description","title":"Description","type":"string"},"due_date_type":{"description":"Whether there is a due date","enum":["none","relative date","specific date"],"title":"Due Date Type","type":"string"},"name":{"description":"The name of the task","title":"Name","type":"string"},"notify_assignees":{"description":"Notify assignee when the task is created","title":"Notify Assignees","type":"boolean"},"priority":{"enum":["high","low","normal","urgent"],"title":"Priority","type":"string"},"queue_id":{"description":"The queue that should be assigned the ask","oneOf":[{"x-required":true}],"title":"Queue","type":"string"},"relative_due_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Due Date","type":"object"},"specific_due_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Specific Due Date","type":"string"},"type_id":{"description":"The type of task","title":"Type","type":"string"},"user_id":{"description":"The user that should be assigned the ask","oneOf":[{"x-required":true}],"title":"User","type":"string"}},"required":["assignee_type","due_date_type","name","type_id"],"type":"object"},"type":"array"},"type":{"description":"The product type","enum":["certifications-exam-fees"],"title":"Type","type":"string"}},"required":["bulk_pricing_rules","bundled_products","business_unit_id","coupon_codes","custom_pricing_options","exam_id","id","installment_plan_options","name","price","product_confirmation_email_options","purchase_limits","special_prices","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ExamNotice":{"id":"components/schemas/ExamNotice","kind":"json-schema","title":"ExamNotice","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"email":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"id":{"description":"The unique, string identifier of this exam notice","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this exam notice is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the exam notice","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["email","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ExamOffering":{"id":"components/schemas/ExamOffering","kind":"json-schema","title":"ExamOffering","data":{"additionalProperties":false,"properties":{"additional_location_info":{"description":"Additional location information","title":"Additional Location Info","type":"string"},"address":{"$ref":"#/components/schemas/Address"},"course_offering_id":{"description":"The course offering tied to this exam","title":"Course Offering","type":"string"},"date":{"description":"The date/time of the exam","title":"Date","type":"string"},"description":{"description":"A description for the portal","title":"Description","type":"string"},"eligibility_requirements":{"additionalProperties":false,"description":"The criteria to use","properties":{"advanced_rule_error_message":{"description":"The error message to show when the advanced rule fails","title":"Advanced Rule Error Message","type":"string"},"advanced_rules":{"title":"Advanced Rules","type":"object"},"age_restrictions":{"additionalProperties":false,"properties":{"maximum_age":{"description":"The maximum age of the contact","format":"float","title":"Maximum Age","type":"number"},"minimum_age":{"description":"The minimum age of the contact","format":"float","title":"Minimum Age","type":"number"}},"title":"Age Restrictions","type":"object"},"award_options":{"additionalProperties":false,"properties":{"award_ids":{"items":{"type":"string"},"title":"Awards","type":"array"},"award_type_ids":{"items":{"type":"string"},"title":"Award Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Award Options","type":"object"},"award_recipients":{"description":"If set, only people who have received awards","title":"Award Recipients","type":"boolean"},"by_location":{"description":"If true, then filter by location","title":"By Location","type":"boolean"},"certificants":{"description":"If set, only people with specific certifications","title":"Certificants","type":"boolean"},"certification_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"program_ids":{"items":{"type":"string"},"title":"Programs","type":"array"}},"title":"Certification Options","type":"object"},"committee_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"committee_ids":{"items":{"type":"string"},"title":"Committees","type":"array"},"committee_position_ids":{"items":{"type":"string"},"title":"Committee Positions","type":"array"},"committee_type_ids":{"items":{"type":"string"},"title":"Committee Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Committee Member Options","type":"object"},"committee_members":{"description":"If set, active members who belong to a committee can purchase","title":"Committee Members","type":"boolean"},"custom_logic_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Logic Options","type":"object"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"donor_options":{"additionalProperties":false,"properties":{"donor_club_ids":{"items":{"type":"string"},"title":"Donor Clubs","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Donor Options","type":"object"},"donors":{"description":"If true, only donors","title":"Donors","type":"boolean"},"enable_advanced_rules":{"description":"Enable advanced JSON rules","title":"Enable Advanced Rules","type":"boolean"},"enable_age_restrictions":{"description":"Age registrations","title":"Enable Age Restrictions","type":"boolean"},"enable_custom_logic":{"description":"If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion","title":"Enable Custom Logic","type":"boolean"},"enable_entitlement_restrictions":{"description":"If set, then you must have certain entitlements","title":"Enable Entitlement Restrictions","type":"boolean"},"enable_expression":{"description":"Whether or not to enable an expression for evaluation","title":"Enable Expression","type":"boolean"},"enable_organization_restrictions":{"description":"If set, you can restrict organizations","title":"Enable Organization Restrictions","type":"boolean"},"enable_status_restriction":{"description":"If set, you can restrict by status","title":"Enable Status Restriction","type":"boolean"},"entitlement_restrictions":{"items":{"additionalProperties":false,"properties":{"quantity":{"description":"The quantity you must have","format":"float","title":"Quantity","type":"number"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["type_id"],"type":"object"},"type":"array"},"event_registration_options":{"additionalProperties":false,"properties":{"event_ids":{"items":{"type":"string"},"title":"Events","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"registration_category_ids":{"items":{"type":"string"},"title":"Registration Categories","type":"array"}},"title":"Event Registration Options","type":"object"},"event_registrations":{"description":"If set, only people who have registered for events","title":"Event Registrations","type":"boolean"},"expression":{"description":"The expression","title":"Expression","type":"string"},"expression_error_message":{"description":"The error message to show when the expression fails","title":"Expression Error Message","type":"string"},"location":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"countries":{"description":"Countries","items":{"type":"string"},"title":"Countries","type":"array"},"negate_logic":{"description":"If true, the logic in this section is negated; so NOT from these places","title":"Negate Logic","type":"boolean"}},"title":"Location","type":"object"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_ids":{"items":{"type":"string"},"title":"Chapters","type":"array"},"chapter_type_ids":{"items":{"type":"string"},"title":"Chapter Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Chapter Member Options","type":"object"},"chapter_members":{"description":"If set, active members who belong to a chapter can purchase","title":"Chapter Members","type":"boolean"},"member_package_ids":{"description":"The member package","items":{"type":"string"},"title":"Member Packages","type":"array"},"member_status_reason_ids":{"items":{"type":"string"},"title":"Member Status Reasons","type":"array"},"member_statuses":{"items":{"enum":["active","inactive","suspended"],"type":"string"},"title":"Member Statuses","type":"array"},"member_type_ids":{"description":"The member types","items":{"type":"string"},"title":"Member Types","type":"array"},"section_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"section_ids":{"items":{"type":"string"},"title":"Sections","type":"array"},"section_type_ids":{"items":{"type":"string"},"title":"Section Types","type":"array"}},"title":"Section Member Options","type":"object"},"section_members":{"description":"If set, active members who belong to a section can purchase","title":"Section Members","type":"boolean"}},"title":"Member Options","type":"object"},"members":{"description":"If set, active members can purchase this","title":"Members","type":"boolean"},"non_members":{"description":"If set, only nonmembers can purchase","title":"Non Members","type":"boolean"},"organization_restrictions":{"additionalProperties":false,"properties":{"contact_role_ids":{"items":{"type":"string"},"title":"Contact Roles","type":"array"},"organization_type_ids":{"items":{"type":"string"},"title":"Organization Types","type":"array"}},"title":"Organization Restrictions","type":"object"},"status_restrictions":{"description":"The statuses","items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Restrictions","type":"array"},"use_organization_for_eligibility":{"description":"If checked, a person's organization is used to check for eligibility, rather than the person themselves","title":"Use Organization For Eligibility","type":"boolean"}},"title":"Eligibility Requirements","type":"object"},"enable_eligibility_requirements":{"description":"If true, this offering is only available to certain individuals","title":"Enable Eligibility Requirements","type":"boolean"},"end_time":{"description":"The registration date/time","title":"End Time","type":"string"},"exam_id":{"description":"The exam","title":"Exam","type":"string"},"fail_letter_id":{"description":"The exam notice to send when someone has passed this exam; this overrides the letter specified on the exam","title":"Fail Letter","type":"string"},"fee_id":{"description":"The fee for initial testing","title":"Fee","type":"string"},"id":{"description":"The unique, string identifier of this exam offering","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether this exam is active and available","title":"Is Active","type":"boolean"},"location":{"enum":["none","testing facility","training location"],"title":"Location","type":"string"},"name":{"description":"The name of the offering","title":"Name","type":"string"},"notes":{"title":"Notes","type":"string"},"pass_letter_id":{"description":"The exam notice to send when someone has passed this exam; this overrides the letter specified on the exam","title":"Pass Letter","type":"string"},"registration_time":{"description":"The registration date/time","title":"Registration Time","type":"string"},"retest_fee_id":{"description":"The fee for retake/retest","title":"Retest Fee","type":"string"},"start_time":{"description":"The registration date/time","title":"Start Time","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"testing_facility_id":{"description":"The exam testing site","title":"Testing Facility","type":"string"},"training_location_id":{"description":"The training facility","title":"Training Location","type":"string"},"type":{"description":"The type of exam","enum":["live","remote proctor"],"title":"Type","type":"string"}},"required":["date","eligibility_requirements","exam_id","id","location","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","testing_facility_id","training_location_id","type"],"type":"object"}},"components/schemas/ExamOfferingSearchParameters":{"id":"components/schemas/ExamOfferingSearchParameters","kind":"json-schema","title":"ExamOfferingSearchParameters","data":{"additionalProperties":false,"properties":{"country":{"title":"Country","type":"string"},"date":{"items":{"type":"string"},"title":"Date","type":"array"},"exam_id":{"items":{"type":"string"},"title":"Exam","type":"array"},"fee_id":{"items":{"type":"string"},"title":"Fee","type":"array"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"location":{"items":{"type":"string"},"title":"Location","type":"array"},"publish_to_portal":{"items":{"type":"boolean"},"title":"Publish To Portal","type":"array"},"state":{"title":"State","type":"string"},"testing_facility_id":{"items":{"type":"string"},"title":"Testing Facility","type":"array"},"training_location_id":{"items":{"type":"string"},"title":"Training Location","type":"array"}},"type":"object"}},"components/schemas/ExamOfferingSearchResults":{"id":"components/schemas/ExamOfferingSearchResults","kind":"json-schema","title":"ExamOfferingSearchResults","data":{"additionalProperties":false,"properties":{"additional_location_info":{"description":"Additional location information","title":"Additional Location Info","type":"string"},"address":{"$ref":"#/components/schemas/Address"},"course_offering_id":{"description":"The course offering tied to this exam","title":"Course Offering","type":"string"},"date":{"description":"The date/time of the exam","title":"Date","type":"string"},"description":{"description":"A description for the portal","title":"Description","type":"string"},"eligibility_requirements":{"additionalProperties":false,"description":"The criteria to use","properties":{"advanced_rule_error_message":{"description":"The error message to show when the advanced rule fails","title":"Advanced Rule Error Message","type":"string"},"advanced_rules":{"title":"Advanced Rules","type":"object"},"age_restrictions":{"additionalProperties":false,"properties":{"maximum_age":{"description":"The maximum age of the contact","format":"float","title":"Maximum Age","type":"number"},"minimum_age":{"description":"The minimum age of the contact","format":"float","title":"Minimum Age","type":"number"}},"title":"Age Restrictions","type":"object"},"award_options":{"additionalProperties":false,"properties":{"award_ids":{"items":{"type":"string"},"title":"Awards","type":"array"},"award_type_ids":{"items":{"type":"string"},"title":"Award Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Award Options","type":"object"},"award_recipients":{"description":"If set, only people who have received awards","title":"Award Recipients","type":"boolean"},"by_location":{"description":"If true, then filter by location","title":"By Location","type":"boolean"},"certificants":{"description":"If set, only people with specific certifications","title":"Certificants","type":"boolean"},"certification_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"program_ids":{"items":{"type":"string"},"title":"Programs","type":"array"}},"title":"Certification Options","type":"object"},"committee_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"committee_ids":{"items":{"type":"string"},"title":"Committees","type":"array"},"committee_position_ids":{"items":{"type":"string"},"title":"Committee Positions","type":"array"},"committee_type_ids":{"items":{"type":"string"},"title":"Committee Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Committee Member Options","type":"object"},"committee_members":{"description":"If set, active members who belong to a committee can purchase","title":"Committee Members","type":"boolean"},"custom_logic_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Logic Options","type":"object"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"donor_options":{"additionalProperties":false,"properties":{"donor_club_ids":{"items":{"type":"string"},"title":"Donor Clubs","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Donor Options","type":"object"},"donors":{"description":"If true, only donors","title":"Donors","type":"boolean"},"enable_advanced_rules":{"description":"Enable advanced JSON rules","title":"Enable Advanced Rules","type":"boolean"},"enable_age_restrictions":{"description":"Age registrations","title":"Enable Age Restrictions","type":"boolean"},"enable_custom_logic":{"description":"If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion","title":"Enable Custom Logic","type":"boolean"},"enable_entitlement_restrictions":{"description":"If set, then you must have certain entitlements","title":"Enable Entitlement Restrictions","type":"boolean"},"enable_expression":{"description":"Whether or not to enable an expression for evaluation","title":"Enable Expression","type":"boolean"},"enable_organization_restrictions":{"description":"If set, you can restrict organizations","title":"Enable Organization Restrictions","type":"boolean"},"enable_status_restriction":{"description":"If set, you can restrict by status","title":"Enable Status Restriction","type":"boolean"},"entitlement_restrictions":{"items":{"additionalProperties":false,"properties":{"quantity":{"description":"The quantity you must have","format":"float","title":"Quantity","type":"number"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["type_id"],"type":"object"},"type":"array"},"event_registration_options":{"additionalProperties":false,"properties":{"event_ids":{"items":{"type":"string"},"title":"Events","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"registration_category_ids":{"items":{"type":"string"},"title":"Registration Categories","type":"array"}},"title":"Event Registration Options","type":"object"},"event_registrations":{"description":"If set, only people who have registered for events","title":"Event Registrations","type":"boolean"},"expression":{"description":"The expression","title":"Expression","type":"string"},"expression_error_message":{"description":"The error message to show when the expression fails","title":"Expression Error Message","type":"string"},"location":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"countries":{"description":"Countries","items":{"type":"string"},"title":"Countries","type":"array"},"negate_logic":{"description":"If true, the logic in this section is negated; so NOT from these places","title":"Negate Logic","type":"boolean"}},"title":"Location","type":"object"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"chapter_ids":{"items":{"type":"string"},"title":"Chapters","type":"array"},"chapter_type_ids":{"items":{"type":"string"},"title":"Chapter Types","type":"array"},"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"}},"title":"Chapter Member Options","type":"object"},"chapter_members":{"description":"If set, active members who belong to a chapter can purchase","title":"Chapter Members","type":"boolean"},"member_package_ids":{"description":"The member package","items":{"type":"string"},"title":"Member Packages","type":"array"},"member_status_reason_ids":{"items":{"type":"string"},"title":"Member Status Reasons","type":"array"},"member_statuses":{"items":{"enum":["active","inactive","suspended"],"type":"string"},"title":"Member Statuses","type":"array"},"member_type_ids":{"description":"The member types","items":{"type":"string"},"title":"Member Types","type":"array"},"section_member_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"logic_operator":{"enum":["and","not"],"title":"Logic Operator","type":"string"},"section_ids":{"items":{"type":"string"},"title":"Sections","type":"array"},"section_type_ids":{"items":{"type":"string"},"title":"Section Types","type":"array"}},"title":"Section Member Options","type":"object"},"section_members":{"description":"If set, active members who belong to a section can purchase","title":"Section Members","type":"boolean"}},"title":"Member Options","type":"object"},"members":{"description":"If set, active members can purchase this","title":"Members","type":"boolean"},"non_members":{"description":"If set, only nonmembers can purchase","title":"Non Members","type":"boolean"},"organization_restrictions":{"additionalProperties":false,"properties":{"contact_role_ids":{"items":{"type":"string"},"title":"Contact Roles","type":"array"},"organization_type_ids":{"items":{"type":"string"},"title":"Organization Types","type":"array"}},"title":"Organization Restrictions","type":"object"},"status_restrictions":{"description":"The statuses","items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Restrictions","type":"array"},"use_organization_for_eligibility":{"description":"If checked, a person's organization is used to check for eligibility, rather than the person themselves","title":"Use Organization For Eligibility","type":"boolean"}},"title":"Eligibility Requirements","type":"object"},"enable_eligibility_requirements":{"description":"If true, this offering is only available to certain individuals","title":"Enable Eligibility Requirements","type":"boolean"},"end_time":{"description":"The registration date/time","title":"End Time","type":"string"},"exam_id":{"description":"The exam","title":"Exam","type":"string"},"fail_letter_id":{"description":"The exam notice to send when someone has passed this exam; this overrides the letter specified on the exam","title":"Fail Letter","type":"string"},"fee_id":{"description":"The fee for initial testing","title":"Fee","type":"string"},"id":{"description":"The unique, string identifier of this exam offering","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether this exam is active and available","title":"Is Active","type":"boolean"},"location":{"enum":["none","testing facility","training location"],"title":"Location","type":"string"},"name":{"description":"The name of the offering","title":"Name","type":"string"},"notes":{"title":"Notes","type":"string"},"pass_letter_id":{"description":"The exam notice to send when someone has passed this exam; this overrides the letter specified on the exam","title":"Pass Letter","type":"string"},"registration_time":{"description":"The registration date/time","title":"Registration Time","type":"string"},"retest_fee_id":{"description":"The fee for retake/retest","title":"Retest Fee","type":"string"},"start_time":{"description":"The registration date/time","title":"Start Time","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"testing_facility_id":{"description":"The exam testing site","title":"Testing Facility","type":"string"},"training_location_id":{"description":"The training facility","title":"Training Location","type":"string"},"type":{"description":"The type of exam","enum":["live","remote proctor"],"title":"Type","type":"string"}},"required":["date","eligibility_requirements","exam_id","id","location","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","testing_facility_id","training_location_id","type"],"type":"object"}},"components/schemas/ExamRegProcess":{"id":"components/schemas/ExamRegProcess","kind":"json-schema","title":"ExamRegProcess","data":{"additionalProperties":false,"properties":{"available_in_portal":{"description":"If true, not available in the portal","title":"Available In Portal","type":"boolean"},"available_to_training_providers":{"description":"If true, this process is available to training providers","title":"Available To Training Providers","type":"boolean"},"checkout_settings":{"additionalProperties":false,"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bank_account_id":{"description":"The default bank account that the store should use to receive payments","title":"Bank Account","type":"string"},"bill_my_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Organization Options","type":"object"},"bill_my_parent_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Parent Organization Options","type":"object"},"business_unit_id":{"description":"The business unit of the store","title":"Business Unit","type":"string"},"cancellation_fee_product_id":{"description":"The ID of the product used for cancellation fees","title":"Cancellation Fee Product","type":"string"},"checkout_donation_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"simple_checkout_donation_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"allow_user_to_specify_custom_amount":{"description":"If set, the user can specify their own custom donation","title":"Allow User To Specify Custom Amount","type":"boolean"},"donation_ask_text":{"description":"The text shown to the user when making the donation","title":"Donation Ask Text","type":"string"},"donation_denominations":{"items":{"format":"double","type":"number"},"title":"Donation Denominations","type":"array"},"donation_information":{"description":"Additional information about the donation","title":"Donation Information","type":"string"},"donation_product_id":{"description":"The misc product that should be used","title":"Donation Product","type":"string"},"override_donation_denominations":{"description":"If set, donation denominations are specified here and the defaults are not used","title":"Override Donation Denominations","type":"boolean"},"suggested_donation":{"description":"A suggested donation","format":"double","title":"Suggested Donation","type":"number"}},"required":["donation_product_id"],"title":"Simple Checkout Donation Options","type":"object"},"type":{"enum":["simple"],"title":"Type","type":"string"}},"title":"Checkout Donation Options","type":"object"},"credit_card_minimum_range_end":{"description":"If set, the maximum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range End","type":"number"},"credit_card_minimum_range_start":{"description":"If set, the minimum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range Start","type":"number"},"credit_card_mode":{"description":"Determines whether or not credit cards are accepted","enum":["disabled","enabled","range"],"title":"Credit Card Mode","type":"string"},"credit_card_processing_fee_mode":{"description":"Determines how credit card processing fees should be handled","enum":["charge","do not charge","prompt user"],"title":"Credit Card Processing Fee Mode","type":"string"},"credit_card_processing_fee_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"fee_percentage":{"description":"The fee percentage to charge for credit card processing ","format":"float","title":"Fee Percentage","type":"number"},"maximum_fee":{"description":"The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged","format":"float","title":"Maximum Fee","type":"number"},"minimum_fee":{"description":"The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged","format":"float","title":"Minimum Fee","type":"number"},"product_id":{"description":"The misc product to use for the credit card processing","title":"Product","type":"string"},"prompt_sub_text":{"description":"Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Sub Text","type":"string"},"prompt_text":{"description":"The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Text","type":"string"}},"required":["fee_percentage","product_id"],"title":"Credit Card Processing Fee Options","type":"object"},"disable_electronic_payment_vaulting":{"description":"If set, in the portal people are not allowed to save credit cards","title":"Disable Electronic Payment Vaulting","type":"boolean"},"enable_bill_my_organization":{"description":"If set, the user has the option to bill their organization","title":"Enable Bill My Organization","type":"boolean"},"enable_bill_my_parent_organization":{"description":"If set, the user has the option to bill their organization's parent organization","title":"Enable Bill My Parent Organization","type":"boolean"},"enable_donations_at_checkout":{"description":"If selected, users will be prompted to make a donation upon checking out","title":"Enable Donations At Checkout","type":"boolean"},"enable_electronic_checks":{"description":"If set, electronic checks are allowed","title":"Enable Electronic Checks","type":"boolean"},"enable_pay_later":{"description":"If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed","title":"Enable Pay Later","type":"boolean"},"enable_payroll_deduction":{"description":"If set, payroll deduction is allowed","title":"Enable Payroll Deduction","type":"boolean"},"enable_split_payments":{"description":"If set, users are allowed to split payments","title":"Enable Split Payments","type":"boolean"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"oneOf":[{"x-required":true}],"type":"array"},"invoice_payment_terms_id":{"description":"The payment terms for invoices; if left blank, default is used","title":"Invoice Payment Terms","type":"string"},"invoice_template_id":{"description":"The template to use for invoices created during this process","title":"Invoice Template","type":"string"},"merchant_account_id":{"description":"The merchant account that the store should use to receive payments","title":"Merchant Account","type":"string"},"pay_later_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Pay Later Options","type":"object"},"restocking_fee_product_id":{"description":"The ID of the product used for restocking fees","title":"Restocking Fee Product","type":"string"},"special_instructions":{"description":"Instructions shown to the user","title":"Special Instructions","type":"string"},"use_pro_forma_invoices":{"description":"Whether to use pro forma invoices when user elects to pay later","title":"Use Pro Forma Invoices","type":"boolean"}},"required":["bank_account_id","business_unit_id","merchant_account_id"],"title":"Checkout Settings","type":"object"},"confirmation_email":{"additionalProperties":false,"description":"Email to send once the registration is activated","properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Confirmation Email","type":"object"},"contact_form_options":{"additionalProperties":false,"properties":{"contact_form_id":{"description":"The default contact form to present to the user to verify the contact info before proceeding","pattern":"^rolodex-contacts__.*","title":"Contact Form","type":"string"},"html":{"description":"Text to show on the top of the form","title":"Html","type":"string"}},"required":["contact_form_id"],"title":"Contact Form Options","type":"object"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"A description of the process to help the user understand whether to choose","title":"Description","type":"string"},"display_in_portal_as":{"description":"How to display in portal","title":"Display In Portal As","type":"string"},"display_order":{"description":"The display order","format":"float","title":"Display Order","type":"number"},"enable_confirmation_email":{"description":"Whether or not to send an email when the registration is processed","title":"Enable Confirmation Email","type":"boolean"},"exam_ids":{"items":{"type":"string"},"minItems":1,"title":"Exams","type":"array"},"form_id":{"description":"The default application form for this process","pattern":"^certifications-exam-registrations__.*","title":"Form","type":"string"},"id":{"description":"The unique, string identifier of this exam reg process","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this exam reg process is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the exam reg process","title":"Name","type":"string"},"override_checkout_settings":{"description":"Whether or not to override POC settings","title":"Override Checkout Settings","type":"boolean"},"restrict_exams":{"description":"Whether this is restricted to only certain exams","title":"Restrict Exams","type":"boolean"},"show_contact_form":{"description":"Whether or not to show a contact form","title":"Show Contact Form","type":"boolean"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"enum":["register","retest"],"title":"Type","type":"string"}},"required":["checkout_settings","confirmation_email","contact_form_options","exam_ids","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type"],"type":"object"}},"components/schemas/ExamRegistration":{"id":"components/schemas/ExamRegistration","kind":"json-schema","title":"ExamRegistration","data":{"additionalProperties":false,"properties":{"additional_location_info":{"description":"Additional location information","title":"Additional Location Info","type":"string"},"application_id":{"description":"The certification application to which this registration ","title":"Application","type":"string"},"cancellation_date":{"format":"date-time","title":"Cancellation Date","type":"string"},"city":{"description":"The member city","title":"City","type":"string"},"country":{"description":"The member country","title":"Country","type":"string"},"course_registration_id":{"description":"The course registration this exam is tied to","title":"Course Registration","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date/time of the registration","title":"Date","type":"string"},"email_address":{"description":"The member's email address","title":"Email Address","type":"string"},"exam_date":{"description":"The date/time of the registration","title":"Exam Date","type":"string"},"exam_id":{"description":"The exam being taken","title":"Exam","type":"string"},"exam_offering_id":{"description":"The scheduled exam","title":"Exam Offering","type":"string"},"first_name":{"description":"The member's first name","title":"First Name","type":"string"},"id":{"description":"The unique, string identifier of this exam registration","pattern":"^[\\w-|:]+$","title":"ID","type":"string"},"job_title":{"description":"The member job title","title":"Job Title","type":"string"},"last_name":{"description":"The member's last name","title":"Last Name","type":"string"},"location":{"enum":["none","testing facility","training location"],"title":"Location","type":"string"},"name":{"description":"The member's name","title":"Name","type":"string"},"notes":{"description":"notes","title":"Notes","type":"string"},"notices":{"items":{"additionalProperties":false,"properties":{"date":{"description":"The date the notice was send","format":"date-time","title":"Date","type":"string"},"notice_id":{"description":"The notice","title":"Notice","type":"string"}},"required":["date","notice_id"],"type":"object"},"type":"array"},"number":{"description":"The registration number","format":"float","title":"Number","type":"number"},"order_id":{"description":"The order","title":"Order","type":"string"},"order_line_item_id":{"description":"The order line item","title":"Order Line Item","type":"string"},"process_id":{"description":"The registration process used to create the registration","title":"Process","type":"string"},"retest":{"description":"Whether or not this is a retest","title":"Retest","type":"boolean"},"score":{"description":"The score","format":"float","title":"Score","type":"number"},"scoring_report_uri":{"description":"An image/PDF of the exam scoring report","title":"Scoring Report Uri","type":"string"},"state":{"description":"The state","title":"State","type":"string"},"status":{"enum":["cancelled","draft","failed","no show","passed","registered"],"title":"Status","type":"string"},"student_id":{"description":"The individual taking the exam","title":"Student","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"testing_facility_id":{"description":"The exam testing site","title":"Testing Facility","type":"string"},"training_location_id":{"description":"The training facility","title":"Training Location","type":"string"},"training_provider_billing_date":{"description":"The date this registration was billing to the training provider","title":"Training Provider Billing Date","type":"string"},"training_provider_billing_invoice_id":{"description":"The invoice that was created to bill for this registration","title":"Training Provider Billing Invoice","type":"string"},"training_provider_billing_invoice_line_item_id":{"description":"The invoice that was created to bill for this registration","title":"Training Provider Billing Invoice Line Item","type":"string"},"training_provider_billing_name":{"description":"The training provider name (for billing)","title":"Training Provider Billing Name","type":"string"},"training_provider_billing_status":{"description":"The training provider billing status for this registration","enum":["billed","billing hold","exempt from billing","not yet billed"],"title":"Training Provider Billing Status","type":"string"},"training_provider_id":{"description":"The training facility","title":"Training Provider","type":"string"}},"required":["date","exam_id","exam_offering_id","id","name","student_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ExamRegistrationSearchParameters":{"id":"components/schemas/ExamRegistrationSearchParameters","kind":"json-schema","title":"ExamRegistrationSearchParameters","data":{"additionalProperties":false,"properties":{"city":{"description":"City to search","title":"City","type":"string"},"date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"email_address":{"title":"Email Address","type":"string"},"exam_id":{"items":{"type":"string"},"title":"Exam","type":"array"},"exam_offering_id":{"items":{"type":"string"},"title":"Exam Offering","type":"array"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"job_title":{"title":"Job Title","type":"string"},"location":{"items":{"type":"string"},"title":"Location","type":"array"},"name":{"title":"Name","type":"string"},"score":{"items":{"format":"float","type":"number"},"title":"Score","type":"array"},"state":{"description":"The state","title":"State","type":"string"},"status":{"items":{"type":"string"},"title":"Status","type":"array"},"sys_created_at":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Sys Created At","type":"array"},"testing_facility_id":{"items":{"type":"string"},"title":"Testing Facility","type":"array"},"training_location_id":{"items":{"type":"string"},"title":"Training Location","type":"array"},"training_provider_id":{"items":{"type":"string"},"title":"Training Provider","type":"array"}},"type":"object"}},"components/schemas/ExamRegistrationSearchResults":{"id":"components/schemas/ExamRegistrationSearchResults","kind":"json-schema","title":"ExamRegistrationSearchResults","data":{"additionalProperties":false,"properties":{"additional_location_info":{"description":"Additional location information","title":"Additional Location Info","type":"string"},"application_id":{"description":"The certification application to which this registration ","title":"Application","type":"string"},"cancellation_date":{"format":"date-time","title":"Cancellation Date","type":"string"},"city":{"description":"The member city","title":"City","type":"string"},"country":{"description":"The member country","title":"Country","type":"string"},"course_registration_id":{"description":"The course registration this exam is tied to","title":"Course Registration","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date/time of the registration","title":"Date","type":"string"},"email_address":{"description":"The member's email address","title":"Email Address","type":"string"},"exam_date":{"description":"The date/time of the registration","title":"Exam Date","type":"string"},"exam_id":{"description":"The exam being taken","title":"Exam","type":"string"},"exam_offering_id":{"description":"The scheduled exam","title":"Exam Offering","type":"string"},"first_name":{"description":"The member's first name","title":"First Name","type":"string"},"id":{"description":"The unique, string identifier of this exam registration","pattern":"^[\\w-|:]+$","title":"ID","type":"string"},"job_title":{"description":"The member job title","title":"Job Title","type":"string"},"last_name":{"description":"The member's last name","title":"Last Name","type":"string"},"location":{"enum":["none","testing facility","training location"],"title":"Location","type":"string"},"name":{"description":"The member's name","title":"Name","type":"string"},"notes":{"description":"notes","title":"Notes","type":"string"},"notices":{"items":{"additionalProperties":false,"properties":{"date":{"description":"The date the notice was send","format":"date-time","title":"Date","type":"string"},"notice_id":{"description":"The notice","title":"Notice","type":"string"}},"required":["date","notice_id"],"type":"object"},"type":"array"},"number":{"description":"The registration number","format":"float","title":"Number","type":"number"},"order_id":{"description":"The order","title":"Order","type":"string"},"order_line_item_id":{"description":"The order line item","title":"Order Line Item","type":"string"},"process_id":{"description":"The registration process used to create the registration","title":"Process","type":"string"},"retest":{"description":"Whether or not this is a retest","title":"Retest","type":"boolean"},"score":{"description":"The score","format":"float","title":"Score","type":"number"},"scoring_report_uri":{"description":"An image/PDF of the exam scoring report","title":"Scoring Report Uri","type":"string"},"state":{"description":"The state","title":"State","type":"string"},"status":{"enum":["cancelled","draft","failed","no show","passed","registered"],"title":"Status","type":"string"},"student_id":{"description":"The individual taking the exam","title":"Student","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"testing_facility_id":{"description":"The exam testing site","title":"Testing Facility","type":"string"},"training_location_id":{"description":"The training facility","title":"Training Location","type":"string"},"training_provider_billing_date":{"description":"The date this registration was billing to the training provider","title":"Training Provider Billing Date","type":"string"},"training_provider_billing_invoice_id":{"description":"The invoice that was created to bill for this registration","title":"Training Provider Billing Invoice","type":"string"},"training_provider_billing_invoice_line_item_id":{"description":"The invoice that was created to bill for this registration","title":"Training Provider Billing Invoice Line Item","type":"string"},"training_provider_billing_name":{"description":"The training provider name (for billing)","title":"Training Provider Billing Name","type":"string"},"training_provider_billing_status":{"description":"The training provider billing status for this registration","enum":["billed","billing hold","exempt from billing","not yet billed"],"title":"Training Provider Billing Status","type":"string"},"training_provider_id":{"description":"The training facility","title":"Training Provider","type":"string"}},"required":["date","exam_id","exam_offering_id","id","name","student_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ExamSite":{"id":"components/schemas/ExamSite","kind":"json-schema","title":"ExamSite","data":{"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this exam site","pattern":"/^[\\w|-]+$/","title":"ID","type":"string"},"is_active":{"description":"Whether or not this exam site is active","title":"Is Active","type":"boolean"},"location":{"$ref":"#/components/schemas/Address"},"name":{"description":"The name of the exam site","title":"Name","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ExpirationRuleSet":{"id":"components/schemas/ExpirationRuleSet","kind":"json-schema","title":"ExpirationRuleSet","data":{"additionalProperties":false,"properties":{"default_expiration_options":{"additionalProperties":false,"description":"The default expiration logic when no rules have been met","properties":{"allow_reinstatement":{"description":"Whether or not reinstatement is allowed","title":"Allow Reinstatement","type":"boolean"},"anniversary_expiration_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"allow_mid_month_expirations":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, a members' subscription will expire on the same day it was purchased, and can expire mid month. Usually sell_for_next_month_after is set to null when this option is used."},"children":[]}]}]}],"title":"Allow Mid Month Expirations","type":"boolean"},"enable_fixed_expiration_dates":{"description":"If set, anniversary dates will be limited to specific dates based on the original join date","title":"Enable Fixed Expiration Dates","type":"boolean"},"fixed_expiration_dates":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"description":"The from effective expiration date","pattern":"\\d\\d-\\d\\d","title":"Expiration Date","type":"string"},"range_end":{"description":"The from month/day that ends the range","pattern":"\\d\\d-\\d\\d","title":"Range End","type":"string"},"range_start":{"description":"The month/day that begins the range","pattern":"\\d\\d-\\d\\d","title":"Range Start","type":"string"}},"required":["expiration_date","range_end","range_start"],"type":"object"},"oneOf":[{"x-required":true}],"type":"array"},"sell_for_next_month_after":{"description":"Day of the month after which, subscription starts on the next month. If null, subscription always starts in the current month","format":"float","maximum":31,"minimum":1,"title":"Sell For Next Month After","type":"number"},"term_length":{"description":"Length of subscription","format":"float","minimum":1,"title":"Term Length","type":"number"},"term_type":{"enum":["days","months","quarters","weeks","years"],"title":"Term Type","type":"string"}},"title":"Anniversary Expiration Options","type":"object"},"calendar_expiration_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"number_of_years":{"description":"The number of years","format":"float","minimum":1,"title":"Number Of Years","type":"number"},"sell_for_next_year_after":{"description":"The month/day after which, the subscription should extend until the end of the next calendar year. Leave blank to never extend until the next year","pattern":"^\\d\\d-\\d\\d$","title":"Sell For Next Year After","type":"string"},"start_of_calendar_year":{"description":"The month, from 1-12, that indicates the start of the calendar year","format":"float","maximum":12,"minimum":1,"title":"Start Of Calendar Year","type":"number"}},"required":["start_of_calendar_year"],"title":"Calendar Expiration Options","type":"object"},"expiration_type":{"description":"How the expiration is calculated","enum":["anniversary","calendar","none"],"title":"Expiration Type","type":"string"},"grace_period":{"description":"Number of days after expiration in which this a person with this subscription. If not set, the global grace setting is used","format":"float","title":"Grace Period","type":"number"},"reinstatement_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"give_renewal_pricing_during_reinstatement_period":{"description":"If true, a reinstated member only pays renewal pricing","title":"Give Renewal Pricing During Reinstatement Period","type":"boolean"},"reinstatement_period":{"description":"Number of days after termination after which a person can be reinstated - leave blank for an indefinite time period","format":"float","title":"Reinstatement Period","type":"number"}},"title":"Reinstatement Options","type":"object"}},"required":["expiration_type"],"title":"Default Expiration Options","type":"object"},"id":{"description":"The unique, string identifier of this expiration rule set","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this expiration rule set is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the expiration rule set","title":"Name","type":"string"},"rules":{"items":{"additionalProperties":false,"properties":{"expiration_options":{"additionalProperties":false,"properties":{"allow_reinstatement":{"description":"Whether or not reinstatement is allowed","title":"Allow Reinstatement","type":"boolean"},"anniversary_expiration_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"allow_mid_month_expirations":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, a members' subscription will expire on the same day it was purchased, and can expire mid month. Usually sell_for_next_month_after is set to null when this option is used."},"children":[]}]}]}],"title":"Allow Mid Month Expirations","type":"boolean"},"enable_fixed_expiration_dates":{"description":"If set, anniversary dates will be limited to specific dates based on the original join date","title":"Enable Fixed Expiration Dates","type":"boolean"},"fixed_expiration_dates":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"description":"The from effective expiration date","pattern":"\\d\\d-\\d\\d","title":"Expiration Date","type":"string"},"range_end":{"description":"The from month/day that ends the range","pattern":"\\d\\d-\\d\\d","title":"Range End","type":"string"},"range_start":{"description":"The month/day that begins the range","pattern":"\\d\\d-\\d\\d","title":"Range Start","type":"string"}},"required":["expiration_date","range_end","range_start"],"type":"object"},"oneOf":[{"x-required":true}],"type":"array"},"sell_for_next_month_after":{"description":"Day of the month after which, subscription starts on the next month. If null, subscription always starts in the current month","format":"float","maximum":31,"minimum":1,"title":"Sell For Next Month After","type":"number"},"term_length":{"description":"Length of subscription","format":"float","minimum":1,"title":"Term Length","type":"number"},"term_type":{"enum":["days","months","quarters","weeks","years"],"title":"Term Type","type":"string"}},"title":"Anniversary Expiration Options","type":"object"},"calendar_expiration_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"number_of_years":{"description":"The number of years","format":"float","minimum":1,"title":"Number Of Years","type":"number"},"sell_for_next_year_after":{"description":"The month/day after which, the subscription should extend until the end of the next calendar year. Leave blank to never extend until the next year","pattern":"^\\d\\d-\\d\\d$","title":"Sell For Next Year After","type":"string"},"start_of_calendar_year":{"description":"The month, from 1-12, that indicates the start of the calendar year","format":"float","maximum":12,"minimum":1,"title":"Start Of Calendar Year","type":"number"}},"required":["start_of_calendar_year"],"title":"Calendar Expiration Options","type":"object"},"expiration_type":{"description":"How the expiration is calculated","enum":["anniversary","calendar","none"],"title":"Expiration Type","type":"string"},"grace_period":{"description":"Number of days after expiration in which this a person with this subscription. If not set, the global grace setting is used","format":"float","title":"Grace Period","type":"number"},"reinstatement_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"give_renewal_pricing_during_reinstatement_period":{"description":"If true, a reinstated member only pays renewal pricing","title":"Give Renewal Pricing During Reinstatement Period","type":"boolean"},"reinstatement_period":{"description":"Number of days after termination after which a person can be reinstated - leave blank for an indefinite time period","format":"float","title":"Reinstatement Period","type":"number"}},"title":"Reinstatement Options","type":"object"}},"required":["expiration_type"],"title":"Expiration Options","type":"object"},"is_enabled":{"description":"Whether or not this rule is enabled","title":"Is Enabled","type":"boolean"},"matching_conditions":{"additionalProperties":false,"description":"The conditions upon which this expiration rule applies. If not set, then this expiration rule always applies","properties":{"all":{"items":{"additionalProperties":false,"properties":{"all":{"title":"All","type":"object"},"any":{"title":"Any","type":"object"},"fact":{"description":"The piece of data being examined","title":"Fact","type":"string"},"operator":{"description":"The operator","enum":["contains","containsString","doesNotContain","equal","greaterThan","greaterThanInclusive","in","isBlank","isNotBlank","lessThan","lessThanInclusive","matchesPatter","notContainsString","notEqual","notIn","regex"],"title":"Operator","type":"string"},"path":{"description":"The path of the value being tested","title":"Path","type":"string"},"value":{"title":"Value","type":"string"}},"type":"object"},"type":"array"},"any":{"items":{"additionalProperties":false,"properties":{"all":{"title":"All","type":"object"},"any":{"title":"Any","type":"object"},"fact":{"description":"The piece of data being examined","title":"Fact","type":"string"},"operator":{"description":"The operator","enum":["contains","containsString","doesNotContain","equal","greaterThan","greaterThanInclusive","in","isBlank","isNotBlank","lessThan","lessThanInclusive","matchesPatter","notContainsString","notEqual","notIn","regex"],"title":"Operator","type":"string"},"path":{"description":"The path of the value being tested","title":"Path","type":"string"},"value":{"title":"Value","type":"string"}},"type":"object"},"type":"array"}},"title":"Matching Conditions","type":"object"},"name":{"description":"The name of the rule","title":"Name","type":"string"}},"required":["name"],"type":"object"},"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["default_expiration_options","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Fee":{"id":"components/schemas/Fee","kind":"json-schema","title":"Fee","data":{"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bundled_products":{"items":{"properties":{"product_id":{"description":"The product ID","title":"Product","type":"string"},"product_type":{"description":"The product type","title":"Product Type","type":"string"},"quantity":{"description":"The quantity to bundle","title":"Quantity","type":"integer"},"type":{"enum":["bundled product"],"title":"Type","type":"string"}},"required":["product_id","product_type","quantity","type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products_inventory_handling":{"description":"Whether to track inventory for the entire bundle, or for each product separately","enum":["bundle","each product"],"title":"Bundled Products Inventory Handling","type":"string"},"business_unit_id":{"description":"The business unit of the product","title":"Business Unit","type":"string"},"cancellation_fee":{"description":"Cancellation fees associated with this product","format":"double","title":"Cancellation Fee","type":"number"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"enable_bundled_products":{"description":"Whether to enable bundled products","title":"Enable Bundled Products","type":"boolean"},"enable_cancellation_fees":{"description":"Whether or not cancellation fees are applicable","title":"Enable Cancellation Fees","type":"boolean"},"enable_purchasing_eligibility":{"description":"If set, purchases of this merchandise are restricted","title":"Enable Purchasing Eligibility","type":"boolean"},"foreign_currency_prices":{"items":{"properties":{"cancellation_fee":{"description":"The cancellation fee of the product for this currency","format":"double","title":"Cancellation Fee","type":"number"},"currency_code":{"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"title":"Currency Code","type":"string"},"member_price":{"description":"The price of the product for a member","format":"double","title":"Member Price","type":"number"},"price":{"description":"The price of the product","format":"double","title":"Price","type":"number"},"restocking_fee":{"description":"The restocking fee of the product for this currency","format":"double","title":"Restocking Fee","type":"number"}},"required":["currency_code"],"type":"object"},"type":"array"},"id":{"description":"The unique, string identifier of this miscellaneous product","pattern":"/^[\\w|-]+$/","title":"ID","type":"string"},"installment_plan_options":{"items":{"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"type":"array"},"is_active":{"description":"Whether this product is active/used","title":"Is Active","type":"boolean"},"member_price":{"description":"The price of the product for an active member","format":"double","title":"Member Price","type":"number"},"name":{"description":"The name of the miscellaneous product","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"portal_options":{"properties":{"available_from":{"description":"The date from which this product should be available","format":"date-time","title":"Available From","type":"string"},"available_until":{"description":"The date until which this product should be available","format":"date-time","title":"Available Until","type":"string"}},"title":"Portal Options","type":"object"},"price":{"description":"The price of the product","format":"double","title":"Price","type":"number"},"publish_to_portal":{"description":"Whether or not this product should be available in the portal","title":"Publish To Portal","type":"boolean"},"purchasing_eligibility_criteria":{"properties":{"certificants":{"description":"If set, only people with specific certifications","title":"Certificants","type":"boolean"},"certification_options":{"properties":{"program_ids":{"items":{"type":"string"},"title":"Programs","type":"array"}},"title":"Certification Options","type":"object"},"committee_member_options":{"properties":{"committee_ids":{"items":{"type":"string"},"title":"Committees","type":"array"},"committee_position_ids":{"items":{"type":"string"},"title":"Committee Positions","type":"array"},"committee_type_ids":{"items":{"type":"string"},"title":"Committee Types","type":"array"}},"title":"Committee Member Options","type":"object"},"committee_members":{"description":"If set, active members who belong to a committee can purchase","title":"Committee Members","type":"boolean"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"maximum_age":{"description":"The maximum age of the contact","format":"float","title":"Maximum Age","type":"number"},"member_options":{"properties":{"chapter_member_options":{"properties":{"chapter_ids":{"items":{"type":"string"},"title":"Chapters","type":"array"},"chapter_type_ids":{"items":{"type":"string"},"title":"Chapter Types","type":"array"}},"title":"Chapter Member Options","type":"object"},"chapter_members":{"description":"If set, active members who belong to a chapter can purchase","title":"Chapter Members","type":"boolean"},"member_package_ids":{"description":"The member package","items":{"type":"string"},"title":"Member Packages","type":"array"},"member_status_reason_ids":{"items":{"type":"string"},"title":"Member Status Reasons","type":"array"},"member_statuses":{"items":{"enum":["active","inactive","suspended"],"type":"string"},"title":"Member Statuses","type":"array"},"member_type_ids":{"description":"The member types","items":{"type":"string"},"title":"Member Types","type":"array"},"section_member_options":{"properties":{"section_ids":{"items":{"type":"string"},"title":"Sections","type":"array"},"section_type_ids":{"items":{"type":"string"},"title":"Section Types","type":"array"}},"title":"Section Member Options","type":"object"},"section_members":{"description":"If set, active members who belong to a section can purchase","title":"Section Members","type":"boolean"}},"required":["chapter_member_options","section_member_options"],"title":"Member Options","type":"object"},"members":{"description":"If set, active members can purchase this","title":"Members","type":"boolean"},"minimum_age":{"description":"The minimum age of the contact","format":"float","title":"Minimum Age","type":"number"},"non_members":{"description":"If set, only nonmembers can purchase","title":"Non Members","type":"boolean"}},"required":["certification_options","committee_member_options","member_options"],"title":"Purchasing Eligibility Criteria","type":"object"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"description":"The product type","enum":["certifications-fees"],"title":"Type","type":"string"}},"required":["bundled_products","business_unit_id","id","installment_plan_options","name","price","purchasing_eligibility_criteria","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Instructor":{"id":"components/schemas/Instructor","kind":"json-schema","title":"Instructor","data":{"additionalProperties":false,"properties":{"bio":{"description":"The bio","title":"Bio","type":"string"},"city":{"description":"The member city","title":"City","type":"string"},"contract_uri":{"description":"A link to the contract","format":"file","title":"Contract Uri","type":"string"},"country":{"description":"The member country","title":"Country","type":"string"},"courses":{"items":{"additionalProperties":false,"properties":{"course_id":{"description":"The course this instructor is approved to teach","title":"Course","type":"string"},"valid_from":{"format":"date","title":"Valid From","type":"string"},"valid_until":{"format":"date","title":"Valid Until","type":"string"}},"type":"object"},"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"email_address":{"description":"The member's email address","title":"Email Address","type":"string"},"first_name":{"description":"The member's first name","title":"First Name","type":"string"},"id":{"description":"The unique, string identifier of this instructor","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this course instructor is active","title":"Is Active","type":"boolean"},"job_title":{"description":"The member job title","title":"Job Title","type":"string"},"last_name":{"description":"The member's last name","title":"Last Name","type":"string"},"name":{"description":"The member's name","title":"Name","type":"string"},"notes":{"description":"Notes on this instructor","title":"Notes","type":"string"},"pay_rate":{"description":"The contract rate for the instructor","format":"float","title":"Pay Rate","type":"number"},"photo_uri":{"description":"A photo","title":"Photo Uri","type":"string"},"state":{"description":"The state","title":"State","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"training_provider_id":{"description":"The training provider - reporting only","title":"Training Provider","type":"string"},"training_providers":{"items":{"additionalProperties":false,"properties":{"training_provider_id":{"description":"The training provider","title":"Training Provider","type":"string"}},"type":"object"},"minItems":1,"type":"array"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/LicenseType":{"id":"components/schemas/LicenseType","kind":"json-schema","title":"LicenseType","data":{"additionalProperties":false,"properties":{"id":{"description":"The unique, string identifier of this license type","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this license type is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the license type","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ListActivitiesResponse":{"id":"components/schemas/ListActivitiesResponse","kind":"json-schema","title":"ListActivitiesResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Activity"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListApplicationProcessesResponse":{"id":"components/schemas/ListApplicationProcessesResponse","kind":"json-schema","title":"ListApplicationProcessesResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/ApplicationProcess"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListApplicationReferencesResponse":{"id":"components/schemas/ListApplicationReferencesResponse","kind":"json-schema","title":"ListApplicationReferencesResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/ApplicationReference"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListApplicationsResponse":{"id":"components/schemas/ListApplicationsResponse","kind":"json-schema","title":"ListApplicationsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Application"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListBillingRunActionsResponse":{"id":"components/schemas/ListBillingRunActionsResponse","kind":"json-schema","title":"ListBillingRunActionsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/BillingRunAction"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListBillingRunsResponse":{"id":"components/schemas/ListBillingRunsResponse","kind":"json-schema","title":"ListBillingRunsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/BillingRun"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListCertificationsResponse":{"id":"components/schemas/ListCertificationsResponse","kind":"json-schema","title":"ListCertificationsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Certification"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListCourseFeesResponse":{"id":"components/schemas/ListCourseFeesResponse","kind":"json-schema","title":"ListCourseFeesResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/CourseFee"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListCourseInstructorsResponse":{"id":"components/schemas/ListCourseInstructorsResponse","kind":"json-schema","title":"ListCourseInstructorsResponse","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/CourseInstructor"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListCourseOfferingsResponse":{"id":"components/schemas/ListCourseOfferingsResponse","kind":"json-schema","title":"ListCourseOfferingsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/CourseOffering"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListCourseRegistrationsResponse":{"id":"components/schemas/ListCourseRegistrationsResponse","kind":"json-schema","title":"ListCourseRegistrationsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/CourseRegistration"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListCourseResponse":{"id":"components/schemas/ListCourseResponse","kind":"json-schema","title":"ListCourseResponse","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/Course"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListCourseTypeResponse":{"id":"components/schemas/ListCourseTypeResponse","kind":"json-schema","title":"ListCourseTypeResponse","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/CourseType"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListCreditsResponse":{"id":"components/schemas/ListCreditsResponse","kind":"json-schema","title":"ListCreditsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Credit"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListExamFeesResponse":{"id":"components/schemas/ListExamFeesResponse","kind":"json-schema","title":"ListExamFeesResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/ExamFee"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListExamOfferingsResponse":{"id":"components/schemas/ListExamOfferingsResponse","kind":"json-schema","title":"ListExamOfferingsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/ExamOffering"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListExamRegistrationsResponse":{"id":"components/schemas/ListExamRegistrationsResponse","kind":"json-schema","title":"ListExamRegistrationsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/ExamRegistration"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListInstructorResponse":{"id":"components/schemas/ListInstructorResponse","kind":"json-schema","title":"ListInstructorResponse","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/Instructor"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListInstructorsResponse":{"id":"components/schemas/ListInstructorsResponse","kind":"json-schema","title":"ListInstructorsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Instructor"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListProfilesResponse":{"id":"components/schemas/ListProfilesResponse","kind":"json-schema","title":"ListProfilesResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Profile"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListRecurringBillingRunsResponse":{"id":"components/schemas/ListRecurringBillingRunsResponse","kind":"json-schema","title":"ListRecurringBillingRunsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/RecurringBillingRun"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListStandardQueryDefinitionsResponse":{"id":"components/schemas/ListStandardQueryDefinitionsResponse","kind":"json-schema","title":"ListStandardQueryDefinitionsResponse","data":{"items":{"$ref":"#/components/schemas/StandardQueryDefinition"},"type":"array"}},"components/schemas/ListTrainingLocationsResponse":{"id":"components/schemas/ListTrainingLocationsResponse","kind":"json-schema","title":"ListTrainingLocationsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/TrainingLocation"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListTrainingProvProgramsResponse":{"id":"components/schemas/ListTrainingProvProgramsResponse","kind":"json-schema","title":"ListTrainingProvProgramsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/TrainingProvProgram"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/Notice":{"id":"components/schemas/Notice","kind":"json-schema","title":"Notice","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"email":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"id":{"description":"The unique, string identifier of this notice","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this notice is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the notice","title":"Name","type":"string"},"restrict_to_certain_programs":{"description":"If true, this notice is only applicable to certain certification programs","title":"Restrict To Certain Programs","type":"boolean"},"restricted_program_ids":{"items":{"type":"string"},"title":"Restricted Programs","type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["email","id","name","restricted_program_ids","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/PagedActivitySearchResults":{"id":"components/schemas/PagedActivitySearchResults","kind":"json-schema","title":"PagedActivitySearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/ActivitySearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedApplicationSearchResults":{"id":"components/schemas/PagedApplicationSearchResults","kind":"json-schema","title":"PagedApplicationSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/ApplicationSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedBillingRunSearchResults":{"id":"components/schemas/PagedBillingRunSearchResults","kind":"json-schema","title":"PagedBillingRunSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/BillingRunSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedCertificationSearchResults":{"id":"components/schemas/PagedCertificationSearchResults","kind":"json-schema","title":"PagedCertificationSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/CertificationSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedCourseOfferingSearchResults":{"id":"components/schemas/PagedCourseOfferingSearchResults","kind":"json-schema","title":"PagedCourseOfferingSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/CourseOfferingSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedCourseRegistrationSearchResults":{"id":"components/schemas/PagedCourseRegistrationSearchResults","kind":"json-schema","title":"PagedCourseRegistrationSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/CourseRegistrationSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedCreditSearchResults":{"id":"components/schemas/PagedCreditSearchResults","kind":"json-schema","title":"PagedCreditSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/CreditSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedExamOfferingSearchResults":{"id":"components/schemas/PagedExamOfferingSearchResults","kind":"json-schema","title":"PagedExamOfferingSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/ExamOfferingSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedExamRegistrationSearchResults":{"id":"components/schemas/PagedExamRegistrationSearchResults","kind":"json-schema","title":"PagedExamRegistrationSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/ExamRegistrationSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PatchDirective":{"id":"components/schemas/PatchDirective","kind":"json-schema","title":"PatchDirective","data":{"additionalProperties":false,"properties":{"op":{"description":"The operation","enum":["add","copy","move","remove","replace","test"],"title":"Op","type":"string"},"path":{"description":"The JSON path","title":"Path","type":"string"},"value":{"description":"The updated value","title":"Value","type":"string"}},"required":["op","path"],"type":"object"}},"components/schemas/PreviewCertificateRequest":{"id":"components/schemas/PreviewCertificateRequest","kind":"json-schema","title":"PreviewCertificateRequest","data":{"additionalProperties":false,"properties":{"certificate_template":{"title":"Certificate Template","type":"string"},"certification_id":{"title":"Certification","type":"string"}},"required":["certificate_template","certification_id"],"type":"object"}},"components/schemas/PreviewEmailRequest":{"id":"components/schemas/PreviewEmailRequest","kind":"json-schema","title":"PreviewEmailRequest","data":{"additionalProperties":false,"properties":{"activity_id":{"title":"Activity","type":"string"},"application_id":{"title":"Application","type":"string"},"certification_id":{"title":"Certification","type":"string"},"destination_email_address":{"title":"Destination Email Address","type":"string"},"email_template":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email Template","type":"object"},"reference_id":{"title":"Reference","type":"string"},"registration_id":{"title":"Registration","type":"string"}},"required":["destination_email_address","registration_id"],"type":"object"}},"components/schemas/Profile":{"id":"components/schemas/Profile","kind":"json-schema","title":"Profile","data":{"additionalProperties":false,"properties":{"city":{"description":"The member city","title":"City","type":"string"},"country":{"description":"The member country","title":"Country","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"email_address":{"description":"The member's email address","title":"Email Address","type":"string"},"first_name":{"description":"The member's first name","title":"First Name","type":"string"},"id":{"description":"The unique, string identifier of this profile - which should be the contact ID","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"job_title":{"description":"The member job title","title":"Job Title","type":"string"},"last_application_data":{"title":"Last Application Data","type":"object"},"last_name":{"description":"The member's last name","title":"Last Name","type":"string"},"name":{"description":"The member's name","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"state":{"description":"The state","title":"State","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"training_provider_id":{"description":"If this profile is linked to a provider, it is here","title":"Training Provider","type":"string"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Program":{"id":"components/schemas/Program","kind":"json-schema","title":"Program","data":{"additionalProperties":false,"properties":{"application_360_screen_id":{"description":"The default page layout when showing an certification","pattern":"certifications-applications__.*","title":"Application 360 Screen","type":"string"},"application_page_layout_id":{"description":"The default page layout when showing an certification","pattern":"certifications-applications__.*","title":"Application Page Layout","type":"string"},"certificate_mode":{"enum":["automatically generate","create manually","disabled"],"title":"Certificate Mode","type":"string"},"certificate_template":{"title":"Certificate Template","type":"string"},"certification_360_screen_id":{"description":"The default page layout when showing a certification","pattern":"certifications-certifications__.*","title":"Certification 360 Screen","type":"string"},"certification_page_layout_id":{"description":"The default page layout when showing a certification","pattern":"certifications-certifications__.*","title":"Certification Page Layout","type":"string"},"custom_application_portal_template":{"title":"Custom Application Portal Template","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"customer_type":{"description":"The type of customer that can have this certification","enum":["both","contact","organization"],"title":"Customer Type","type":"string"},"default_reinstatement_period":{"description":"The reinstatement period for certifications in this program","format":"float","title":"Default Reinstatement Period","type":"number"},"description":{"description":"A description, which displays in the portal","title":"Description","type":"string"},"display_in_portal":{"description":"If true, this portal appears in the portal","title":"Display In Portal","type":"boolean"},"display_order":{"description":"The display order","format":"float","title":"Display Order","type":"number"},"enable_custom_application_portal_template":{"description":"If set, a custom template is used to show the application information in the portal","title":"Enable Custom Application Portal Template","type":"boolean"},"enable_grandfathered_certifications":{"description":"If set to true, any other certifications marked as grandfathered are renewed when a certification of this type is renewed","title":"Enable Grandfathered Certifications","type":"boolean"},"grandfathered_certification_options":{"additionalProperties":false,"properties":{"program_ids":{"description":"The program IDs to automatically renew when if a certification with this program is renewed and the certification is set to grandfathered renewal","items":{"type":"string"},"minItems":1,"title":"Programs","type":"array"}},"required":["program_ids"],"title":"Grandfathered Certification Options","type":"object"},"group_id":{"description":"The certification group","title":"Group","type":"string"},"id":{"description":"The unique, string identifier of this program","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this program is active","title":"Is Active","type":"boolean"},"logo_uri":{"description":"The logo of the program","title":"Logo Uri","type":"string"},"name":{"description":"The name of the program","title":"Name","type":"string"},"next_certification_number":{"description":"The number that should be used for the next certification that is activated in this program","format":"float","title":"Next Certification Number","type":"number"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["certificate_template","custom_application_portal_template","grandfathered_certification_options","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ProgramGroup":{"id":"components/schemas/ProgramGroup","kind":"json-schema","title":"ProgramGroup","data":{"additionalProperties":false,"properties":{"display_order":{"description":"The optional order of the group","format":"float","title":"Display Order","type":"number"},"id":{"description":"The unique, string identifier of this program group","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this program group is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the program group","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ProjectType":{"id":"components/schemas/ProjectType","kind":"json-schema","title":"ProjectType","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this project type","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this project type is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the project type","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/PublicCertificationCourseFeesRequest":{"id":"components/schemas/PublicCertificationCourseFeesRequest","kind":"json-schema","title":"PublicCertificationCourseFeesRequest","data":{"properties":{"course_ids":{"items":{"type":"string"},"minItems":0,"title":"Courses","type":"array"},"course_restriction":{"enum":["exclude","include","none"],"title":"Course Restriction","type":"string"},"course_type_ids":{"items":{"type":"string"},"minItems":0,"title":"Course Types","type":"array"},"course_type_restriction":{"enum":["exclude","include","none"],"title":"Course Type Restriction","type":"string"}},"required":["course_ids","course_type_ids"],"type":"object"}},"components/schemas/PublicCertificationCourseFeesResponse":{"id":"components/schemas/PublicCertificationCourseFeesResponse","kind":"json-schema","title":"PublicCertificationCourseFeesResponse","data":{"additionalProperties":false,"properties":{"course_types":{"items":{"additionalProperties":false,"properties":{"display_in_portal_as":{"description":"Portal display","title":"Display In Portal As","type":"string"},"display_order":{"description":"Display order for the course type","format":"float","title":"Display Order","type":"number"},"id":{"description":"ID of the course type","title":"ID","type":"string"},"name":{"description":"Name of the course type","title":"Name","type":"string"}},"type":"object"},"type":"array"},"courses":{"items":{"additionalProperties":false,"properties":{"display_in_portal_as":{"description":"Portal display","title":"Display In Portal As","type":"string"},"id":{"description":"ID of the course ","title":"ID","type":"string"},"name":{"description":"Name of the course","title":"Name","type":"string"},"type_id":{"description":"The course type id","title":"Type","type":"string"},"universal_shopping_cart_image_uri":{"description":"Image to use for the cart","title":"Universal Shopping Cart Image Uri","type":"string"}},"type":"object"},"type":"array"},"fees":{"items":{"additionalProperties":false,"properties":{"course_id":{"description":"Course id","title":"Course","type":"string"},"enable_special_prices":{"description":"Whether special prices are used","title":"Enable Special Prices","type":"boolean"},"id":{"description":"ID of the course fee","title":"ID","type":"string"},"member_price":{"description":"Renewal price of the package","format":"float","title":"Member Price","type":"number"},"name":{"description":"Name of the course fee","title":"Name","type":"string"},"price":{"description":"Price of the package","format":"float","title":"Price","type":"number"}},"type":"object"},"type":"array"},"offerings":{"items":{"additionalProperties":false,"properties":{"course_id":{"description":"The course being scheduled","title":"Course","type":"string"},"course_type_id":{"description":"The type of course","title":"Course Type","type":"string"},"description":{"description":"Any information you want to display about this in the portal","title":"Description","type":"string"},"end_date":{"description":"The date of the course","format":"date-time","title":"End Date","type":"string"},"fee_id":{"description":"The course registration fee","title":"Fee","type":"string"},"id":{"description":"ID of the course ","title":"ID","type":"string"},"name":{"description":"Name of the course","title":"Name","type":"string"},"program_ids":{"description":"The programs for which this course is relevant","items":{"type":"string"},"title":"Programs","type":"array"},"short_description":{"description":"Any short descriptive information to display in the directory","title":"Short Description","type":"string"},"start_date":{"description":"The date of the course","format":"date-time","title":"Start Date","type":"string"},"timezone":{"description":"The timezone in which the course offering lives","oneOf":[{"x-required":true}],"title":"Timezone","type":"string"},"timezone_abbreviation":{"description":"The timezone abbreviation, based on the event start date","title":"Timezone Abbreviation","type":"string"},"timezone_mode":{"enum":["local","specific timezone"],"title":"Timezone Mode","type":"string"},"timezone_offset":{"description":"The time zone offset, in minutes, from UTC, based on the event start date","format":"float","title":"Timezone Offset","type":"number"},"type":{"enum":["in person","on-demand","virtual"],"title":"Type","type":"string"}},"required":["course_id"],"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/PublicCertificationExamFeesRequest":{"id":"components/schemas/PublicCertificationExamFeesRequest","kind":"json-schema","title":"PublicCertificationExamFeesRequest","data":{"properties":{"exam_ids":{"items":{"type":"string"},"minItems":0,"title":"Exams","type":"array"},"exam_restriction":{"enum":["exclude","include","none"],"title":"Exam Restriction","type":"string"}},"required":["exam_ids"],"type":"object"}},"components/schemas/PublicCertificationExamFeesResponse":{"id":"components/schemas/PublicCertificationExamFeesResponse","kind":"json-schema","title":"PublicCertificationExamFeesResponse","data":{"additionalProperties":false,"properties":{"exams":{"items":{"additionalProperties":false,"properties":{"description":{"title":"Description","type":"string"},"display_in_portal_as":{"description":"Portal display","title":"Display In Portal As","type":"string"},"id":{"description":"ID of the exam ","title":"ID","type":"string"},"name":{"description":"Name of the exam","title":"Name","type":"string"},"universal_shopping_cart_image_uri":{"description":"Image to use for the cart","title":"Universal Shopping Cart Image Uri","type":"string"}},"type":"object"},"type":"array"},"fees":{"items":{"additionalProperties":false,"properties":{"enable_special_prices":{"description":"Whether special prices are used","title":"Enable Special Prices","type":"boolean"},"exam_id":{"description":"Exam id","title":"Exam","type":"string"},"id":{"description":"ID of the exam fee","title":"ID","type":"string"},"member_price":{"description":"Renewal price of the package","format":"float","title":"Member Price","type":"number"},"name":{"description":"Name of the exam fee","title":"Name","type":"string"},"price":{"description":"Price of the package","format":"float","title":"Price","type":"number"}},"type":"object"},"type":"array"},"offerings":{"items":{"additionalProperties":false,"properties":{"additional_location_info":{"description":"Additional location information","title":"Additional Location Info","type":"string"},"date":{"title":"Date","type":"string"},"description":{"description":"A description for the portal","title":"Description","type":"string"},"end_time":{"description":"The registration date/time","title":"End Time","type":"string"},"exam_id":{"description":"The exam","title":"Exam","type":"string"},"fee_id":{"description":"The fee for initial testing","title":"Fee","type":"string"},"id":{"title":"ID","type":"string"},"location":{"enum":["none","testing facility","training location"],"title":"Location","type":"string"},"name":{"description":"The name of the offering","title":"Name","type":"string"},"registration_time":{"description":"The registration date/time","title":"Registration Time","type":"string"},"retest_fee_id":{"description":"The fee for retake/retest","title":"Retest Fee","type":"string"},"start_time":{"description":"The registration date/time","title":"Start Time","type":"string"},"testing_facility_id":{"description":"The exam testing site","oneOf":[{"x-required":true}],"title":"Testing Facility","type":"string"},"training_location_id":{"description":"The training facility","oneOf":[{"x-required":true}],"title":"Training Location","type":"string"},"type":{"description":"The type of exam","enum":["live","remote proctor"],"title":"Type","type":"string"}},"required":["exam_id","location","name","type"],"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/RecurringBillingRun":{"id":"components/schemas/RecurringBillingRun","kind":"json-schema","title":"RecurringBillingRun","data":{"additionalProperties":false,"properties":{"errors_since_last_run":{"description":"The number of errors that have occurred since the last successful run of this schedule","format":"float","title":"Errors Since Last Run","type":"number"},"human_readable_schedule":{"description":"A human readable schedule for display","title":"Human Readable Schedule","type":"string"},"id":{"description":"The unique, string identifier of this recurring billing run","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether this process is active","title":"Is Active","type":"boolean"},"last_error":{"description":"The last error on this process","title":"Last Error","type":"string"},"last_error_date":{"description":"The last time this process encountered an error","format":"date-time","title":"Last Error Date","type":"string"},"last_run_date":{"description":"The last time this process was run","format":"date-time","title":"Last Run Date","type":"string"},"name":{"description":"The name of the recurring billing run","title":"Name","type":"string"},"pre_processing_lead_time":{"description":"The number of business days before the run date that the system should pre process the run and allow it to be reviewed","format":"float","minimum":1,"title":"Pre Processing Lead Time","type":"number"},"schedule":{"description":"The schedule which defines how often the batch should be created","title":"Schedule","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_next_processing_date":{"description":"Internal system field, do not modify","format":"date-time","title":"Sys Next Processing Date","type":"string"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"template_id":{"description":"The template to use","title":"Template","type":"string"}},"required":["id","name","pre_processing_lead_time","schedule","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","template_id"],"type":"object"}},"components/schemas/Setting":{"id":"components/schemas/Setting","kind":"json-schema","title":"Setting","data":{"additionalProperties":false,"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bank_account_id":{"description":"The default bank account that the store should use to receive payments","title":"Bank Account","type":"string"},"bill_my_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Organization Options","type":"object"},"bill_my_parent_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Parent Organization Options","type":"object"},"business_unit_id":{"description":"The business unit of the store","title":"Business Unit","type":"string"},"cancellation_fee_product_id":{"description":"The ID of the product used for cancellation fees","title":"Cancellation Fee Product","type":"string"},"checkout_donation_options":{"additionalProperties":false,"properties":{"simple_checkout_donation_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"allow_user_to_specify_custom_amount":{"description":"If set, the user can specify their own custom donation","title":"Allow User To Specify Custom Amount","type":"boolean"},"donation_ask_text":{"description":"The text shown to the user when making the donation","title":"Donation Ask Text","type":"string"},"donation_denominations":{"items":{"format":"double","type":"number"},"title":"Donation Denominations","type":"array"},"donation_information":{"description":"Additional information about the donation","title":"Donation Information","type":"string"},"donation_product_id":{"description":"The misc product that should be used","title":"Donation Product","type":"string"},"override_donation_denominations":{"description":"If set, donation denominations are specified here and the defaults are not used","title":"Override Donation Denominations","type":"boolean"},"suggested_donation":{"description":"A suggested donation","format":"double","title":"Suggested Donation","type":"number"}},"required":["donation_product_id"],"title":"Simple Checkout Donation Options","type":"object"},"type":{"enum":["simple"],"title":"Type","type":"string"}},"title":"Checkout Donation Options","type":"object"},"contact_role_permissions":{"items":{"additionalProperties":false,"properties":{"apply_for_certification":{"description":"Whether the contact role can join as a organizational member","title":"Apply For Certification","type":"boolean"},"renew_certification":{"description":"Whether the contact role can renew for membership","title":"Renew Certification","type":"boolean"},"role_id":{"description":"The contact role","title":"Role","type":"string"},"training_provider_administrator":{"description":"This role can has administrative permissions for a linked training partner","title":"Training Provider Administrator","type":"boolean"},"view_applications":{"description":"Whether the contact role can view applications","title":"View Applications","type":"boolean"}},"type":"object"},"type":"array"},"credit_card_minimum_range_end":{"description":"If set, the maximum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range End","type":"number"},"credit_card_minimum_range_start":{"description":"If set, the minimum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range Start","type":"number"},"credit_card_mode":{"description":"Determines whether or not credit cards are accepted","enum":["disabled","enabled","range"],"title":"Credit Card Mode","type":"string"},"credit_card_processing_fee_mode":{"description":"Determines how credit card processing fees should be handled","enum":["charge","do not charge","prompt user"],"title":"Credit Card Processing Fee Mode","type":"string"},"credit_card_processing_fee_options":{"additionalProperties":false,"properties":{"fee_percentage":{"description":"The fee percentage to charge for credit card processing ","format":"float","title":"Fee Percentage","type":"number"},"maximum_fee":{"description":"The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged","format":"float","title":"Maximum Fee","type":"number"},"minimum_fee":{"description":"The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged","format":"float","title":"Minimum Fee","type":"number"},"product_id":{"description":"The misc product to use for the credit card processing","title":"Product","type":"string"},"prompt_sub_text":{"description":"Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Sub Text","type":"string"},"prompt_text":{"description":"The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Text","type":"string"}},"required":["fee_percentage","product_id"],"title":"Credit Card Processing Fee Options","type":"object"},"custom_application_portal_template":{"title":"Custom Application Portal Template","type":"string"},"default_application_360_screen_id":{"description":"The default page layout when showing an certification","pattern":"certifications-applications__.*","title":"Default Application 360 Screen","type":"string"},"default_application_page_layout_id":{"description":"The default page layout when showing an certification","pattern":"certifications-applications__.*","title":"Default Application Page Layout","type":"string"},"default_certification_360_screen_id":{"description":"The default page layout when showing a certification","pattern":"certifications-certifications__.*","title":"Default Certification 360 Screen","type":"string"},"default_certification_page_layout_id":{"description":"The default page layout when showing a certification","pattern":"certifications-certifications__.*","title":"Default Certification Page Layout","type":"string"},"disable_electronic_payment_vaulting":{"description":"If set, in the portal people are not allowed to save credit cards","title":"Disable Electronic Payment Vaulting","type":"boolean"},"enable_bill_my_organization":{"description":"If set, the user has the option to bill their organization","title":"Enable Bill My Organization","type":"boolean"},"enable_bill_my_parent_organization":{"description":"If set, the user has the option to bill their organization's parent organization","title":"Enable Bill My Parent Organization","type":"boolean"},"enable_custom_application_portal_template":{"description":"If set, a custom template is used to show the application information in the portal","title":"Enable Custom Application Portal Template","type":"boolean"},"enable_donations_at_checkout":{"description":"If selected, users will be prompted to make a donation upon checking out","title":"Enable Donations At Checkout","type":"boolean"},"enable_electronic_checks":{"description":"If set, electronic checks are allowed","title":"Enable Electronic Checks","type":"boolean"},"enable_multiple_certification_discounts":{"description":"Whether or not discounts for multiple certifications are enabled","title":"Enable Multiple Certification Discounts","type":"boolean"},"enable_pay_later":{"description":"If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed","title":"Enable Pay Later","type":"boolean"},"enable_payroll_deduction":{"description":"If set, payroll deduction is allowed","title":"Enable Payroll Deduction","type":"boolean"},"enable_split_payments":{"description":"If set, users are allowed to split payments","title":"Enable Split Payments","type":"boolean"},"enable_training_provider_administration":{"description":"If set, training providers can administer in the portal","title":"Enable Training Provider Administration","type":"boolean"},"enable_training_provider_billing":{"description":"If set, training provider billing is enabled in the UI","title":"Enable Training Provider Billing","type":"boolean"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"type":"array"},"invoice_payment_terms_id":{"description":"The payment terms for invoices; if left blank, default is used","title":"Invoice Payment Terms","type":"string"},"invoice_template_id":{"description":"The template to use for invoices created during this process","title":"Invoice Template","type":"string"},"merchant_account_id":{"description":"The merchant account that the store should use to receive payments","title":"Merchant Account","type":"string"},"multiple_certification_discount_options":{"additionalProperties":false,"properties":{"discount_amount":{"description":"The amount/percentage of the discount","format":"float","title":"Discount Amount","type":"number"},"discount_type":{"enum":["amount","percentage"],"title":"Discount Type","type":"string"},"ineligible_program_ids":{"description":"The program IDs that should not receive a discount","items":{"type":"string"},"title":"Ineligible Programs","type":"array"},"start_after":{"description":"The number of programs that should be charged full price BEFORE the discount kicks in","format":"float","title":"Start After","type":"number"}},"required":["discount_amount","discount_type"],"title":"Multiple Certification Discount Options","type":"object"},"notes":{"description":"Notes","title":"Notes","type":"string"},"pay_later_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Pay Later Options","type":"object"},"portal_browse_certification_programs_mode":{"description":"The way certification programs are browsed in the portal","enum":["list","tiled"],"title":"Portal Browse Certification Programs Mode","type":"string"},"restocking_fee_product_id":{"description":"The ID of the product used for restocking fees","title":"Restocking Fee Product","type":"string"},"special_instructions":{"description":"Instructions shown to the user","title":"Special Instructions","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"training_provider_administration_options":{"additionalProperties":false,"properties":{"access_saved_queries":{"description":"If set, the applicable chapter leaders are able to access saved queries","title":"Access Saved Queries","type":"boolean"},"create_contact_form_id":{"description":"The form used for training providers to create a contact in the portal","pattern":"^rolodex-contacts__.*","title":"Create Contact Form","type":"string"},"edit_contact_form_id":{"description":"The form used for training providers to create a contact in the portal","pattern":"^rolodex-contacts__.*","title":"Edit Contact Form","type":"string"},"saved_queries":{"items":{"additionalProperties":false,"properties":{"display_name":{"description":"The display name of the saved query. If not set, the saved query name is used","title":"Display Name","type":"string"},"saved_query_id":{"description":"The ID of the saved query","title":"Saved Query","type":"string"}},"required":["saved_query_id"],"type":"object"},"minItems":1,"oneOf":[{"x-required":true}],"type":"array"}},"required":["create_contact_form_id","edit_contact_form_id"],"title":"Training Provider Administration Options","type":"object"},"training_provider_billing_options":{"additionalProperties":false,"properties":{"certification_fee_id":{"description":"The product used when billing training providers for a certification fee","title":"Certification Fee","type":"string"},"course_fee_id":{"description":"The product used when billing training providers for a course fee","title":"Course Fee","type":"string"},"live_exam_fee_id":{"description":"The product used when billing training providers for a live exam fee","title":"Live Exam Fee","type":"string"},"reinstatement_fee_id":{"description":"The product used when billing training providers for a reinstatement fee","title":"Reinstatement Fee","type":"string"},"remote_proctor_exam_fee_id":{"description":"The product used when billing training providers for a remote proctor fee","title":"Remote Proctor Exam Fee","type":"string"},"renewal_fee_id":{"description":"The product used when billing training providers for a renewal fee","title":"Renewal Fee","type":"string"},"retest_fee_id":{"description":"The product used when billing training providers for a retest fee","title":"Retest Fee","type":"string"}},"title":"Training Provider Billing Options","type":"object"},"use_pro_forma_invoices":{"description":"Whether to use pro forma invoices when user elects to pay later","title":"Use Pro Forma Invoices","type":"boolean"}},"required":["bank_account_id","business_unit_id","checkout_donation_options","credit_card_processing_fee_options","custom_application_portal_template","installment_plan_options","merchant_account_id","multiple_certification_discount_options","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","training_provider_billing_options"],"type":"object"}},"components/schemas/StandardQueryDefinition":{"id":"components/schemas/StandardQueryDefinition","kind":"json-schema","title":"StandardQueryDefinition","data":{"additionalProperties":false,"properties":{"category":{"title":"Category","type":"string"},"definition":{"additionalProperties":false,"properties":{},"title":"Definition","type":"object"},"id":{"title":"ID","type":"string"},"name":{"title":"Name","type":"string"}},"type":"object"}},"components/schemas/Statistic":{"id":"components/schemas/Statistic","kind":"json-schema","title":"Statistic","data":{"additionalProperties":false,"properties":{"dataSource":{"description":"The datasource used to generate this value","title":"Datasource","type":"string"},"error":{"description":"If the cache encountered an error, this is it","title":"Error","type":"string"},"id":{"description":"The unique, string identifier of this statistic","pattern":"^[\\w-:%\\/]+$","title":"ID","type":"string"},"name":{"description":"The name of the statistic","title":"Name","type":"string"},"status":{"description":"The description of the statistic","enum":["error","processing","valid"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"value":{"description":"The numeric value of the statistic","format":"float","title":"Value","type":"number"},"value_difference_numeric":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a value & previous value is present, this is the numeric difference"},"children":[]}]}]}],"format":"float","title":"Value Difference Numeric","type":"number"},"value_difference_percentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a value & previous value is present, this is the percentage difference"},"children":[]}]}]}],"format":"float","title":"Value Difference Percentage","type":"number"},"value_for_previous_period":{"description":"For statistics that can compare values from a previous period, this is the value","format":"float","title":"Value For Previous Period","type":"number"},"values":{"description":"If the stat hs values in a row form, this variable contains it","items":{"additionalProperties":false,"properties":{},"type":"object"},"type":"array"}},"required":["id","name","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","value"],"type":"object"}},"components/schemas/StatusReason":{"id":"components/schemas/StatusReason","kind":"json-schema","title":"StatusReason","data":{"additionalProperties":false,"properties":{"applicable_statuses":{"items":{"enum":["active","inactive","retired","suspended"],"type":"string"},"title":"Applicable Statuses","type":"array"},"id":{"description":"The unique, string identifier of this status reason","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this status reason is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the status reason","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/StepFunctionExecutionToken":{"id":"components/schemas/StepFunctionExecutionToken","kind":"json-schema","title":"StepFunctionExecutionToken","data":{"additionalProperties":false,"properties":{"executionArn":{"description":"The arn of the execution","title":"Executionarn","type":"string"},"notification_channel":{"description":"The id of the channel where progress updates will be posted","title":"Notification Channel","type":"string"},"notification_publishKey":{"description":"The publish key for the channel where progress updates will be posted","title":"Notification Publishkey","type":"string"},"notification_subscribeKey":{"description":"The subscribe key for the channel where progress updates will be posted","title":"Notification Subscribekey","type":"string"},"start_date":{"description":"The start date of the execution","format":"date-time","title":"Start Date","type":"string"}},"required":["executionArn"],"type":"object"}},"components/schemas/TestingFacility":{"id":"components/schemas/TestingFacility","kind":"json-schema","title":"TestingFacility","data":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this testing facility","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this testing facility is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the testing facility","title":"Name","type":"string"},"notes":{"description":"Testing site notes","title":"Notes","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/TrainingLocation":{"id":"components/schemas/TrainingLocation","kind":"json-schema","title":"TrainingLocation","data":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this training location","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this training location is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the training location","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"training_provider_id":{"description":"The training provider","title":"Training Provider","type":"string"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","training_provider_id"],"type":"object"}},"components/schemas/TrainingProvProgram":{"id":"components/schemas/TrainingProvProgram","kind":"json-schema","title":"TrainingProvProgram","data":{"additionalProperties":false,"properties":{"certification_fee":{"description":"The fee charged to training providers when people apply for this program through the provider","format":"float","title":"Certification Fee","type":"number"},"course_fee":{"description":"The fee charged to training providers when people apply for a course in this program through the provider","format":"float","title":"Course Fee","type":"number"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this training prov program","pattern":"^[\\w|:-]+$","title":"ID","type":"string"},"live_exam_fee":{"description":"The fee charged to training providers when people apply for a live exam in this program through the provider","format":"float","title":"Live Exam Fee","type":"number"},"notes":{"description":"Optional notes","title":"Notes","type":"string"},"program_id":{"description":"The program","title":"Program","type":"string"},"reinstatement_fee":{"description":"The fee charged to training providers when people apply to reinstate their certification in this program through the provider","format":"float","title":"Reinstatement Fee","type":"number"},"remote_proctor_exam_fee":{"description":"The fee charged to training providers when people apply for a remote proctored exam in this program through the provider","format":"float","title":"Remote Proctor Exam Fee","type":"number"},"renewal_fee":{"description":"The fee charged to training providers when people apply to renew this program through the provider","format":"float","title":"Renewal Fee","type":"number"},"retest_fee":{"description":"The fee charged to training providers when people apply for a course in this program through the provider","format":"float","title":"Retest Fee","type":"number"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"training_provider_id":{"description":"The training provider","title":"Training Provider","type":"string"}},"required":["id","program_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","training_provider_id"],"type":"object"}},"components/schemas/TrainingProvider":{"id":"components/schemas/TrainingProvider","kind":"json-schema","title":"TrainingProvider","data":{"additionalProperties":false,"properties":{"billing_exempt":{"description":"If set, this training provider is not to be billed for any applications/courses/exams","title":"Billing Exempt","type":"boolean"},"contact_id":{"description":"The billing contact","title":"Contact","type":"string"},"contract_uri":{"description":"A link to the contract","format":"file","title":"Contract Uri","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this training provider, which should match an organization id","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this  training provider is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the training provider","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"territories":{"items":{"additionalProperties":false,"properties":{"country":{"oneOf":[{"x-required":true}],"title":"Country","type":"string"},"state":{"oneOf":[{"x-required":true}],"title":"State","type":"string"},"type":{"enum":["country","state"],"title":"Type","type":"string"}},"required":["type"],"type":"object"},"type":"array"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/TransferRegistrationRequest":{"id":"components/schemas/TransferRegistrationRequest","kind":"json-schema","title":"TransferRegistrationRequest","data":{"additionalProperties":false,"properties":{"new_course_offering_id":{"title":"New Course Offering","type":"string"},"new_student_id":{"title":"New Student","type":"string"},"notes":{"title":"Notes","type":"string"},"send_confirmation_email":{"title":"Send Confirmation Email","type":"boolean"}},"type":"object"}},"schema_366":{"kind":"json-schema","data":{"type":"string"},"id":"schema_366"},"schema_367":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Activity"},"type":"array"},"id":"schema_367"},"schema_368":{"kind":"json-schema","data":{"type":"object","properties":{"Access-Control-Allow-Headers":{"type":"string"},"Access-Control-Allow-Methods":{"type":"string"},"Access-Control-Allow-Origin":{"type":"string"}}},"id":"schema_368"},"schema_369":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PatchDirective"},"type":"array"},"id":"schema_369"},"schema_370":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ActivityRegProcess"},"type":"array"},"id":"schema_370"},"schema_371":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ActivityType"},"type":"array"},"id":"schema_371"},"schema_372":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AppReferenceProcess"},"type":"array"},"id":"schema_372"},"schema_373":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AppReferenceType"},"type":"array"},"id":"schema_373"},"schema_374":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AppStatusReason"},"type":"array"},"id":"schema_374"},"schema_375":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ApplicationFee"},"type":"array"},"id":"schema_375"},"schema_376":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ApplicationNotice"},"type":"array"},"id":"schema_376"},"schema_377":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ApplicationProcess"},"type":"array"},"id":"schema_377"},"schema_378":{"kind":"json-schema","data":{"type":"string","enum":["contact","organization"]},"id":"schema_378"},"schema_379":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Application"},"type":"array"},"id":"schema_379"},"schema_380":{"kind":"json-schema","data":{"type":"object"},"id":"schema_380"},"schema_381":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/BillingTemplate"},"type":"array"},"id":"schema_381"},"schema_382":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Certification"},"type":"array"},"id":"schema_382"},"schema_383":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_383"},"schema_384":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Coupon"},"type":"array"},"id":"schema_384"},"schema_385":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/CourseRegProcess"},"type":"array"},"id":"schema_385"},"schema_386":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/CourseRegistration"},"type":"array"},"id":"schema_386"},"schema_387":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/CourseType"},"type":"array"},"id":"schema_387"},"schema_388":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Course"},"type":"array"},"id":"schema_388"},"schema_389":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/CreditType"},"type":"array"},"id":"schema_389"},"schema_390":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Credit"},"type":"array"},"id":"schema_390"},"schema_391":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Directory"},"type":"array"},"id":"schema_391"},"schema_392":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ExamNotice"},"type":"array"},"id":"schema_392"},"schema_393":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ExamRegProcess"},"type":"array"},"id":"schema_393"},"schema_394":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ExamRegistration"},"type":"array"},"id":"schema_394"},"schema_395":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Exam"},"type":"array"},"id":"schema_395"},"schema_396":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ExpirationRuleSet"},"type":"array"},"id":"schema_396"},"schema_397":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Fee"},"type":"array"},"id":"schema_397"},"schema_398":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Instructor"},"type":"array"},"id":"schema_398"},"schema_399":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/LicenseType"},"type":"array"},"id":"schema_399"},"schema_400":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Notice"},"type":"array"},"id":"schema_400"},"schema_401":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ProgramGroup"},"type":"array"},"id":"schema_401"},"schema_402":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Program"},"type":"array"},"id":"schema_402"},"schema_403":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ProjectType"},"type":"array"},"id":"schema_403"},"schema_404":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/RecurringBillingRun"},"type":"array"},"id":"schema_404"},"schema_405":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/StatusReason"},"type":"array"},"id":"schema_405"},"schema_406":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/TestingFacility"},"type":"array"},"id":"schema_406"},"schema_407":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/TrainingLocation"},"type":"array"},"id":"schema_407"},"schema_408":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/TrainingProvider"},"type":"array"},"id":"schema_408"}},"exampleStore":{},"securitySchemeStore":{"knox-authorizer":{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"/_mock/apis/certifications/certifications-v1","isMockServer":true,"description":"Mock server"},{"url":"https://certifications.api.rhythmsoftware.com"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/apis/certifications/certifications-v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/certifications/certifications-v1.json?download"},{"url":"/_bundle/apis/certifications/certifications-v1.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Certifications","description":"The Certifications API provides all the capabilities for managing the certification process beginning with your Certification\nProgram. You can also manage Applications, Courses, or Course Offerings from this API.\n\nLike most of the other Rhythm apps, the Certifications API includes endpoints for Query Definitions. These endpoints are \ncommonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API. \n"}},"baseSlug":"/apis/certifications/certifications-v1","routesMapping":{}}